diff --git a/classes/BannedUser.html b/classes/BannedUser.html index b49d22e1..d75eae60 100644 --- a/classes/BannedUser.html +++ b/classes/BannedUser.html @@ -1,5 +1,5 @@ BannedUser | revolt.js

Class BannedUser

Banned User

-

Constructors

constructor +

Constructors

constructor

Properties

avatar? discriminator id @@ -11,4 +11,4 @@
  • Optionalavatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }

    Description

    Avatar of the banned user

  • discriminator: string

    Description

    Discriminator of the banned user

  • username: string

    Description

    Username of the banned user

    -

    • Returns BannedUser

    Properties

    Optional Readonlyavatar

    avatar?: File

    Readonlydiscriminator

    discriminator: string

    Readonlyid

    id: string

    Readonlyusername

    username: string

    On This Page

    Constructors
    Properties
    +

    Returns BannedUser

    Properties

    Optional Readonlyavatar

    avatar?: File

    Readonlydiscriminator

    discriminator: string

    Readonlyid

    id: string

    Readonlyusername

    username: string

    On This Page

    Constructors
    Properties
    diff --git a/classes/Bot.html b/classes/Bot.html index 3a73de39..13736cf2 100644 --- a/classes/Bot.html +++ b/classes/Bot.html @@ -1,5 +1,5 @@ Bot | revolt.js

    Class Bot

    Bot Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists analytics @@ -20,21 +20,21 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    analytics

    • get analytics(): boolean

      Whether this bot has analytics enabled

      -

      Returns boolean

    createdAt

    • get createdAt(): Date

      Time when this user created their account

      -

      Returns Date

    discoverable

    • get discoverable(): boolean

      Whether this bot shows up on Discover

      -

      Returns boolean

    flags

    interactionsUrl

    • get interactionsUrl(): undefined | string

      Interactions URL

      -

      Returns undefined | string

    owner

    ownerId

    privacyPolicyUrl

    • get privacyPolicyUrl(): undefined | string

      Link to privacy policy

      -

      Returns undefined | string

    public

    • get public(): boolean

      Whether this bot can be invited by anyone

      -

      Returns boolean

    termsOfServiceUrl

    • get termsOfServiceUrl(): undefined | string

      Link to terms of service

      -

      Returns undefined | string

    token

    user

    Methods

    delete

    edit

    • edit(
          data: {
              analytics?: null | boolean;
              interactions_url?: null | string;
              name?: null | string;
              public?: null | boolean;
              remove?: ("Token" | "InteractionsURL")[];
          },
      ): Promise<void>

      Edit a bot

      +

    Returns Bot

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    analytics

    • get analytics(): boolean

      Whether this bot has analytics enabled

      +

      Returns boolean

    createdAt

    • get createdAt(): Date

      Time when this user created their account

      +

      Returns Date

    discoverable

    • get discoverable(): boolean

      Whether this bot shows up on Discover

      +

      Returns boolean

    flags

    interactionsUrl

    • get interactionsUrl(): undefined | string

      Interactions URL

      +

      Returns undefined | string

    owner

    ownerId

    privacyPolicyUrl

    • get privacyPolicyUrl(): undefined | string

      Link to privacy policy

      +

      Returns undefined | string

    public

    • get public(): boolean

      Whether this bot can be invited by anyone

      +

      Returns boolean

    termsOfServiceUrl

    • get termsOfServiceUrl(): undefined | string

      Link to terms of service

      +

      Returns undefined | string

    token

    user

    Methods

    delete

    edit

    • edit(
          data: {
              analytics?: null | boolean;
              interactions_url?: null | string;
              name?: null | string;
              public?: null | boolean;
              remove?: ("Token" | "InteractionsURL")[];
          },
      ): Promise<void>

      Edit a bot

      Parameters

      • data: {
            analytics?: null | boolean;
            interactions_url?: null | string;
            name?: null | string;
            public?: null | boolean;
            remove?: ("Token" | "InteractionsURL")[];
        }

        Changes

        • Optionalanalytics?: null | boolean

          Description

          Whether analytics should be gathered for this bot

          Must be enabled in order to show up on Revolt Discover.

          @@ -45,6 +45,6 @@

          Default

          []
          -

      Returns Promise<void>

    toString

    • toString(): string

      Convert to string

      +

    Returns Promise<void>

    toString

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/BotCollection.html b/classes/BotCollection.html index a5755ff3..86679fe7 100644 --- a/classes/BotCollection.html +++ b/classes/BotCollection.html @@ -1,5 +1,5 @@ BotCollection | revolt.js

    Class BotCollection

    Collection of Bots

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -24,38 +24,38 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedBot

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedBot>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Bot,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns BotCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedBot

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedBot>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Bot,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: Bot

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    createBot

    • createBot(name: string): Promise<Bot>

      Create a bot

      +

    Returns void

    createBot

    delete

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    fetchOwned

    fetchOwned

    fetchPublic

    fetchPublic

    filter

    filter

    find

    Returns Bot[]

    find

    forEach

    Returns undefined | Bot

    forEach

    get

    get

    getOrCreate

    getOrCreate

    has

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Channel.html b/classes/Channel.html index b39d4f47..6c39588e 100644 --- a/classes/Channel.html +++ b/classes/Channel.html @@ -1,5 +1,5 @@ Channel | revolt.js

    Class Channel

    Channel Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists active @@ -61,63 +61,63 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    active

    animatedIconURL

    • get animatedIconURL(): undefined | string

      URL to the animated channel icon

      -

      Returns undefined | string

    createdAt

    defaultPermissions

    • get defaultPermissions(): undefined | { a: number; d: number }

      Default permissions for this server channel

      -

      Returns undefined | { a: number; d: number }

    description

    displayName

    icon

    iconURL

    lastMessage

    lastMessageAt

    • get lastMessageAt(): undefined | Date

      Time when the last message was sent

      -

      Returns undefined | Date

    lastMessageId

    • get lastMessageId(): undefined | string

      ID of the last message sent in this channel

      -

      Returns undefined | string

    mature

    mentions

    • get mentions(): undefined | ReactiveSet<string>

      Get mentions in this channel for user.

      -

      Returns undefined | ReactiveSet<string>

    name

    owner

    ownerId

    path

    permission

    • get permission(): number

      Permission the currently authenticated user has against this channel

      -

      Returns number

    permissions

    • get permissions(): undefined | number

      Permissions allowed for users in this group

      -

      Returns undefined | number

    potentiallyRestrictedChannel

    • get potentiallyRestrictedChannel(): undefined | string | boolean

      Whether this channel may be hidden to some users

      -

      Returns undefined | string | boolean

    recipient

    recipientIds

    • get recipientIds(): ReactiveSet<string>

      User ids of recipients of the group

      -

      Returns ReactiveSet<string>

    recipients

    rolePermissions

    • get rolePermissions(): undefined | Record<string, { a: number; d: number }>

      Role permissions for this server channel

      -

      Returns undefined | Record<string, { a: number; d: number }>

    server

    serverId

    type

    • get type(): | "SavedMessages"
      | "DirectMessage"
      | "Group"
      | "TextChannel"
      | "VoiceChannel"

      Channel type

      -

      Returns "SavedMessages" | "DirectMessage" | "Group" | "TextChannel" | "VoiceChannel"

    typing

    typingIds

    • get typingIds(): ReactiveSet<string>

      User ids of people currently typing in channel

      -

      Returns ReactiveSet<string>

    unread

    updatedAt

    • get updatedAt(): Date

      Time when the channel was last updated (either created or a message was sent)

      -

      Returns Date

    url

    user

    userId

    Methods

    ack

    • ack(
          message?: string | Message,
          skipRateLimiter?: boolean,
          skipRequest?: boolean,
          skipNextMarking?: boolean,
      ): Promise<void>

      Mark a channel as read

      +

    Returns Channel

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    active

    animatedIconURL

    • get animatedIconURL(): undefined | string

      URL to the animated channel icon

      +

      Returns undefined | string

    createdAt

    defaultPermissions

    • get defaultPermissions(): undefined | { a: number; d: number }

      Default permissions for this server channel

      +

      Returns undefined | { a: number; d: number }

    description

    displayName

    icon

    iconURL

    lastMessage

    lastMessageAt

    • get lastMessageAt(): undefined | Date

      Time when the last message was sent

      +

      Returns undefined | Date

    lastMessageId

    • get lastMessageId(): undefined | string

      ID of the last message sent in this channel

      +

      Returns undefined | string

    mature

    mentions

    • get mentions(): undefined | ReactiveSet<string>

      Get mentions in this channel for user.

      +

      Returns undefined | ReactiveSet<string>

    name

    owner

    ownerId

    path

    permission

    • get permission(): number

      Permission the currently authenticated user has against this channel

      +

      Returns number

    permissions

    • get permissions(): undefined | number

      Permissions allowed for users in this group

      +

      Returns undefined | number

    potentiallyRestrictedChannel

    • get potentiallyRestrictedChannel(): undefined | string | boolean

      Whether this channel may be hidden to some users

      +

      Returns undefined | string | boolean

    recipient

    recipientIds

    • get recipientIds(): ReactiveSet<string>

      User ids of recipients of the group

      +

      Returns ReactiveSet<string>

    recipients

    rolePermissions

    • get rolePermissions(): undefined | Record<string, { a: number; d: number }>

      Role permissions for this server channel

      +

      Returns undefined | Record<string, { a: number; d: number }>

    server

    serverId

    type

    • get type(): | "SavedMessages"
      | "DirectMessage"
      | "Group"
      | "TextChannel"
      | "VoiceChannel"

      Channel type

      +

      Returns "SavedMessages" | "DirectMessage" | "Group" | "TextChannel" | "VoiceChannel"

    typing

    typingIds

    • get typingIds(): ReactiveSet<string>

      User ids of people currently typing in channel

      +

      Returns ReactiveSet<string>

    unread

    updatedAt

    • get updatedAt(): Date

      Time when the channel was last updated (either created or a message was sent)

      +

      Returns Date

    url

    user

    userId

    Methods

    ack

    • ack(
          message?: string | Message,
          skipRateLimiter?: boolean,
          skipRequest?: boolean,
          skipNextMarking?: boolean,
      ): Promise<void>

      Mark a channel as read

      Parameters

      • Optionalmessage: string | Message

        Last read message or its ID

      • OptionalskipRateLimiter: boolean

        Whether to skip the internal rate limiter

      • OptionalskipRequest: boolean

        For internal updates only

      • OptionalskipNextMarking: boolean

        For internal usage only

      Returns Promise<void>

      Requires

      SavedMessages, DirectMessage, Group, TextChannel

      -

    addMember

    addMember

    createInvite

    createInvite

    createWebhook

    createWebhook

    delete

    delete

    deleteMessages

    deleteMessages

    edit

    edit

    fetchMembers

    Returns Promise<void>

    fetchMembers

    fetchMessage

    fetchMessage

    fetchMessages

    fetchMessages

    fetchMessagesWithUsers

    fetchMessagesWithUsers

    fetchWebhooks

    fetchWebhooks

    havePermission

    havePermission

    orPermission

    orPermission

    removeMember

    removeMember

    search

    search

    searchWithUsers

    searchWithUsers

    sendMessage

    sendMessage

    setPermissions

    setPermissions

    Returns Promise<
        | { _id: string; channel_type: "SavedMessages"; user: string }
        | {
            _id: string;
            active: boolean;
            channel_type: "DirectMessage";
            last_message_id?: null | string;
            recipients: string[];
        }
        | {
            _id: string;
            channel_type: "Group";
            description?: null
            | string;
            icon?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
            last_message_id?: null
            | string;
            name: string;
            nsfw?: boolean;
            owner: string;
            permissions?: null | number;
            recipients: string[];
        }
        | {
            _id: string;
            channel_type: "TextChannel";
            default_permissions?: null
            | { a: number; d: number };
            description?: null | string;
            icon?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
            last_message_id?: null
            | string;
            name: string;
            nsfw?: boolean;
            role_permissions?: { [key: string]: { a: number; d: number } };
            server: string;
        }
        | {
            _id: string;
            channel_type: "VoiceChannel";
            default_permissions?: null
            | { a: number; d: number };
            description?: null | string;
            icon?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
            name: string;
            nsfw?: boolean;
            role_permissions?: { [key: string]: { a: number; d: number } };
            server: string;
        },
    >

    Requires

    Group, TextChannel, VoiceChannel

    -

    startTyping

    startTyping

    stopTyping

    stopTyping

    toString

    toString

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ChannelCollection.html b/classes/ChannelCollection.html index 9570ef10..38c26f3c 100644 --- a/classes/ChannelCollection.html +++ b/classes/ChannelCollection.html @@ -1,5 +1,5 @@ ChannelCollection | revolt.js

    Class ChannelCollection

    Collection of Channels

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -23,34 +23,34 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedChannel

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannel>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Channel,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns ChannelCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedChannel

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannel>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Channel,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: Channel

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    createGroup

    • createGroup(name: string, users: (string | User)[]): Promise<Channel>

      Create a group

      +

    Returns void

    createGroup

    delete

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns Channel[]

    find

    forEach

    Returns undefined | Channel

    forEach

    get

    get

    getOrCreate

    getOrCreate

    getOrPartial

    Returns Channel

    getOrPartial

    has

    Returns undefined | Channel

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ChannelEditSystemMessage.html b/classes/ChannelEditSystemMessage.html index aa8cbaee..59a12b1f 100644 --- a/classes/ChannelEditSystemMessage.html +++ b/classes/ChannelEditSystemMessage.html @@ -1,5 +1,5 @@ ChannelEditSystemMessage | revolt.js

    Class ChannelEditSystemMessage

    Channel Edit System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    byId client? type @@ -8,8 +8,8 @@

    Constructors

    constructor

    • new ChannelEditSystemMessage(
          client: Client,
          systemMessage: (
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" }
          ) & {
              type:
                  | "channel_renamed"
                  | "channel_description_changed"
                  | "channel_icon_changed";
          },
      ): ChannelEditSystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • systemMessage: (
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }
        ) & {
            type:
                | "channel_renamed"
                | "channel_description_changed"
                | "channel_icon_changed";
        }

        System Message

        -

      Returns ChannelEditSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    by

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns ChannelEditSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    by

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ChannelInvite.html b/classes/ChannelInvite.html index bc3ab165..30e8142b 100644 --- a/classes/ChannelInvite.html +++ b/classes/ChannelInvite.html @@ -1,12 +1,12 @@ ChannelInvite | revolt.js

    Class ChannelInviteAbstract

    Channel Invite

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type

    Methods

    from

    Constructors

    constructor

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  _id: string;
                  channel: string;
                  creator: string;
                  server: string;
                  type: "Server";
              }
              | { _id: string; channel: string; creator: string; type: "Group" },
      ): ChannelInvite

      Create an Invite from an API Invite

      +

    Returns ChannelInvite

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  _id: string;
                  channel: string;
                  creator: string;
                  server: string;
                  type: "Server";
              }
              | { _id: string; channel: string; creator: string; type: "Group" },
      ): ChannelInvite

      Create an Invite from an API Invite

      Parameters

      • client: Client

        Client

      • invite:
            | {
                _id: string;
                channel: string;
                creator: string;
                server: string;
                type: "Server";
            }
            | { _id: string; channel: string; creator: string; type: "Group" }

        Data

        • {
              _id: string;
              channel: string;
              creator: string;
              server: string;
              type: "Server";
          }
          • _id: string

            Description

            Invite code

            @@ -17,4 +17,4 @@
          • channel: string

            Description

            Id of the group channel this invite points to

          • creator: string

            Description

            Id of user who created this invite

          • type: "Group"

      Returns ChannelInvite

      Invite

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ChannelOwnershipChangeSystemMessage.html b/classes/ChannelOwnershipChangeSystemMessage.html index 560cbe7b..bc3143ba 100644 --- a/classes/ChannelOwnershipChangeSystemMessage.html +++ b/classes/ChannelOwnershipChangeSystemMessage.html @@ -1,5 +1,5 @@ ChannelOwnershipChangeSystemMessage | revolt.js

    Class ChannelOwnershipChangeSystemMessage

    Channel Ownership Change System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? fromId toId @@ -10,9 +10,9 @@

    Constructors

    constructor

    • new ChannelOwnershipChangeSystemMessage(
          client: Client,
          systemMessage: (
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" }
          ) & { type: "channel_ownership_changed" },
      ): ChannelOwnershipChangeSystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • systemMessage: (
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }
        ) & { type: "channel_ownership_changed" }

        System Message

        -

      Returns ChannelOwnershipChangeSystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    ReadonlyfromId

    fromId: string

    ReadonlytoId

    toId: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    from

    to

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns ChannelOwnershipChangeSystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    ReadonlyfromId

    fromId: string

    ReadonlytoId

    toId: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    from

    to

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ChannelRenamedSystemMessage.html b/classes/ChannelRenamedSystemMessage.html index bf27cc1d..1ed7ced6 100644 --- a/classes/ChannelRenamedSystemMessage.html +++ b/classes/ChannelRenamedSystemMessage.html @@ -1,5 +1,5 @@ ChannelRenamedSystemMessage | revolt.js

    Class ChannelRenamedSystemMessage

    Channel Renamed System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    byId client? name @@ -9,8 +9,8 @@

    Constructors

    constructor

    • new ChannelRenamedSystemMessage(
          client: Client,
          systemMessage: (
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" }
          ) & { type: "channel_renamed" },
      ): ChannelRenamedSystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • systemMessage: (
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }
        ) & { type: "channel_renamed" }

        System Message

        -

      Returns ChannelRenamedSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    Readonlyname

    name: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    by

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns ChannelRenamedSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    Readonlyname

    name: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    by

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ChannelUnread.html b/classes/ChannelUnread.html index cac23f6d..3a971265 100644 --- a/classes/ChannelUnread.html +++ b/classes/ChannelUnread.html @@ -1,5 +1,5 @@ ChannelUnread | revolt.js

    Class ChannelUnread

    Channel Unread Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists lastMessageId @@ -7,7 +7,7 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    lastMessageId

    messageMentionIds

    • get messageMentionIds(): ReactiveSet<string>

      List of message IDs that we were mentioned in

      -

      Returns ReactiveSet<string>

    On This Page

    Constructors
    Properties
    Accessors
    +

    Returns ChannelUnread

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    lastMessageId

    messageMentionIds

    • get messageMentionIds(): ReactiveSet<string>

      List of message IDs that we were mentioned in

      +

      Returns ReactiveSet<string>

    On This Page

    Constructors
    Properties
    Accessors
    diff --git a/classes/ChannelUnreadCollection.html b/classes/ChannelUnreadCollection.html index a7a4f03c..42fa11e1 100644 --- a/classes/ChannelUnreadCollection.html +++ b/classes/ChannelUnreadCollection.html @@ -1,5 +1,5 @@ ChannelUnreadCollection | revolt.js

    Class ChannelUnreadCollection

    Collection of Channel Unreads

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -22,27 +22,27 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedChannelUnread

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelUnread>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: ChannelUnread,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns ChannelUnreadCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedChannelUnread

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelUnread>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: ChannelUnread,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: ChannelUnread

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    filter

    filter

    find

    Returns ChannelUnread[]

    find

    forEach

    Returns undefined | ChannelUnread

    forEach

    get

    get

    getOrCreate

    getOrCreate

    Returns ChannelUnread

    has

    Returns ChannelUnread

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    reset

    size

    Returns O[]

    reset

    size

    sync

    toList

    sync

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ChannelWebhook.html b/classes/ChannelWebhook.html index 08714395..e97e00e0 100644 --- a/classes/ChannelWebhook.html +++ b/classes/ChannelWebhook.html @@ -1,5 +1,5 @@ ChannelWebhook | revolt.js

    Class ChannelWebhook

    Channel Webhook Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists avatar @@ -13,15 +13,15 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    avatar

    avatarURL

    channel

    channelId

    name

    token

    Methods

    delete

    edit

    • edit(
          data: {
              avatar?: null | string;
              name?: null | string;
              permissions?: null | number;
              remove?: "Avatar"[];
          },
      ): Promise<void>

      Edit this webhook

      +

    Returns ChannelWebhook

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    avatar

    avatarURL

    channel

    channelId

    name

    token

    Methods

    delete

    edit

    • edit(
          data: {
              avatar?: null | string;
              name?: null | string;
              permissions?: null | number;
              remove?: "Avatar"[];
          },
      ): Promise<void>

      Edit this webhook

      Parameters

      • data: {
            avatar?: null | string;
            name?: null | string;
            permissions?: null | number;
            remove?: "Avatar"[];
        }
        • Optionalavatar?: null | string

          Description

          Avatar ID

        • Optionalname?: null | string

          Description

          Webhook name

        • Optionalpermissions?: null | number

          Format: uint64

          @@ -30,4 +30,4 @@

          Default

          []
          -

    Returns Promise<void>

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Promise<void>

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ChannelWebhookCollection.html b/classes/ChannelWebhookCollection.html index 3c4a2059..09bee752 100644 --- a/classes/ChannelWebhookCollection.html +++ b/classes/ChannelWebhookCollection.html @@ -1,5 +1,5 @@ ChannelWebhookCollection | revolt.js

    Class ChannelWebhookCollection

    Collection of Channel Webhooks

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -22,34 +22,34 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedChannelWebhook

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelWebhook>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: ChannelWebhook,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns ChannelWebhookCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedChannelWebhook

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelWebhook>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: ChannelWebhook,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: ChannelWebhook

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns ChannelWebhook[]

    find

    forEach

    Returns undefined | ChannelWebhook

    forEach

    fromToken

    fromToken

    get

    get

    getOrCreate

    getOrCreate

    has

    Returns ChannelWebhook

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ClassCollection.html b/classes/ClassCollection.html index 42ae5a31..1e14bc61 100644 --- a/classes/ClassCollection.html +++ b/classes/ClassCollection.html @@ -1,5 +1,5 @@ ClassCollection | revolt.js

    Class ClassCollection<T, V>

    Generic class collection backed by store

    -

    Type Parameters

    • T
    • V

    Hierarchy (View Summary)

    Constructors

    constructor +

    Type Parameters

    • T
    • V

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -19,40 +19,40 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => V

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, V>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: T,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns ClassCollection<T, V>

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => V

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, V>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: T,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: T

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    filter

    filter

    find

    Returns T[]

    find

    forEach

    Returns undefined | T

    forEach

    get

    get

    has

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Client.html b/classes/Client.html index e87aec12..1c4aee2e 100644 --- a/classes/Client.html +++ b/classes/Client.html @@ -1,5 +1,5 @@ Client | revolt.js

    Class Client

    Revolt.js Clients

    -

    Hierarchy

    • AsyncEventEmitter<Events>
      • Client

    Constructors

    constructor +

    Hierarchy

    • AsyncEventEmitter<Events>
      • Client

    Constructors

    constructor

    Properties

    [brandSymbol] account api @@ -74,8 +74,8 @@
  • revolt: string

    Description

    Revolt API Version

  • vapid: string

    Description

    Web Push VAPID public key

  • ws: string

    Description

    WebSocket URL

    -

    • Returns Client

    Properties

    Protected Readonly[brandSymbol]

    "[brandSymbol]": Events

    This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

    -

    Readonlyaccount

    account: AccountCollection

    Readonlyapi

    api: API.API

    Readonlybots

    bots: BotCollection

    Readonlychannels

    channels: ChannelCollection

    ReadonlychannelUnreads

    channelUnreads: ChannelUnreadCollection

    ReadonlychannelWebhooks

    channelWebhooks: ChannelWebhookCollection

    configuration

    configuration:
        | undefined
        | {
            app: string;
            build: {
                commit_sha: string;
                commit_timestamp: string;
                origin_url: string;
                semver: string;
                timestamp: string;
            };
            features: {
                autumn: { enabled: boolean; url: string };
                captcha: { enabled: boolean; key: string };
                email: boolean;
                invite_only: boolean;
                january: { enabled: boolean; url: string };
                voso: { enabled: boolean; url: string; ws: string };
            };
            revolt: string;
            vapid: string;
            ws: string;
        }

    Type declaration

    • undefined
    • {
          app: string;
          build: {
              commit_sha: string;
              commit_timestamp: string;
              origin_url: string;
              semver: string;
              timestamp: string;
          };
          features: {
              autumn: { enabled: boolean; url: string };
              captcha: { enabled: boolean; key: string };
              email: boolean;
              invite_only: boolean;
              january: { enabled: boolean; url: string };
              voso: { enabled: boolean; url: string; ws: string };
          };
          revolt: string;
          vapid: string;
          ws: string;
      }
      • app: string

        Description

        URL pointing to the client serving this node

        +

    Returns Client

    Properties

    Protected Readonly[brandSymbol]

    "[brandSymbol]": Events

    This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

    +

    Readonlyaccount

    account: AccountCollection

    Readonlyapi

    api: API.API

    Readonlybots

    bots: BotCollection

    Readonlychannels

    channels: ChannelCollection

    ReadonlychannelUnreads

    channelUnreads: ChannelUnreadCollection

    ReadonlychannelWebhooks

    channelWebhooks: ChannelWebhookCollection

    configuration

    configuration:
        | undefined
        | {
            app: string;
            build: {
                commit_sha: string;
                commit_timestamp: string;
                origin_url: string;
                semver: string;
                timestamp: string;
            };
            features: {
                autumn: { enabled: boolean; url: string };
                captcha: { enabled: boolean; key: string };
                email: boolean;
                invite_only: boolean;
                january: { enabled: boolean; url: string };
                voso: { enabled: boolean; url: string; ws: string };
            };
            revolt: string;
            vapid: string;
            ws: string;
        }

    Type declaration

    • undefined
    • {
          app: string;
          build: {
              commit_sha: string;
              commit_timestamp: string;
              origin_url: string;
              semver: string;
              timestamp: string;
          };
          features: {
              autumn: { enabled: boolean; url: string };
              captcha: { enabled: boolean; key: string };
              email: boolean;
              invite_only: boolean;
              january: { enabled: boolean; url: string };
              voso: { enabled: boolean; url: string; ws: string };
          };
          revolt: string;
          vapid: string;
          ws: string;
      }
      • app: string

        Description

        URL pointing to the client serving this node

      • build: {
            commit_sha: string;
            commit_timestamp: string;
            origin_url: string;
            semver: string;
            timestamp: string;
        }

        Description

        Build information

        • commit_sha: string

          Description

          Commit Hash

        • commit_timestamp: string

          Description

          Commit Timestamp

          @@ -101,10 +101,10 @@
    • revolt: string

      Description

      Revolt API Version

    • vapid: string

      Description

      Web Push VAPID public key

    • ws: string

      Description

      WebSocket URL

      -

    ReadonlyconnectionFailureCount

    connectionFailureCount: Accessor<number>

    Readonlyemojis

    emojis: EmojiCollection

    Readonlyevents

    events: EventClient<1>

    Readonlymessages

    messages: MessageCollection

    Readonlyoptions

    options: ClientOptions

    Readonlyready

    ready: Accessor<boolean>

    ReadonlyserverMembers

    serverMembers: ServerMemberCollection

    Readonlyservers

    servers: ServerCollection

    Readonlysessions

    sessions: SessionCollection

    user

    user: undefined | User

    Readonlyusers

    users: UserCollection

    Accessors

    authenticationHeader

    • get authenticationHeader(): [string, string]

      Get authentication header

      -

      Returns [string, string]

    sessionId

    • get sessionId(): undefined | string

      Current session id

      -

      Returns undefined | string

    Methods

    addListener

    • addListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • addListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    connect

    emit

    • emit<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>

      Returns boolean

    • emit<K extends string | symbol>(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>

      Returns boolean

    eventNames

    • eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events
      )[]

      Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events
      )[]

    getMaxListeners

    • getMaxListeners(): number

      Returns number

    listenerCount

    • listenerCount<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
      ): number

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K

      Returns number

    • listenerCount(eventName: string | symbol): number

      Parameters

      • eventName: string | symbol

      Returns number

    listeners

    • listeners<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

    • listeners<K extends string | symbol>(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

    login

    • login(
          details:
              | { email: string; friendly_name?: null
              | string; password: string }
              | {
                  friendly_name?: null | string;
                  mfa_response?:
                      | null
                      | { password: string }
                      | { recovery_code: string }
                      | { totp_code: string };
                  mfa_ticket: string;
              },
      ): Promise<void>

      Log in with auth data, creating a new session in the process.

      +

    ReadonlyconnectionFailureCount

    connectionFailureCount: Accessor<number>

    Readonlyemojis

    emojis: EmojiCollection

    Readonlyevents

    events: EventClient<1>

    Readonlymessages

    messages: MessageCollection

    Readonlyoptions

    options: ClientOptions

    Readonlyready

    ready: Accessor<boolean>

    ReadonlyserverMembers

    serverMembers: ServerMemberCollection

    Readonlyservers

    servers: ServerCollection

    Readonlysessions

    sessions: SessionCollection

    user

    user: undefined | User

    Readonlyusers

    users: UserCollection

    Accessors

    authenticationHeader

    • get authenticationHeader(): [string, string]

      Get authentication header

      +

      Returns [string, string]

    sessionId

    • get sessionId(): undefined | string

      Current session id

      +

      Returns undefined | string

    Methods

    addListener

    • addListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • addListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    connect

    emit

    • emit<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>

      Returns boolean

    • emit<K extends string | symbol>(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<AsyncEventEmitter<Events>, K>

      Returns boolean

    eventNames

    • eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events
      )[]

      Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events
      )[]

    getMaxListeners

    • getMaxListeners(): number

      Returns number

    listenerCount

    • listenerCount<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
      ): number

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K

      Returns number

    • listenerCount(eventName: string | symbol): number

      Parameters

      • eventName: string | symbol

      Returns number

    listeners

    • listeners<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

    • listeners<K extends string | symbol>(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events>,
              K,
              Events,
          >["listener"],
          undefined,
      >[]

    login

    • login(
          details:
              | { email: string; friendly_name?: null
              | string; password: string }
              | {
                  friendly_name?: null | string;
                  mfa_response?:
                      | null
                      | { password: string }
                      | { recovery_code: string }
                      | { totp_code: string };
                  mfa_ticket: string;
              },
      ): Promise<void>

      Log in with auth data, creating a new session in the process.

      Parameters

      • details:
            | { email: string; friendly_name?: null
            | string; password: string }
            | {
                friendly_name?: null | string;
                mfa_response?:
                    | null
                    | { password: string }
                    | { recovery_code: string }
                    | { totp_code: string };
                mfa_ticket: string;
            }

        Login data object

        • { email: string; friendly_name?: null | string; password: string }
          • email: string

            Description

            Email

          • Optionalfriendly_name?: null | string

            Description

            Friendly name used for the session

            @@ -115,17 +115,17 @@
          • mfa_ticket: string

            Description

            Unvalidated or authorised MFA ticket

            Used to resolve the correct account

      Returns Promise<void>

      An on-boarding function if on-boarding is required, undefined otherwise

      -

    loginBot

    loginBot

    • loginBot(token: string): Promise<void>

      Log in as a bot

      Parameters

      • token: string

        Bot token

        -

      Returns Promise<void>

    markdownToText

    • markdownToText(source: string): string

      Prepare a markdown-based message to be displayed to the user as plain text.

      +

    Returns Promise<void>

    markdownToText

    • markdownToText(source: string): string

      Prepare a markdown-based message to be displayed to the user as plain text.

      Parameters

      • source: string

        Source markdown text

      Returns string

      Modified plain text

      -

    off

    • off<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • off<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    on

    • on<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • on<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    once

    • once<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • once<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    prependListener

    • prependListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • prependListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    prependOnceListener

    • prependOnceListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • prependOnceListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    proxyFile

    • proxyFile(url: string): undefined | string

      Proxy a file through January.

      +

    off

    • off<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • off<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    on

    • on<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • on<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    once

    • once<K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • once<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    prependListener

    • prependListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • prependListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    prependOnceListener

    • prependOnceListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • prependOnceListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    proxyFile

    • proxyFile(url: string): undefined | string

      Proxy a file through January.

      Parameters

      • url: string

        URL to proxy

      Returns undefined | string

      Proxied media URL

      -

    rawListeners

    • rawListeners<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

    • rawListeners<K extends string | symbol>(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

    removeAllListeners

    • removeAllListeners<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          event: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • event: K

      Returns this

    • removeAllListeners<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          event?: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • Optionalevent: K

      Returns this

    • removeAllListeners(event: string | symbol): this

      Parameters

      • event: string | symbol

      Returns this

    • removeAllListeners(event?: string | symbol): this

      Parameters

      • Optionalevent: string | symbol

      Returns this

    removeListener

    • removeListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • removeListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    setMaxListeners

    • setMaxListeners(n: number): this

      Parameters

      • n: number

      Returns this

    uploadFile

    • uploadFile(tag: string, file: File, uploadUrl?: string): Promise<string>

      Upload a file

      +

    rawListeners

    • rawListeners<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

    • rawListeners<K extends string | symbol>(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events>,
          K,
          Events,
      >[]

    removeAllListeners

    • removeAllListeners<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          event: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • event: K

      Returns this

    • removeAllListeners<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          event?: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • Optionalevent: K

      Returns this

    • removeAllListeners(event: string | symbol): this

      Parameters

      • event: string | symbol

      Returns this

    • removeAllListeners(event?: string | symbol): this

      Parameters

      • Optionalevent: string | symbol

      Returns this

    removeListener

    • removeListener<
          K extends (keyof AsyncEventEmitterPredefinedEvents)
          | (keyof Events),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    • removeListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events>,
                  K,
                  Events,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events>,
                K,
                Events,
            >["listener"],
            undefined,
        >

      Returns this

    setMaxListeners

    • setMaxListeners(n: number): this

      Parameters

      • n: number

      Returns this

    uploadFile

    • uploadFile(tag: string, file: File, uploadUrl?: string): Promise<string>

      Upload a file

      Parameters

      • tag: string

        Tag

      • file: File

        File

      • OptionaluploadUrl: string

        Media server upload route

        -

      Returns Promise<string>

    useExistingSession

    waitForAllListenersToComplete

    • waitForAllListenersToComplete(): Promise<boolean>

      Returns Promise<boolean>

    StaticlistenerCount

    • listenerCount<
          EventMap extends {},
          EventName extends
              PropertyKey =
              | (keyof AsyncEventEmitterPredefinedEvents)
              | keyof EventMap,
      >(
          emitter: AsyncEventEmitter<EventMap>,
          eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName,
      ): number

      Type Parameters

      • EventMap extends {}
      • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

      Parameters

      • emitter: AsyncEventEmitter<EventMap>
      • eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName

      Returns number

    • listenerCount(
          emitter: AsyncEventEmitter<any>,
          eventName: string | symbol,
      ): number

      Parameters

      • emitter: AsyncEventEmitter<any>
      • eventName: string | symbol

      Returns number

    Staticon

    • on<
          EventMap extends {},
          EventName extends
              PropertyKey =
              | (keyof AsyncEventEmitterPredefinedEvents)
              | keyof EventMap,
      >(
          emitter: AsyncEventEmitter<EventMap>,
          eventName: EventName,
          options?: AbortableMethods,
      ): AsyncGenerator<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
          void,
      >

      Type Parameters

      • EventMap extends {}
      • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

      Parameters

      • emitter: AsyncEventEmitter<EventMap>
      • eventName: EventName
      • Optionaloptions: AbortableMethods

      Returns AsyncGenerator<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
          void,
      >

    • on(
          emitter: AsyncEventEmitter<any>,
          eventName: string | symbol,
          options?: AbortableMethods,
      ): AsyncGenerator<any[], void>

      Parameters

      • emitter: AsyncEventEmitter<any>
      • eventName: string | symbol
      • Optionaloptions: AbortableMethods

      Returns AsyncGenerator<any[], void>

    Staticonce

    • once<
          EventMap extends {},
          EventName extends
              PropertyKey =
              | (keyof AsyncEventEmitterPredefinedEvents)
              | keyof EventMap,
      >(
          emitter: AsyncEventEmitter<EventMap>,
          eventName: EventName,
          options?: AbortableMethods,
      ): Promise<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
      >

      Type Parameters

      • EventMap extends {}
      • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

      Parameters

      • emitter: AsyncEventEmitter<EventMap>
      • eventName: EventName
      • Optionaloptions: AbortableMethods

      Returns Promise<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
      >

    • once(
          emitter: AsyncEventEmitter<any>,
          eventName: string | symbol,
          options?: AbortableMethods,
      ): Promise<any[]>

      Parameters

      • emitter: AsyncEventEmitter<any>
      • eventName: string | symbol
      • Optionaloptions: AbortableMethods

      Returns Promise<any[]>

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Promise<string>

    useExistingSession

    waitForAllListenersToComplete

    StaticlistenerCount

    Staticon

    Staticonce

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/Collection.html b/classes/Collection.html index d4393873..8a365543 100644 --- a/classes/Collection.html +++ b/classes/Collection.html @@ -1,5 +1,5 @@ Collection | revolt.js

    Class Collection<T>Abstract

    Abstract Collection type

    -

    Type Parameters

    • T

    Hierarchy (View Summary)

    Constructors

    constructor +

    Type Parameters

    • T

    Hierarchy (View Summary)

    Constructors

    constructor

    Methods

    delete entries filter @@ -14,28 +14,28 @@ values

    Constructors

    constructor

    Methods

    Abstractdelete

    Abstractentries

    • entries(): IterableIterator<[string, T]>

      Iterable of key, value pairs in the map

      +

    Returns void

    Abstractentries

    filter

    filter

    find

    Returns T[]

    find

    AbstractforEach

    Returns undefined | T

    AbstractforEach

    Abstractget

    Returns void

    Abstractget

    Abstracthas

    Abstracthas

    Abstractkeys

    Abstractkeys

    map

    map

    Abstractsize

    Returns O[]

    Abstractsize

    toList

    toList

    Abstractvalues

    Abstractvalues

    On This Page

    Constructors
    Methods
    +

    On This Page

    Constructors
    Methods
    diff --git a/classes/Emoji.html b/classes/Emoji.html index 4b99b102..a5e0acf3 100644 --- a/classes/Emoji.html +++ b/classes/Emoji.html @@ -1,5 +1,5 @@ Emoji | revolt.js

    Class Emoji

    Emoji Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists animated @@ -14,15 +14,15 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    animated

    createdAt

    creator

    mature

    name

    parent

    • get parent(): { id: string; type: "Server" } | { type: "Detached" }

      Information about the parent of this emoji

      -

      Returns { id: string; type: "Server" } | { type: "Detached" }

    url

    Methods

    delete

    toString

    • toString(): string

      Convert to string

      +

    Returns Emoji

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    animated

    createdAt

    creator

    mature

    name

    parent

    • get parent(): { id: string; type: "Server" } | { type: "Detached" }

      Information about the parent of this emoji

      +

      Returns { id: string; type: "Server" } | { type: "Detached" }

    url

    Methods

    delete

    toString

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/EmojiCollection.html b/classes/EmojiCollection.html index 6bf56a8c..19c10456 100644 --- a/classes/EmojiCollection.html +++ b/classes/EmojiCollection.html @@ -1,5 +1,5 @@ EmojiCollection | revolt.js

    Class EmojiCollection

    Collection of Emoji

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -22,30 +22,30 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedEmoji

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedEmoji>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Emoji,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns EmojiCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedEmoji

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedEmoji>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Emoji,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: Emoji

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns Emoji[]

    find

    forEach

    Returns undefined | Emoji

    forEach

    get

    get

    getOrCreate

    getOrCreate

    getOrPartial

    Returns Emoji

    getOrPartial

    has

    Returns undefined | Emoji

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/EventClient.html b/classes/EventClient.html index f98f392a..4673c8ca 100644 --- a/classes/EventClient.html +++ b/classes/EventClient.html @@ -1,5 +1,5 @@ EventClient | revolt.js

    Class EventClient<T>

    Simple wrapper around the Revolt websocket service.

    -

    Type Parameters

    • T extends AvailableProtocols

    Hierarchy

    • AsyncEventEmitter<Events<T, EventProtocol<T>>>
      • EventClient

    Constructors

    constructor +

    Type Parameters

    • T extends AvailableProtocols

    Hierarchy

    • AsyncEventEmitter<Events<T, EventProtocol<T>>>
      • EventClient

    Constructors

    constructor

    Properties

    [brandSymbol] options ping @@ -32,14 +32,14 @@

    Type Parameters

    • T extends 1

    Parameters

    • protocolVersion: T

      Target protocol version

    • transportFormat: "json" = "json"

      Communication format

    • Optionaloptions: Partial<EventClientOptions>

      Configuration options

      -

    Returns EventClient<T>

    Properties

    Protected Readonly[brandSymbol]

    "[brandSymbol]": Events

    This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

    -

    Readonlyoptions

    options: EventClientOptions

    Readonlyping

    ping: Accessor<number>

    Readonlystate

    state: Accessor<ConnectionState>

    Accessors

    lastError

    • get lastError(): | undefined
      | { data: any; type: "socket" }
      | {
          data: (
              | { type: "LabelMe" }
              | { type: "AlreadyOnboarded" }
              | { type: "UsernameTaken" }
              | { type: "InvalidUsername" }
              | { type: "DiscriminatorChangeRatelimited" }
              | { type: "UnknownUser" }
              | { type: "AlreadyFriends" }
              | { type: "AlreadySentRequest" }
              | { type: "Blocked" }
              | { type: "BlockedByOther" }
              | { type: "NotFriends" }
              | { max: number; type: "TooManyPendingFriendRequests" }
              | { type: "UnknownChannel" }
              | { type: "UnknownAttachment" }
              | { type: "UnknownMessage" }
              | { type: "CannotEditMessage" }
              | { type: "CannotJoinCall" }
              | { max: number; type: "TooManyAttachments" }
              | { max: number; type: "TooManyEmbeds" }
              | { max: number; type: "TooManyReplies" }
              | { max: number; type: "TooManyChannels" }
              | { type: "EmptyMessage" }
              | { type: "PayloadTooLarge" }
              | { type: "CannotRemoveYourself" }
              | { max: number; type: "GroupTooLarge" }
              | { type: "AlreadyInGroup" }
              | { type: "NotInGroup" }
              | { type: "AlreadyPinned" }
              | { type: "NotPinned" }
              | { type: "UnknownServer" }
              | { type: "InvalidRole" }
              | { type: "Banned" }
              | { max: number; type: "TooManyServers" }
              | { max: number; type: "TooManyEmoji" }
              | { max: number; type: "TooManyRoles" }
              | { type: "AlreadyInServer" }
              | { type: "CannotTimeoutYourself" }
              | { type: "ReachedMaximumBots" }
              | { type: "IsBot" }
              | { type: "IsNotBot" }
              | { type: "BotIsPrivate" }
              | { type: "CannotReportYourself" }
              | { permission: string; type: "MissingPermission" }
              | { permission: string; type: "MissingUserPermission" }
              | { type: "NotElevated" }
              | { type: "NotPrivileged" }
              | { type: "CannotGiveMissingPermissions" }
              | { type: "NotOwner" }
              | { collection: string; operation: string; type: "DatabaseError" }
              | { type: "InternalError" }
              | { type: "InvalidOperation" }
              | { type: "InvalidCredentials" }
              | { type: "InvalidProperty" }
              | { type: "InvalidSession" }
              | { type: "InvalidFlagValue" }
              | { type: "NotAuthenticated" }
              | { type: "DuplicateNonce" }
              | { type: "NotFound" }
              | { type: "NoEffect" }
              | { error: string; type: "FailedValidation" }
              | { type: "ProxyError" }
              | { type: "FileTooSmall" }
              | { max: number; type: "FileTooLarge" }
              | { type: "FileTypeNotAllowed" }
              | { type: "ImageProcessingFailed" }
              | { type: "NoEmbedData" }
              | { type: "VosoUnavailable" }
              | { feature: string; type: "FeatureDisabled" }
          ) & { location: string };
          type: "revolt";
      }

      Last error encountered by events client

      -

      Returns
          | undefined
          | { data: any; type: "socket" }
          | {
              data: (
                  | { type: "LabelMe" }
                  | { type: "AlreadyOnboarded" }
                  | { type: "UsernameTaken" }
                  | { type: "InvalidUsername" }
                  | { type: "DiscriminatorChangeRatelimited" }
                  | { type: "UnknownUser" }
                  | { type: "AlreadyFriends" }
                  | { type: "AlreadySentRequest" }
                  | { type: "Blocked" }
                  | { type: "BlockedByOther" }
                  | { type: "NotFriends" }
                  | { max: number; type: "TooManyPendingFriendRequests" }
                  | { type: "UnknownChannel" }
                  | { type: "UnknownAttachment" }
                  | { type: "UnknownMessage" }
                  | { type: "CannotEditMessage" }
                  | { type: "CannotJoinCall" }
                  | { max: number; type: "TooManyAttachments" }
                  | { max: number; type: "TooManyEmbeds" }
                  | { max: number; type: "TooManyReplies" }
                  | { max: number; type: "TooManyChannels" }
                  | { type: "EmptyMessage" }
                  | { type: "PayloadTooLarge" }
                  | { type: "CannotRemoveYourself" }
                  | { max: number; type: "GroupTooLarge" }
                  | { type: "AlreadyInGroup" }
                  | { type: "NotInGroup" }
                  | { type: "AlreadyPinned" }
                  | { type: "NotPinned" }
                  | { type: "UnknownServer" }
                  | { type: "InvalidRole" }
                  | { type: "Banned" }
                  | { max: number; type: "TooManyServers" }
                  | { max: number; type: "TooManyEmoji" }
                  | { max: number; type: "TooManyRoles" }
                  | { type: "AlreadyInServer" }
                  | { type: "CannotTimeoutYourself" }
                  | { type: "ReachedMaximumBots" }
                  | { type: "IsBot" }
                  | { type: "IsNotBot" }
                  | { type: "BotIsPrivate" }
                  | { type: "CannotReportYourself" }
                  | { permission: string; type: "MissingPermission" }
                  | { permission: string; type: "MissingUserPermission" }
                  | { type: "NotElevated" }
                  | { type: "NotPrivileged" }
                  | { type: "CannotGiveMissingPermissions" }
                  | { type: "NotOwner" }
                  | { collection: string; operation: string; type: "DatabaseError" }
                  | { type: "InternalError" }
                  | { type: "InvalidOperation" }
                  | { type: "InvalidCredentials" }
                  | { type: "InvalidProperty" }
                  | { type: "InvalidSession" }
                  | { type: "InvalidFlagValue" }
                  | { type: "NotAuthenticated" }
                  | { type: "DuplicateNonce" }
                  | { type: "NotFound" }
                  | { type: "NoEffect" }
                  | { error: string; type: "FailedValidation" }
                  | { type: "ProxyError" }
                  | { type: "FileTooSmall" }
                  | { max: number; type: "FileTooLarge" }
                  | { type: "FileTypeNotAllowed" }
                  | { type: "ImageProcessingFailed" }
                  | { type: "NoEmbedData" }
                  | { type: "VosoUnavailable" }
                  | { feature: string; type: "FeatureDisabled" }
              ) & { location: string };
              type: "revolt";
          }

    Methods

    addListener

    • addListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • addListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    connect

    • connect(uri: string, token: string): void

      Connect to the websocket service.

      +

    Returns EventClient<T>

    Properties

    Protected Readonly[brandSymbol]

    "[brandSymbol]": Events

    This field doesn't actually exist, it's just a way to make TS properly infer the events from classes that extend AsyncEventEmitter

    +

    Readonlyoptions

    options: EventClientOptions

    Readonlyping

    ping: Accessor<number>

    Readonlystate

    state: Accessor<ConnectionState>

    Accessors

    lastError

    • get lastError(): | undefined
      | { data: any; type: "socket" }
      | {
          data: (
              | { type: "LabelMe" }
              | { type: "AlreadyOnboarded" }
              | { type: "UsernameTaken" }
              | { type: "InvalidUsername" }
              | { type: "DiscriminatorChangeRatelimited" }
              | { type: "UnknownUser" }
              | { type: "AlreadyFriends" }
              | { type: "AlreadySentRequest" }
              | { type: "Blocked" }
              | { type: "BlockedByOther" }
              | { type: "NotFriends" }
              | { max: number; type: "TooManyPendingFriendRequests" }
              | { type: "UnknownChannel" }
              | { type: "UnknownAttachment" }
              | { type: "UnknownMessage" }
              | { type: "CannotEditMessage" }
              | { type: "CannotJoinCall" }
              | { max: number; type: "TooManyAttachments" }
              | { max: number; type: "TooManyEmbeds" }
              | { max: number; type: "TooManyReplies" }
              | { max: number; type: "TooManyChannels" }
              | { type: "EmptyMessage" }
              | { type: "PayloadTooLarge" }
              | { type: "CannotRemoveYourself" }
              | { max: number; type: "GroupTooLarge" }
              | { type: "AlreadyInGroup" }
              | { type: "NotInGroup" }
              | { type: "AlreadyPinned" }
              | { type: "NotPinned" }
              | { type: "UnknownServer" }
              | { type: "InvalidRole" }
              | { type: "Banned" }
              | { max: number; type: "TooManyServers" }
              | { max: number; type: "TooManyEmoji" }
              | { max: number; type: "TooManyRoles" }
              | { type: "AlreadyInServer" }
              | { type: "CannotTimeoutYourself" }
              | { type: "ReachedMaximumBots" }
              | { type: "IsBot" }
              | { type: "IsNotBot" }
              | { type: "BotIsPrivate" }
              | { type: "CannotReportYourself" }
              | { permission: string; type: "MissingPermission" }
              | { permission: string; type: "MissingUserPermission" }
              | { type: "NotElevated" }
              | { type: "NotPrivileged" }
              | { type: "CannotGiveMissingPermissions" }
              | { type: "NotOwner" }
              | { collection: string; operation: string; type: "DatabaseError" }
              | { type: "InternalError" }
              | { type: "InvalidOperation" }
              | { type: "InvalidCredentials" }
              | { type: "InvalidProperty" }
              | { type: "InvalidSession" }
              | { type: "InvalidFlagValue" }
              | { type: "NotAuthenticated" }
              | { type: "DuplicateNonce" }
              | { type: "NotFound" }
              | { type: "NoEffect" }
              | { error: string; type: "FailedValidation" }
              | { type: "ProxyError" }
              | { type: "FileTooSmall" }
              | { max: number; type: "FileTooLarge" }
              | { type: "FileTypeNotAllowed" }
              | { type: "ImageProcessingFailed" }
              | { type: "NoEmbedData" }
              | { type: "VosoUnavailable" }
              | { feature: string; type: "FeatureDisabled" }
          ) & { location: string };
          type: "revolt";
      }

      Last error encountered by events client

      +

      Returns
          | undefined
          | { data: any; type: "socket" }
          | {
              data: (
                  | { type: "LabelMe" }
                  | { type: "AlreadyOnboarded" }
                  | { type: "UsernameTaken" }
                  | { type: "InvalidUsername" }
                  | { type: "DiscriminatorChangeRatelimited" }
                  | { type: "UnknownUser" }
                  | { type: "AlreadyFriends" }
                  | { type: "AlreadySentRequest" }
                  | { type: "Blocked" }
                  | { type: "BlockedByOther" }
                  | { type: "NotFriends" }
                  | { max: number; type: "TooManyPendingFriendRequests" }
                  | { type: "UnknownChannel" }
                  | { type: "UnknownAttachment" }
                  | { type: "UnknownMessage" }
                  | { type: "CannotEditMessage" }
                  | { type: "CannotJoinCall" }
                  | { max: number; type: "TooManyAttachments" }
                  | { max: number; type: "TooManyEmbeds" }
                  | { max: number; type: "TooManyReplies" }
                  | { max: number; type: "TooManyChannels" }
                  | { type: "EmptyMessage" }
                  | { type: "PayloadTooLarge" }
                  | { type: "CannotRemoveYourself" }
                  | { max: number; type: "GroupTooLarge" }
                  | { type: "AlreadyInGroup" }
                  | { type: "NotInGroup" }
                  | { type: "AlreadyPinned" }
                  | { type: "NotPinned" }
                  | { type: "UnknownServer" }
                  | { type: "InvalidRole" }
                  | { type: "Banned" }
                  | { max: number; type: "TooManyServers" }
                  | { max: number; type: "TooManyEmoji" }
                  | { max: number; type: "TooManyRoles" }
                  | { type: "AlreadyInServer" }
                  | { type: "CannotTimeoutYourself" }
                  | { type: "ReachedMaximumBots" }
                  | { type: "IsBot" }
                  | { type: "IsNotBot" }
                  | { type: "BotIsPrivate" }
                  | { type: "CannotReportYourself" }
                  | { permission: string; type: "MissingPermission" }
                  | { permission: string; type: "MissingUserPermission" }
                  | { type: "NotElevated" }
                  | { type: "NotPrivileged" }
                  | { type: "CannotGiveMissingPermissions" }
                  | { type: "NotOwner" }
                  | { collection: string; operation: string; type: "DatabaseError" }
                  | { type: "InternalError" }
                  | { type: "InvalidOperation" }
                  | { type: "InvalidCredentials" }
                  | { type: "InvalidProperty" }
                  | { type: "InvalidSession" }
                  | { type: "InvalidFlagValue" }
                  | { type: "NotAuthenticated" }
                  | { type: "DuplicateNonce" }
                  | { type: "NotFound" }
                  | { type: "NoEffect" }
                  | { error: string; type: "FailedValidation" }
                  | { type: "ProxyError" }
                  | { type: "FileTooSmall" }
                  | { max: number; type: "FileTooLarge" }
                  | { type: "FileTypeNotAllowed" }
                  | { type: "ImageProcessingFailed" }
                  | { type: "NoEmbedData" }
                  | { type: "VosoUnavailable" }
                  | { feature: string; type: "FeatureDisabled" }
              ) & { location: string };
              type: "revolt";
          }

    Methods

    addListener

    • addListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • addListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    connect

    • connect(uri: string, token: string): void

      Connect to the websocket service.

      Parameters

      • uri: string

        WebSocket URI

      • token: string

        Authentication token

        -

      Returns void

    disconnect

    emit

    • emit<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
        >

      Returns boolean

    • emit<K extends string | symbol>(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
        >

      Returns boolean

    eventNames

    • eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events<T, EventProtocol<T>>
      )[]

      Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events<T, EventProtocol<T>>
      )[]

    getMaxListeners

    • getMaxListeners(): number

      Returns number

    handle

    • handle(event: EventProtocol<T>["server"]): void

      Handle events intended for client before passing them along.

      +

    Returns void

    disconnect

    emit

    • emit<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
        >

      Returns boolean

    • emit<K extends string | symbol>(
          eventName: K,
          ...args: InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
          >,
      ): boolean

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • ...args: InternalGetAsyncEventEmitterEventParameters<
            AsyncEventEmitter<Events<T, EventProtocol<T>>>,
            K,
        >

      Returns boolean

    eventNames

    • eventNames(): (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events<T, EventProtocol<T>>
      )[]

      Returns (string | symbol)[] & (keyof AsyncEventEmitterPredefinedEvents)[] & (
          keyof Events<T, EventProtocol<T>>
      )[]

    getMaxListeners

    • getMaxListeners(): number

      Returns number

    handle

    • handle(event: EventProtocol<T>["server"]): void

      Handle events intended for client before passing them along.

      Parameters

      • event: EventProtocol<T>["server"]

        Event

        -

      Returns void

    listenerCount

    • listenerCount<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
      ): number

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K

      Returns number

    • listenerCount(eventName: string | symbol): number

      Parameters

      • eventName: string | symbol

      Returns number

    listeners

    • listeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

    • listeners<K extends string | symbol>(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

    off

    • off<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • off<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    on

    • on<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • on<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    once

    • once<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • once<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    prependListener

    • prependListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • prependListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    prependOnceListener

    • prependOnceListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • prependOnceListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    rawListeners

    • rawListeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

    • rawListeners<K extends string | symbol>(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

    removeAllListeners

    • removeAllListeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          event: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • event: K

      Returns this

    • removeAllListeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          event?: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • Optionalevent: K

      Returns this

    • removeAllListeners(event: string | symbol): this

      Parameters

      • event: string | symbol

      Returns this

    • removeAllListeners(event?: string | symbol): this

      Parameters

      • Optionalevent: string | symbol

      Returns this

    removeListener

    • removeListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • removeListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    send

    • send(event: EventProtocol<T>["client"]): void

      Send an event to the server.

      +

    Returns void

    listenerCount

    • listenerCount<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
      ): number

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K

      Returns number

    • listenerCount(eventName: string | symbol): number

      Parameters

      • eventName: string | symbol

      Returns number

    listeners

    • listeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

    • listeners<K extends string | symbol>(
          eventName: K,
      ): Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns Exclude<
          InternalAsyncEventEmitterInternalListenerForEvent<
              AsyncEventEmitter<Events<T, EventProtocol<T>>>,
              K,
              Events<T, EventProtocol<T>>,
          >["listener"],
          undefined,
      >[]

    off

    • off<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • off<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    on

    • on<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • on<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    once

    • once<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • once<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    prependListener

    • prependListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • prependListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    prependOnceListener

    • prependOnceListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • prependOnceListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    rawListeners

    • rawListeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

    • rawListeners<K extends string | symbol>(
          eventName: K,
      ): InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K

      Returns InternalAsyncEventEmitterInternalListenerForEvent<
          AsyncEventEmitter<Events<T, EventProtocol<T>>>,
          K,
          Events<T, EventProtocol<T>>,
      >[]

    removeAllListeners

    • removeAllListeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          event: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • event: K

      Returns this

    • removeAllListeners<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          event?: K,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • Optionalevent: K

      Returns this

    • removeAllListeners(event: string | symbol): this

      Parameters

      • event: string | symbol

      Returns this

    • removeAllListeners(event?: string | symbol): this

      Parameters

      • Optionalevent: string | symbol

      Returns this

    removeListener

    • removeListener<
          K extends
              | (keyof AsyncEventEmitterPredefinedEvents)
              | (keyof Events<T, EventProtocol<T>>),
      >(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends (keyof AsyncEventEmitterPredefinedEvents) | (keyof Events<T, EventProtocol<T>>)

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    • removeListener<K extends string | symbol>(
          eventName: K,
          listener: Exclude<
              InternalAsyncEventEmitterInternalListenerForEvent<
                  AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                  K,
                  Events<T, EventProtocol<T>>,
              >["listener"],
              undefined,
          >,
      ): this

      Type Parameters

      • K extends string | symbol

      Parameters

      • eventName: K
      • listener: Exclude<
            InternalAsyncEventEmitterInternalListenerForEvent<
                AsyncEventEmitter<Events<T, EventProtocol<T>>>,
                K,
                Events<T, EventProtocol<T>>,
            >["listener"],
            undefined,
        >

      Returns this

    send

    • send(event: EventProtocol<T>["client"]): void

      Send an event to the server.

      Parameters

      • event: EventProtocol<T>["client"]

        Event

        -

      Returns void

    setMaxListeners

    • setMaxListeners(n: number): this

      Parameters

      • n: number

      Returns this

    waitForAllListenersToComplete

    • waitForAllListenersToComplete(): Promise<boolean>

      Returns Promise<boolean>

    StaticlistenerCount

    • listenerCount<
          EventMap extends {},
          EventName extends
              PropertyKey =
              | (keyof AsyncEventEmitterPredefinedEvents)
              | keyof EventMap,
      >(
          emitter: AsyncEventEmitter<EventMap>,
          eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName,
      ): number

      Type Parameters

      • EventMap extends {}
      • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

      Parameters

      • emitter: AsyncEventEmitter<EventMap>
      • eventName: (keyof AsyncEventEmitterPredefinedEvents) | EventName

      Returns number

    • listenerCount(
          emitter: AsyncEventEmitter<any>,
          eventName: string | symbol,
      ): number

      Parameters

      • emitter: AsyncEventEmitter<any>
      • eventName: string | symbol

      Returns number

    Staticon

    • on<
          EventMap extends {},
          EventName extends
              PropertyKey =
              | (keyof AsyncEventEmitterPredefinedEvents)
              | keyof EventMap,
      >(
          emitter: AsyncEventEmitter<EventMap>,
          eventName: EventName,
          options?: AbortableMethods,
      ): AsyncGenerator<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
          void,
      >

      Type Parameters

      • EventMap extends {}
      • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

      Parameters

      • emitter: AsyncEventEmitter<EventMap>
      • eventName: EventName
      • Optionaloptions: AbortableMethods

      Returns AsyncGenerator<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
          void,
      >

    • on(
          emitter: AsyncEventEmitter<any>,
          eventName: string | symbol,
          options?: AbortableMethods,
      ): AsyncGenerator<any[], void>

      Parameters

      • emitter: AsyncEventEmitter<any>
      • eventName: string | symbol
      • Optionaloptions: AbortableMethods

      Returns AsyncGenerator<any[], void>

    Staticonce

    • once<
          EventMap extends {},
          EventName extends
              PropertyKey =
              | (keyof AsyncEventEmitterPredefinedEvents)
              | keyof EventMap,
      >(
          emitter: AsyncEventEmitter<EventMap>,
          eventName: EventName,
          options?: AbortableMethods,
      ): Promise<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
      >

      Type Parameters

      • EventMap extends {}
      • EventName extends PropertyKey = (keyof AsyncEventEmitterPredefinedEvents) | keyof EventMap

      Parameters

      • emitter: AsyncEventEmitter<EventMap>
      • eventName: EventName
      • Optionaloptions: AbortableMethods

      Returns Promise<
          InternalGetAsyncEventEmitterEventParameters<
              AsyncEventEmitter<EventMap>,
              EventName,
              EventMap,
          >,
      >

    • once(
          emitter: AsyncEventEmitter<any>,
          eventName: string | symbol,
          options?: AbortableMethods,
      ): Promise<any[]>

      Parameters

      • emitter: AsyncEventEmitter<any>
      • eventName: string | symbol
      • Optionaloptions: AbortableMethods

      Returns Promise<any[]>

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    setMaxListeners

    waitForAllListenersToComplete

    StaticlistenerCount

    Staticon

    Staticonce

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/File.html b/classes/File.html index e8b65b6d..b30fedbe 100644 --- a/classes/File.html +++ b/classes/File.html @@ -1,5 +1,5 @@ File | revolt.js

    Class File

    Uploaded File

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    contentType? filename? id @@ -14,21 +14,21 @@

    Constructors

    constructor

    • new File(
          client: Client,
          file: Pick<
              {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              },
              "_id"
              | "tag"
              | "metadata",
          > & Partial<
              {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              },
          >,
      ): File

      Construct File

      Parameters

      • client: Client

        Client

      • file: Pick<
            {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            },
            "_id"
            | "tag"
            | "metadata",
        > & Partial<
            {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            },
        >

        File

        -

      Returns File

    Properties

    Optional ReadonlycontentType

    contentType?: string

    Raw content type of this file

    -

    Optional Readonlyfilename

    filename?: string

    Original filename

    -

    Readonlyid

    id: string

    File Id

    -

    Readonlymetadata

    metadata:
        | { type: "File" }
        | { type: "Text" }
        | { height: number; type: "Image"; width: number }
        | { height: number; type: "Video"; width: number }
        | { type: "Audio" }

    Parsed metadata of the file

    +

    Returns File

    Properties

    Optional ReadonlycontentType

    contentType?: string

    Raw content type of this file

    +

    Optional Readonlyfilename

    filename?: string

    Original filename

    +

    Readonlyid

    id: string

    File Id

    +

    Readonlymetadata

    metadata:
        | { type: "File" }
        | { type: "Text" }
        | { height: number; type: "Image"; width: number }
        | { height: number; type: "Video"; width: number }
        | { type: "Audio" }

    Parsed metadata of the file

    Type declaration

    • { type: "File" }
    • { type: "Text" }
    • { height: number; type: "Image"; width: number }
      • height: number

        Format: uint

      • type: "Image"
      • width: number

        Format: uint

    • { height: number; type: "Video"; width: number }
      • height: number

        Format: uint

      • type: "Video"
      • width: number

        Format: uint

        -
    • { type: "Audio" }

    Optional Readonlysize

    size?: number

    Size of the file (in bytes)

    -

    Readonlytag

    tag: string

    File bucket

    -

    Accessors

    downloadURL

    humanReadableSize

    isSpoiler

    • get isSpoiler(): boolean

      Whether this file should have a spoiler

      -

      Returns boolean

    url

    Methods

    createFileURL

    • createFileURL(forceAnimation?: boolean): undefined | string

      Creates a URL to a given file with given options.

      +
  • { type: "Audio" }

    • Optional Readonlysize

    size?: number

    Size of the file (in bytes)

    +

    Readonlytag

    tag: string

    File bucket

    +

    Accessors

    downloadURL

    humanReadableSize

    isSpoiler

    • get isSpoiler(): boolean

      Whether this file should have a spoiler

      +

      Returns boolean

    url

    Methods

    createFileURL

    • createFileURL(forceAnimation?: boolean): undefined | string

      Creates a URL to a given file with given options.

      Parameters

      • OptionalforceAnimation: boolean

        Returns GIF if applicable (for avatars/icons)

      Returns undefined | string

      Generated URL or nothing

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ImageEmbed.html b/classes/ImageEmbed.html index c2033cee..5d0e5a72 100644 --- a/classes/ImageEmbed.html +++ b/classes/ImageEmbed.html @@ -1,5 +1,5 @@ ImageEmbed | revolt.js

    Class ImageEmbed

    Image Embed

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? height size @@ -11,8 +11,8 @@

    Constructors

    constructor

    • new ImageEmbed(
          client: Client,
          embed: Omit<
              (
                  | {
                      colour?: null
                      | string;
                      description?: null | string;
                      icon_url?: null | string;
                      image?:
                          | null
                          | {
                              height: number;
                              size: "Large"
                              | "Preview";
                              url: string;
                              width: number;
                          };
                      original_url?: null
                      | string;
                      site_name?: null | string;
                      special?:
                          | null
                          | { type: "None" }
                          | { type: "GIF" }
                          | { id: string; timestamp?: null | string; type: "YouTube" }
                          | { content_type: "Channel"; id: string; type: "Lightspeed" }
                          | {
                              content_type: "Video" | "Channel" | "Clip";
                              id: string;
                              type: "Twitch";
                          }
                          | { content_type: string; id: string; type: "Spotify" }
                          | { type: "Soundcloud" }
                          | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                          | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                          | { id: string; type: "Streamable" };
                      title?: null | string;
                      type: "Website";
                      url?: null | string;
                      video?: null | { height: number; url: string; width: number };
                  }
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      type: "Image";
                      url: string;
                      width: number;
                  }
                  | { height: number; type: "Video"; url: string; width: number }
                  | {
                      colour?: null | string;
                      description?: null | string;
                      icon_url?: null | string;
                      media?:
                          | null
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: null
                              | boolean;
                              filename: string;
                              message_id?: null | string;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: null | string;
                              reported?: null | boolean;
                              server_id?: null | string;
                              size: number;
                              tag: string;
                              user_id?: null | string;
                          };
                      title?: null
                      | string;
                      type: "Text";
                      url?: null | string;
                  }
                  | { type: "None" }
              ) & { type: "Image" },
              "type",
          >,
      ): ImageEmbed

      Construct Image Embed

      Parameters

      • client: Client

        Client

      • embed: Omit<
            (
                | {
                    colour?: null
                    | string;
                    description?: null | string;
                    icon_url?: null | string;
                    image?:
                        | null
                        | {
                            height: number;
                            size: "Large"
                            | "Preview";
                            url: string;
                            width: number;
                        };
                    original_url?: null
                    | string;
                    site_name?: null | string;
                    special?:
                        | null
                        | { type: "None" }
                        | { type: "GIF" }
                        | { id: string; timestamp?: null | string; type: "YouTube" }
                        | { content_type: "Channel"; id: string; type: "Lightspeed" }
                        | {
                            content_type: "Video" | "Channel" | "Clip";
                            id: string;
                            type: "Twitch";
                        }
                        | { content_type: string; id: string; type: "Spotify" }
                        | { type: "Soundcloud" }
                        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                        | { id: string; type: "Streamable" };
                    title?: null | string;
                    type: "Website";
                    url?: null | string;
                    video?: null | { height: number; url: string; width: number };
                }
                | {
                    height: number;
                    size: "Large"
                    | "Preview";
                    type: "Image";
                    url: string;
                    width: number;
                }
                | { height: number; type: "Video"; url: string; width: number }
                | {
                    colour?: null | string;
                    description?: null | string;
                    icon_url?: null | string;
                    media?:
                        | null
                        | {
                            _id: string;
                            content_type: string;
                            deleted?: null
                            | boolean;
                            filename: string;
                            message_id?: null | string;
                            metadata:
                                | { type: "File" }
                                | { type: "Text" }
                                | { height: number; type: "Image"; width: number }
                                | { height: number; type: "Video"; width: number }
                                | { type: "Audio" };
                            object_id?: null | string;
                            reported?: null | boolean;
                            server_id?: null | string;
                            size: number;
                            tag: string;
                            user_id?: null | string;
                        };
                    title?: null
                    | string;
                    type: "Text";
                    url?: null | string;
                }
                | { type: "None" }
            ) & { type: "Image" },
            "type",
        >

        Embed

        -

      Returns ImageEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Readonlyheight

    height: number

    Readonlysize

    size: "Large" | "Preview"

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Readonlyurl

    url: string

    Readonlywidth

    width: number

    Accessors

    proxiedURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      +

    Returns ImageEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Readonlyheight

    height: number

    Readonlysize

    size: "Large" | "Preview"

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Readonlyurl

    url: string

    Readonlywidth

    width: number

    Accessors

    proxiedURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      Parameters

      • client: Client

        Client

      • embed:
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                image?:
                    | null
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        url: string;
                        width: number;
                    };
                original_url?: null
                | string;
                site_name?: null | string;
                special?:
                    | null
                    | { type: "None" }
                    | { type: "GIF" }
                    | { id: string; timestamp?: null | string; type: "YouTube" }
                    | { content_type: "Channel"; id: string; type: "Lightspeed" }
                    | {
                        content_type: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { id: string; type: "Streamable" };
                title?: null | string;
                type: "Website";
                url?: null | string;
                video?: null | { height: number; url: string; width: number };
            }
            | {
                height: number;
                size: "Large"
                | "Preview";
                type: "Image";
                url: string;
                width: number;
            }
            | { height: number; type: "Video"; url: string; width: number }
            | {
                colour?: null | string;
                description?: null | string;
                icon_url?: null | string;
                media?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                title?: null
                | string;
                type: "Text";
                url?: null | string;
            }
            | { type: "None" }

        Data

        • {
              colour?: null | string;
              description?: null | string;
              icon_url?: null | string;
              image?:
                  | null
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      url: string;
                      width: number;
                  };
              original_url?: null
              | string;
              site_name?: null | string;
              special?:
                  | null
                  | { type: "None" }
                  | { type: "GIF" }
                  | { id: string; timestamp?: null | string; type: "YouTube" }
                  | { content_type: "Channel"; id: string; type: "Lightspeed" }
                  | {
                      content_type: "Video" | "Channel" | "Clip";
                      id: string;
                      type: "Twitch";
                  }
                  | { content_type: string; id: string; type: "Spotify" }
                  | { type: "Soundcloud" }
                  | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                  | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                  | { id: string; type: "Streamable" };
              title?: null | string;
              type: "Website";
              url?: null | string;
              video?: null | { height: number; url: string; width: number };
          }
          • Optionalcolour?: null | string

            Description

            CSS Colour

            @@ -43,4 +43,4 @@
          • Optionaltitle?: null | string

            Description

            Title of text embed

          • type: "Text"
          • Optionalurl?: null | string

            Description

            URL for title

        • { type: "None" }

      Returns MessageEmbed

      Embed

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/MFA.html b/classes/MFA.html index 6648ccd0..bcd14ab0 100644 --- a/classes/MFA.html +++ b/classes/MFA.html @@ -1,5 +1,5 @@ MFA | revolt.js

    Class MFA

    Multi-Factor Authentication

    -

    Constructors

    constructor +

    Constructors

    constructor

    Accessors

    authenticatorEnabled availableMethods recoveryEnabled @@ -8,11 +8,11 @@

    Constructors

    constructor

    • new MFA(
          client: Client,
          state: {
              email_mfa: boolean;
              email_otp: boolean;
              recovery_active: boolean;
              security_key_mfa: boolean;
              totp_mfa: boolean;
              trusted_handover: boolean;
          },
      ): MFA

      Construct MFA helper

      Parameters

      • client: Client

        Client

      • state: {
            email_mfa: boolean;
            email_otp: boolean;
            recovery_active: boolean;
            security_key_mfa: boolean;
            totp_mfa: boolean;
            trusted_handover: boolean;
        }

        State

        -

      Returns MFA

    Accessors

    authenticatorEnabled

    • get authenticatorEnabled(): boolean

      Whether authenticator app is enabled

      -

      Returns boolean

    availableMethods

    • get availableMethods(): ("Password" | "Recovery" | "Totp")[]

      Available MFA methods for generating tickets

      -

      Returns ("Password" | "Recovery" | "Totp")[]

    recoveryEnabled

    • get recoveryEnabled(): boolean

      Whether recovery codes are enabled

      -

      Returns boolean

    Methods

    createTicket

    • createTicket(
          params:
              | { password: string }
              | { recovery_code: string }
              | { totp_code: string },
      ): Promise<MFATicket>

      Create an MFA ticket

      +

    Returns MFA

    Accessors

    authenticatorEnabled

    • get authenticatorEnabled(): boolean

      Whether authenticator app is enabled

      +

      Returns boolean

    availableMethods

    • get availableMethods(): ("Password" | "Recovery" | "Totp")[]

      Available MFA methods for generating tickets

      +

      Returns ("Password" | "Recovery" | "Totp")[]

    recoveryEnabled

    • get recoveryEnabled(): boolean

      Whether recovery codes are enabled

      +

      Returns boolean

    Methods

    createTicket

    • createTicket(
          params:
              | { password: string }
              | { recovery_code: string }
              | { totp_code: string },
      ): Promise<MFATicket>

      Create an MFA ticket

      Parameters

      • params: { password: string } | { recovery_code: string } | { totp_code: string }

      Returns Promise<MFATicket>

      Token

      -

    enableAuthenticator

    • enableAuthenticator(token: string): Promise<void>

      Enable authenticator using token generated from secret found earlier

      +

    enableAuthenticator

    • enableAuthenticator(token: string): Promise<void>

      Enable authenticator using token generated from secret found earlier

      Parameters

      • token: string

        Token

        -

      Returns Promise<void>

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns Promise<void>

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/classes/MFATicket.html b/classes/MFATicket.html index 680ea043..b75337c5 100644 --- a/classes/MFATicket.html +++ b/classes/MFATicket.html @@ -1,5 +1,5 @@ MFATicket | revolt.js

    Class MFATicket

    MFA Ticket

    -

    Constructors

    constructor +

    Constructors

    constructor

    Accessors

    token

    Methods

    deleteAccount disableAccount @@ -17,14 +17,14 @@
  • token: string

    Description

    Unique Token

  • validated: boolean

    Description

    Whether this ticket has been validated (can be used for account actions)

  • mutate: SetStoreFunction<
        {
            email_mfa: boolean;
            email_otp: boolean;
            recovery_active: boolean;
            security_key_mfa: boolean;
            totp_mfa: boolean;
            trusted_handover: boolean;
        },
    >

    Mutate the store

    -

    • Returns MFATicket

    Accessors

    token

    Methods

    deleteAccount

    disableAccount

    disableAuthenticator

    • disableAuthenticator(): Promise<void>

      Disable authenticator

      -

      Returns Promise<void>

    fetchRecoveryCodes

    • fetchRecoveryCodes(): Promise<string[]>

      Fetch recovery codes

      +

    Returns MFATicket

    Accessors

    token

    Methods

    deleteAccount

    disableAccount

    disableAuthenticator

    • disableAuthenticator(): Promise<void>

      Disable authenticator

      +

      Returns Promise<void>

    fetchRecoveryCodes

    • fetchRecoveryCodes(): Promise<string[]>

      Fetch recovery codes

      Returns Promise<string[]>

      List of codes

      -

    generateAuthenticatorSecret

    • generateAuthenticatorSecret(): Promise<string>

      Generate new authenticator secret

      +

    generateAuthenticatorSecret

    • generateAuthenticatorSecret(): Promise<string>

      Generate new authenticator secret

      Returns Promise<string>

      Secret

      -

    generateRecoveryCodes

    • generateRecoveryCodes(): Promise<string[]>

      Generate new set of recovery codes

      +

    generateRecoveryCodes

    • generateRecoveryCodes(): Promise<string[]>

      Generate new set of recovery codes

      Returns Promise<string[]>

      List of codes

      -

    On This Page

    Constructors
    Accessors
    Methods
    +

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/classes/Message.html b/classes/Message.html index e67d67ea..f8320f91 100644 --- a/classes/Message.html +++ b/classes/Message.html @@ -1,5 +1,5 @@ Message | revolt.js

    Class Message

    Message Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists animatedAvatarURL @@ -47,59 +47,59 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    animatedAvatarURL

    • get animatedAvatarURL(): undefined | string

      Get the animated avatar URL for this message

      -

      Returns undefined | string

    attachments

    author

    authorId

    • get authorId(): undefined | string

      Id of user or webhook this message was sent by

      -

      Returns undefined | string

    avatarURL

    • get avatarURL(): undefined | string

      Get the avatar URL for this message

      -

      Returns undefined | string

    channel

    channelId

    content

    contentPlain

    createdAt

    editedAt

    • get editedAt(): undefined | Date

      Time at which this message was edited

      -

      Returns undefined | Date

    embeds

    flags

    interactions

    • get interactions(): | undefined
      | { reactions?: null
      | string[]; restrict_reactions?: boolean }

      Interactions

      +

    Returns Message

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    animatedAvatarURL

    • get animatedAvatarURL(): undefined | string

      Get the animated avatar URL for this message

      +

      Returns undefined | string

    attachments

    author

    authorId

    • get authorId(): undefined | string

      Id of user or webhook this message was sent by

      +

      Returns undefined | string

    avatarURL

    • get avatarURL(): undefined | string

      Get the avatar URL for this message

      +

      Returns undefined | string

    channel

    channelId

    content

    contentPlain

    createdAt

    editedAt

    • get editedAt(): undefined | Date

      Time at which this message was edited

      +

      Returns undefined | Date

    embeds

    flags

    interactions

    • get interactions(): | undefined
      | { reactions?: null
      | string[]; restrict_reactions?: boolean }

      Interactions

      Returns undefined | { reactions?: null | string[]; restrict_reactions?: boolean }

      • undefined
      • { reactions?: null | string[]; restrict_reactions?: boolean }
        • Optionalreactions?: null | string[]

          Description

          Reactions which should always appear and be distinct

        • Optionalrestrict_reactions?: boolean

          Description

          Whether reactions should be restricted to the given list

          Can only be set to true if reactions list is of at least length 1

          -

    isSuppressed

    • get isSuppressed(): boolean

      Whether this message has suppressed desktop/push notifications

      -

      Returns boolean

    masquerade

    • get masquerade(): | undefined
      | { avatar?: null
      | string; colour?: null | string; name?: null | string }

      Masquerade

      +

    isSuppressed

    masquerade

    masqueradeAvatarURL

    member

    mentioned

    mentionIds

    nonce

    path

    pinned

    reactions

    replyIds

    roleColour

    roleMentionIds

    roleMentions

    server

    systemMessage

    url

    username

    webhook

    Methods

    ack

    clearReactions

    delete

    edit

    • edit(
          data: {
              content?: null | string;
              embeds?:
                  | null
                  | {
                      colour?: null
                      | string;
                      description?: null | string;
                      icon_url?: null | string;
                      media?: null | string;
                      title?: null | string;
                      url?: null | string;
                  }[];
          },
      ): Promise<
          {
              _id: string;
              attachments?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              }[];
              author: string;
              channel: string;
              content?: null
              | string;
              edited?: null | string;
              embeds?:
                  | null
                  | (
                      | {
                          colour?: null
                          | string;
                          description?: null | string;
                          icon_url?: null | string;
                          image?:
                              | null
                              | {
                                  height: number;
                                  size: "Large"
                                  | "Preview";
                                  url: string;
                                  width: number;
                              };
                          original_url?: null
                          | string;
                          site_name?: null | string;
                          special?:
                              | null
                              | { type: "None" }
                              | { type: "GIF" }
                              | { id: string; timestamp?: null | string; type: "YouTube" }
                              | { content_type: "Channel"; id: string; type: "Lightspeed" }
                              | {
                                  content_type: "Video" | "Channel" | "Clip";
                                  id: string;
                                  type: "Twitch";
                              }
                              | { content_type: string; id: string; type: "Spotify" }
                              | { type: "Soundcloud" }
                              | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                              | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                              | { id: string; type: "Streamable" };
                          title?: null | string;
                          type: "Website";
                          url?: null | string;
                          video?: null | { height: number; url: string; width: number };
                      }
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          type: "Image";
                          url: string;
                          width: number;
                      }
                      | { height: number; type: "Video"; url: string; width: number }
                      | {
                          colour?: null | string;
                          description?: null | string;
                          icon_url?: null | string;
                          media?:
                              | null
                              | {
                                  _id: string;
                                  content_type: string;
                                  deleted?: null
                                  | boolean;
                                  filename: string;
                                  message_id?: null | string;
                                  metadata:
                                      | { type: "File" }
                                      | { type: "Text" }
                                      | { height: number; type: "Image"; width: number }
                                      | { height: number; type: "Video"; width: number }
                                      | { type: "Audio" };
                                  object_id?: null | string;
                                  reported?: null | boolean;
                                  server_id?: null | string;
                                  size: number;
                                  tag: string;
                                  user_id?: null | string;
                              };
                          title?: null
                          | string;
                          type: "Text";
                          url?: null | string;
                      }
                      | { type: "None" }
                  )[];
              flags?: number;
              interactions?: {
                  reactions?: null | string[];
                  restrict_reactions?: boolean;
              };
              masquerade?: | null
              | { avatar?: null
              | string; colour?: null | string; name?: null | string };
              member?:
                  | null
                  | {
                      _id: { server: string; user: string };
                      avatar?:
                          | null
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: null
                              | boolean;
                              filename: string;
                              message_id?: null | string;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: null | string;
                              reported?: null | boolean;
                              server_id?: null | string;
                              size: number;
                              tag: string;
                              user_id?: null | string;
                          };
                      joined_at: string;
                      nickname?: null
                      | string;
                      roles?: string[];
                      timeout?: null | string;
                  };
              mentions?: null
              | string[];
              nonce?: null | string;
              pinned?: null | boolean;
              reactions?: { [key: string]: string[] };
              replies?: null | string[];
              role_mentions?: null | string[];
              system?:
                  | null
                  | { content: string; type: "text" }
                  | { by: string; id: string; type: "user_added" }
                  | { by: string; id: string; type: "user_remove" }
                  | { id: string; type: "user_joined" }
                  | { id: string; type: "user_left" }
                  | { id: string; type: "user_kicked" }
                  | { id: string; type: "user_banned" }
                  | { by: string; name: string; type: "channel_renamed" }
                  | { by: string; type: "channel_description_changed" }
                  | { by: string; type: "channel_icon_changed" }
                  | { from: string; to: string; type: "channel_ownership_changed" }
                  | { by: string; id: string; type: "message_pinned" }
                  | { by: string; id: string; type: "message_unpinned" };
              user?:
                  | null
                  | {
                      _id: string;
                      avatar?: | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                      badges?: number;
                      bot?: null
                      | { owner: string };
                      discriminator: string;
                      display_name?: null | string;
                      flags?: number;
                      online: boolean;
                      privileged?: boolean;
                      relations?: {
                          _id: string;
                          status:
                              | "User"
                              | "None"
                              | "Friend"
                              | "Outgoing"
                              | "Incoming"
                              | "Blocked"
                              | "BlockedOther";
                      }[];
                      relationship: | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
                      status?: | null
                      | {
                          presence?: null
                          | "Online"
                          | "Idle"
                          | "Focus"
                          | "Busy"
                          | "Invisible";
                          text?: null | string;
                      };
                      username: string;
                  };
              webhook?: null
              | { avatar?: null | string; name: string };
          },
      >

      Edit a message

      +

    masqueradeAvatarURL

    • get masqueradeAvatarURL(): undefined | string

      Avatar URL from the masquerade

      +

      Returns undefined | string

    member

    mentioned

    mentionIds

    • get mentionIds(): undefined | string[]

      IDs of users this message mentions

      +

      Returns undefined | string[]

    nonce

    path

    pinned

    reactions

    • get reactions(): ReactiveMap<string, ReactiveSet<string>>

      Reactions

      +

      Returns ReactiveMap<string, ReactiveSet<string>>

    replyIds

    • get replyIds(): undefined | string[]

      IDs of messages this message replies to

      +

      Returns undefined | string[]

    roleColour

    • get roleColour(): undefined | null | string

      Get the role colour for this message

      +

      Returns undefined | null | string

    roleMentionIds

    • get roleMentionIds(): undefined | string[]

      IDs of roles this message mentions

      +

      Returns undefined | string[]

    roleMentions

    server

    systemMessage

    url

    username

    • get username(): undefined | string

      Get the username for this message

      +

      Returns undefined | string

    webhook

    Methods

    ack

    clearReactions

    delete

    edit

    • edit(
          data: {
              content?: null | string;
              embeds?:
                  | null
                  | {
                      colour?: null
                      | string;
                      description?: null | string;
                      icon_url?: null | string;
                      media?: null | string;
                      title?: null | string;
                      url?: null | string;
                  }[];
          },
      ): Promise<
          {
              _id: string;
              attachments?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              }[];
              author: string;
              channel: string;
              content?: null
              | string;
              edited?: null | string;
              embeds?:
                  | null
                  | (
                      | {
                          colour?: null
                          | string;
                          description?: null | string;
                          icon_url?: null | string;
                          image?:
                              | null
                              | {
                                  height: number;
                                  size: "Large"
                                  | "Preview";
                                  url: string;
                                  width: number;
                              };
                          original_url?: null
                          | string;
                          site_name?: null | string;
                          special?:
                              | null
                              | { type: "None" }
                              | { type: "GIF" }
                              | { id: string; timestamp?: null | string; type: "YouTube" }
                              | { content_type: "Channel"; id: string; type: "Lightspeed" }
                              | {
                                  content_type: "Video" | "Channel" | "Clip";
                                  id: string;
                                  type: "Twitch";
                              }
                              | { content_type: string; id: string; type: "Spotify" }
                              | { type: "Soundcloud" }
                              | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                              | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                              | { id: string; type: "Streamable" };
                          title?: null | string;
                          type: "Website";
                          url?: null | string;
                          video?: null | { height: number; url: string; width: number };
                      }
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          type: "Image";
                          url: string;
                          width: number;
                      }
                      | { height: number; type: "Video"; url: string; width: number }
                      | {
                          colour?: null | string;
                          description?: null | string;
                          icon_url?: null | string;
                          media?:
                              | null
                              | {
                                  _id: string;
                                  content_type: string;
                                  deleted?: null
                                  | boolean;
                                  filename: string;
                                  message_id?: null | string;
                                  metadata:
                                      | { type: "File" }
                                      | { type: "Text" }
                                      | { height: number; type: "Image"; width: number }
                                      | { height: number; type: "Video"; width: number }
                                      | { type: "Audio" };
                                  object_id?: null | string;
                                  reported?: null | boolean;
                                  server_id?: null | string;
                                  size: number;
                                  tag: string;
                                  user_id?: null | string;
                              };
                          title?: null
                          | string;
                          type: "Text";
                          url?: null | string;
                      }
                      | { type: "None" }
                  )[];
              flags?: number;
              interactions?: {
                  reactions?: null | string[];
                  restrict_reactions?: boolean;
              };
              masquerade?: | null
              | { avatar?: null
              | string; colour?: null | string; name?: null | string };
              member?:
                  | null
                  | {
                      _id: { server: string; user: string };
                      avatar?:
                          | null
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: null
                              | boolean;
                              filename: string;
                              message_id?: null | string;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: null | string;
                              reported?: null | boolean;
                              server_id?: null | string;
                              size: number;
                              tag: string;
                              user_id?: null | string;
                          };
                      joined_at: string;
                      nickname?: null
                      | string;
                      roles?: string[];
                      timeout?: null | string;
                  };
              mentions?: null
              | string[];
              nonce?: null | string;
              pinned?: null | boolean;
              reactions?: { [key: string]: string[] };
              replies?: null | string[];
              role_mentions?: null | string[];
              system?:
                  | null
                  | { content: string; type: "text" }
                  | { by: string; id: string; type: "user_added" }
                  | { by: string; id: string; type: "user_remove" }
                  | { id: string; type: "user_joined" }
                  | { id: string; type: "user_left" }
                  | { id: string; type: "user_kicked" }
                  | { id: string; type: "user_banned" }
                  | { by: string; name: string; type: "channel_renamed" }
                  | { by: string; type: "channel_description_changed" }
                  | { by: string; type: "channel_icon_changed" }
                  | { from: string; to: string; type: "channel_ownership_changed" }
                  | { by: string; id: string; type: "message_pinned" }
                  | { by: string; id: string; type: "message_unpinned" };
              user?:
                  | null
                  | {
                      _id: string;
                      avatar?: | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                      badges?: number;
                      bot?: null
                      | { owner: string };
                      discriminator: string;
                      display_name?: null | string;
                      flags?: number;
                      online: boolean;
                      privileged?: boolean;
                      relations?: {
                          _id: string;
                          status:
                              | "User"
                              | "None"
                              | "Friend"
                              | "Outgoing"
                              | "Incoming"
                              | "Blocked"
                              | "BlockedOther";
                      }[];
                      relationship: | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
                      status?: | null
                      | {
                          presence?: null
                          | "Online"
                          | "Idle"
                          | "Focus"
                          | "Busy"
                          | "Invisible";
                          text?: null | string;
                      };
                      username: string;
                  };
              webhook?: null
              | { avatar?: null | string; name: string };
          },
      >

      Edit a message

      Parameters

      • data: {
            content?: null | string;
            embeds?:
                | null
                | {
                    colour?: null
                    | string;
                    description?: null | string;
                    icon_url?: null | string;
                    media?: null | string;
                    title?: null | string;
                    url?: null | string;
                }[];
        }

        Message edit route data

        • Optionalcontent?: null | string

          Description

          New message content

        • Optionalembeds?:
              | null
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?: null | string;
                  title?: null | string;
                  url?: null | string;
              }[]

          Description

          Embeds to include in the message

          -

      Returns Promise<
          {
              _id: string;
              attachments?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              }[];
              author: string;
              channel: string;
              content?: null
              | string;
              edited?: null | string;
              embeds?:
                  | null
                  | (
                      | {
                          colour?: null
                          | string;
                          description?: null | string;
                          icon_url?: null | string;
                          image?:
                              | null
                              | {
                                  height: number;
                                  size: "Large"
                                  | "Preview";
                                  url: string;
                                  width: number;
                              };
                          original_url?: null
                          | string;
                          site_name?: null | string;
                          special?:
                              | null
                              | { type: "None" }
                              | { type: "GIF" }
                              | { id: string; timestamp?: null | string; type: "YouTube" }
                              | { content_type: "Channel"; id: string; type: "Lightspeed" }
                              | {
                                  content_type: "Video" | "Channel" | "Clip";
                                  id: string;
                                  type: "Twitch";
                              }
                              | { content_type: string; id: string; type: "Spotify" }
                              | { type: "Soundcloud" }
                              | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                              | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                              | { id: string; type: "Streamable" };
                          title?: null | string;
                          type: "Website";
                          url?: null | string;
                          video?: null | { height: number; url: string; width: number };
                      }
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          type: "Image";
                          url: string;
                          width: number;
                      }
                      | { height: number; type: "Video"; url: string; width: number }
                      | {
                          colour?: null | string;
                          description?: null | string;
                          icon_url?: null | string;
                          media?:
                              | null
                              | {
                                  _id: string;
                                  content_type: string;
                                  deleted?: null
                                  | boolean;
                                  filename: string;
                                  message_id?: null | string;
                                  metadata:
                                      | { type: "File" }
                                      | { type: "Text" }
                                      | { height: number; type: "Image"; width: number }
                                      | { height: number; type: "Video"; width: number }
                                      | { type: "Audio" };
                                  object_id?: null | string;
                                  reported?: null | boolean;
                                  server_id?: null | string;
                                  size: number;
                                  tag: string;
                                  user_id?: null | string;
                              };
                          title?: null
                          | string;
                          type: "Text";
                          url?: null | string;
                      }
                      | { type: "None" }
                  )[];
              flags?: number;
              interactions?: {
                  reactions?: null | string[];
                  restrict_reactions?: boolean;
              };
              masquerade?: | null
              | { avatar?: null
              | string; colour?: null | string; name?: null | string };
              member?:
                  | null
                  | {
                      _id: { server: string; user: string };
                      avatar?:
                          | null
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: null
                              | boolean;
                              filename: string;
                              message_id?: null | string;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: null | string;
                              reported?: null | boolean;
                              server_id?: null | string;
                              size: number;
                              tag: string;
                              user_id?: null | string;
                          };
                      joined_at: string;
                      nickname?: null
                      | string;
                      roles?: string[];
                      timeout?: null | string;
                  };
              mentions?: null
              | string[];
              nonce?: null | string;
              pinned?: null | boolean;
              reactions?: { [key: string]: string[] };
              replies?: null | string[];
              role_mentions?: null | string[];
              system?:
                  | null
                  | { content: string; type: "text" }
                  | { by: string; id: string; type: "user_added" }
                  | { by: string; id: string; type: "user_remove" }
                  | { id: string; type: "user_joined" }
                  | { id: string; type: "user_left" }
                  | { id: string; type: "user_kicked" }
                  | { id: string; type: "user_banned" }
                  | { by: string; name: string; type: "channel_renamed" }
                  | { by: string; type: "channel_description_changed" }
                  | { by: string; type: "channel_icon_changed" }
                  | { from: string; to: string; type: "channel_ownership_changed" }
                  | { by: string; id: string; type: "message_pinned" }
                  | { by: string; id: string; type: "message_unpinned" };
              user?:
                  | null
                  | {
                      _id: string;
                      avatar?: | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                      badges?: number;
                      bot?: null
                      | { owner: string };
                      discriminator: string;
                      display_name?: null | string;
                      flags?: number;
                      online: boolean;
                      privileged?: boolean;
                      relations?: {
                          _id: string;
                          status:
                              | "User"
                              | "None"
                              | "Friend"
                              | "Outgoing"
                              | "Incoming"
                              | "Blocked"
                              | "BlockedOther";
                      }[];
                      relationship: | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
                      status?: | null
                      | {
                          presence?: null
                          | "Online"
                          | "Idle"
                          | "Focus"
                          | "Busy"
                          | "Invisible";
                          text?: null | string;
                      };
                      username: string;
                  };
              webhook?: null
              | { avatar?: null | string; name: string };
          },
      >

    pin

    react

    • react(emoji: string): Promise<void>

      React to a message

      +

    Returns Promise<
        {
            _id: string;
            attachments?: | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            }[];
            author: string;
            channel: string;
            content?: null
            | string;
            edited?: null | string;
            embeds?:
                | null
                | (
                    | {
                        colour?: null
                        | string;
                        description?: null | string;
                        icon_url?: null | string;
                        image?:
                            | null
                            | {
                                height: number;
                                size: "Large"
                                | "Preview";
                                url: string;
                                width: number;
                            };
                        original_url?: null
                        | string;
                        site_name?: null | string;
                        special?:
                            | null
                            | { type: "None" }
                            | { type: "GIF" }
                            | { id: string; timestamp?: null | string; type: "YouTube" }
                            | { content_type: "Channel"; id: string; type: "Lightspeed" }
                            | {
                                content_type: "Video" | "Channel" | "Clip";
                                id: string;
                                type: "Twitch";
                            }
                            | { content_type: string; id: string; type: "Spotify" }
                            | { type: "Soundcloud" }
                            | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                            | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                            | { id: string; type: "Streamable" };
                        title?: null | string;
                        type: "Website";
                        url?: null | string;
                        video?: null | { height: number; url: string; width: number };
                    }
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        type: "Image";
                        url: string;
                        width: number;
                    }
                    | { height: number; type: "Video"; url: string; width: number }
                    | {
                        colour?: null | string;
                        description?: null | string;
                        icon_url?: null | string;
                        media?:
                            | null
                            | {
                                _id: string;
                                content_type: string;
                                deleted?: null
                                | boolean;
                                filename: string;
                                message_id?: null | string;
                                metadata:
                                    | { type: "File" }
                                    | { type: "Text" }
                                    | { height: number; type: "Image"; width: number }
                                    | { height: number; type: "Video"; width: number }
                                    | { type: "Audio" };
                                object_id?: null | string;
                                reported?: null | boolean;
                                server_id?: null | string;
                                size: number;
                                tag: string;
                                user_id?: null | string;
                            };
                        title?: null
                        | string;
                        type: "Text";
                        url?: null | string;
                    }
                    | { type: "None" }
                )[];
            flags?: number;
            interactions?: {
                reactions?: null | string[];
                restrict_reactions?: boolean;
            };
            masquerade?: | null
            | { avatar?: null
            | string; colour?: null | string; name?: null | string };
            member?:
                | null
                | {
                    _id: { server: string; user: string };
                    avatar?:
                        | null
                        | {
                            _id: string;
                            content_type: string;
                            deleted?: null
                            | boolean;
                            filename: string;
                            message_id?: null | string;
                            metadata:
                                | { type: "File" }
                                | { type: "Text" }
                                | { height: number; type: "Image"; width: number }
                                | { height: number; type: "Video"; width: number }
                                | { type: "Audio" };
                            object_id?: null | string;
                            reported?: null | boolean;
                            server_id?: null | string;
                            size: number;
                            tag: string;
                            user_id?: null | string;
                        };
                    joined_at: string;
                    nickname?: null
                    | string;
                    roles?: string[];
                    timeout?: null | string;
                };
            mentions?: null
            | string[];
            nonce?: null | string;
            pinned?: null | boolean;
            reactions?: { [key: string]: string[] };
            replies?: null | string[];
            role_mentions?: null | string[];
            system?:
                | null
                | { content: string; type: "text" }
                | { by: string; id: string; type: "user_added" }
                | { by: string; id: string; type: "user_remove" }
                | { id: string; type: "user_joined" }
                | { id: string; type: "user_left" }
                | { id: string; type: "user_kicked" }
                | { id: string; type: "user_banned" }
                | { by: string; name: string; type: "channel_renamed" }
                | { by: string; type: "channel_description_changed" }
                | { by: string; type: "channel_icon_changed" }
                | { from: string; to: string; type: "channel_ownership_changed" }
                | { by: string; id: string; type: "message_pinned" }
                | { by: string; id: string; type: "message_unpinned" };
            user?:
                | null
                | {
                    _id: string;
                    avatar?: | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                    badges?: number;
                    bot?: null
                    | { owner: string };
                    discriminator: string;
                    display_name?: null | string;
                    flags?: number;
                    online: boolean;
                    privileged?: boolean;
                    relations?: {
                        _id: string;
                        status:
                            | "User"
                            | "None"
                            | "Friend"
                            | "Outgoing"
                            | "Incoming"
                            | "Blocked"
                            | "BlockedOther";
                    }[];
                    relationship: | "User"
                    | "None"
                    | "Friend"
                    | "Outgoing"
                    | "Incoming"
                    | "Blocked"
                    | "BlockedOther";
                    status?: | null
                    | {
                        presence?: null
                        | "Online"
                        | "Idle"
                        | "Focus"
                        | "Busy"
                        | "Invisible";
                        text?: null | string;
                    };
                    username: string;
                };
            webhook?: null
            | { avatar?: null | string; name: string };
        },
    >

    pin

    react

    • react(emoji: string): Promise<void>

      React to a message

      Parameters

      • emoji: string

        Unicode or emoji ID

        -

      Returns Promise<void>

    reply

    • reply(
          data:
              | string
              | Omit<
                  {
                      attachments?: null
                      | string[];
                      content?: null | string;
                      embeds?:
                          | null
                          | {
                              colour?: null
                              | string;
                              description?: null | string;
                              icon_url?: null | string;
                              media?: null | string;
                              title?: null | string;
                              url?: null | string;
                          }[];
                      flags?: null
                      | number;
                      interactions?:
                          | null
                          | { reactions?: null
                          | string[]; restrict_reactions?: boolean };
                      masquerade?:
                          | null
                          | {
                              avatar?: null
                              | string;
                              colour?: null | string;
                              name?: null | string;
                          };
                      nonce?: null
                      | string;
                      replies?:
                          | null
                          | { fail_if_not_exists?: null
                          | boolean; id: string; mention: boolean }[];
                  },
                  "nonce",
              > & { nonce?: string },
          mention?: boolean,
      ): undefined | Promise<Message>

      Reply to Message

      -

      Parameters

      • data:
            | string
            | Omit<
                {
                    attachments?: null
                    | string[];
                    content?: null | string;
                    embeds?:
                        | null
                        | {
                            colour?: null
                            | string;
                            description?: null | string;
                            icon_url?: null | string;
                            media?: null | string;
                            title?: null | string;
                            url?: null | string;
                        }[];
                    flags?: null
                    | number;
                    interactions?:
                        | null
                        | { reactions?: null
                        | string[]; restrict_reactions?: boolean };
                    masquerade?:
                        | null
                        | {
                            avatar?: null
                            | string;
                            colour?: null | string;
                            name?: null | string;
                        };
                    nonce?: null
                    | string;
                    replies?:
                        | null
                        | { fail_if_not_exists?: null
                        | boolean; id: string; mention: boolean }[];
                },
                "nonce",
            > & { nonce?: string }
      • mention: boolean = true

      Returns undefined | Promise<Message>

    unpin

    unreact

    • unreact(emoji: string): Promise<void>

      Un-react from a message

      +

    Returns Promise<void>

    reply

    • reply(
          data:
              | string
              | Omit<
                  {
                      attachments?: null
                      | string[];
                      content?: null | string;
                      embeds?:
                          | null
                          | {
                              colour?: null
                              | string;
                              description?: null | string;
                              icon_url?: null | string;
                              media?: null | string;
                              title?: null | string;
                              url?: null | string;
                          }[];
                      flags?: null
                      | number;
                      interactions?:
                          | null
                          | { reactions?: null
                          | string[]; restrict_reactions?: boolean };
                      masquerade?:
                          | null
                          | {
                              avatar?: null
                              | string;
                              colour?: null | string;
                              name?: null | string;
                          };
                      nonce?: null
                      | string;
                      replies?:
                          | null
                          | { fail_if_not_exists?: null
                          | boolean; id: string; mention: boolean }[];
                  },
                  "nonce",
              > & { nonce?: string },
          mention?: boolean,
      ): undefined | Promise<Message>

      Reply to Message

      +

      Parameters

      • data:
            | string
            | Omit<
                {
                    attachments?: null
                    | string[];
                    content?: null | string;
                    embeds?:
                        | null
                        | {
                            colour?: null
                            | string;
                            description?: null | string;
                            icon_url?: null | string;
                            media?: null | string;
                            title?: null | string;
                            url?: null | string;
                        }[];
                    flags?: null
                    | number;
                    interactions?:
                        | null
                        | { reactions?: null
                        | string[]; restrict_reactions?: boolean };
                    masquerade?:
                        | null
                        | {
                            avatar?: null
                            | string;
                            colour?: null | string;
                            name?: null | string;
                        };
                    nonce?: null
                    | string;
                    replies?:
                        | null
                        | { fail_if_not_exists?: null
                        | boolean; id: string; mention: boolean }[];
                },
                "nonce",
            > & { nonce?: string }
      • mention: boolean = true

      Returns undefined | Promise<Message>

    unpin

    unreact

    • unreact(emoji: string): Promise<void>

      Un-react from a message

      Parameters

      • emoji: string

        Unicode or emoji ID

        -

      Returns Promise<void>

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Promise<void>

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/MessageCollection.html b/classes/MessageCollection.html index 638dd4fa..cbb6a7c2 100644 --- a/classes/MessageCollection.html +++ b/classes/MessageCollection.html @@ -1,5 +1,5 @@ MessageCollection | revolt.js

    Class MessageCollection

    Collection of Messages

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -22,31 +22,31 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedMessage

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedMessage>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Message,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns MessageCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedMessage

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedMessage>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Message,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: Message

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns Message[]

    find

    forEach

    Returns undefined | Message

    forEach

    get

    get

    getOrCreate

    getOrCreate

    getOrPartial

    Returns Message

    getOrPartial

    has

    Returns undefined | Message

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/MessageEmbed.html b/classes/MessageEmbed.html index d55f47d7..397be9f4 100644 --- a/classes/MessageEmbed.html +++ b/classes/MessageEmbed.html @@ -1,12 +1,12 @@ MessageEmbed | revolt.js

    Class MessageEmbedAbstract

    Message Embed

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type

    Methods

    from

    Constructors

    constructor

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      +

    Returns MessageEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      Parameters

      • client: Client

        Client

      • embed:
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                image?:
                    | null
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        url: string;
                        width: number;
                    };
                original_url?: null
                | string;
                site_name?: null | string;
                special?:
                    | null
                    | { type: "None" }
                    | { type: "GIF" }
                    | { id: string; timestamp?: null | string; type: "YouTube" }
                    | { content_type: "Channel"; id: string; type: "Lightspeed" }
                    | {
                        content_type: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { id: string; type: "Streamable" };
                title?: null | string;
                type: "Website";
                url?: null | string;
                video?: null | { height: number; url: string; width: number };
            }
            | {
                height: number;
                size: "Large"
                | "Preview";
                type: "Image";
                url: string;
                width: number;
            }
            | { height: number; type: "Video"; url: string; width: number }
            | {
                colour?: null | string;
                description?: null | string;
                icon_url?: null | string;
                media?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                title?: null
                | string;
                type: "Text";
                url?: null | string;
            }
            | { type: "None" }

        Data

        • {
              colour?: null | string;
              description?: null | string;
              icon_url?: null | string;
              image?:
                  | null
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      url: string;
                      width: number;
                  };
              original_url?: null
              | string;
              site_name?: null | string;
              special?:
                  | null
                  | { type: "None" }
                  | { type: "GIF" }
                  | { id: string; timestamp?: null | string; type: "YouTube" }
                  | { content_type: "Channel"; id: string; type: "Lightspeed" }
                  | {
                      content_type: "Video" | "Channel" | "Clip";
                      id: string;
                      type: "Twitch";
                  }
                  | { content_type: string; id: string; type: "Spotify" }
                  | { type: "Soundcloud" }
                  | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                  | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                  | { id: string; type: "Streamable" };
              title?: null | string;
              type: "Website";
              url?: null | string;
              video?: null | { height: number; url: string; width: number };
          }
          • Optionalcolour?: null | string

            Description

            CSS Colour

            @@ -37,4 +37,4 @@
          • Optionaltitle?: null | string

            Description

            Title of text embed

          • type: "Text"
          • Optionalurl?: null | string

            Description

            URL for title

        • { type: "None" }

      Returns MessageEmbed

      Embed

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/MessagePinnedSystemMessage.html b/classes/MessagePinnedSystemMessage.html index cca52044..8aaf5758 100644 --- a/classes/MessagePinnedSystemMessage.html +++ b/classes/MessagePinnedSystemMessage.html @@ -1,5 +1,5 @@ MessagePinnedSystemMessage | revolt.js

    Class MessagePinnedSystemMessage

    Message Pinned System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    byId client? messageId @@ -10,9 +10,9 @@

    Constructors

    constructor

    • new MessagePinnedSystemMessage(
          client: Client,
          systemMessage: (
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" }
          ) & { type: "message_pinned" | "message_unpinned" },
      ): MessagePinnedSystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • systemMessage: (
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }
        ) & { type: "message_pinned" | "message_unpinned" }

        System Message

        -

      Returns MessagePinnedSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    ReadonlymessageId

    messageId: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    by

    message

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns MessagePinnedSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    ReadonlymessageId

    messageId: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Accessors

    by

    message

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/MessageWebhook.html b/classes/MessageWebhook.html index 8d0c34c9..788f8a02 100644 --- a/classes/MessageWebhook.html +++ b/classes/MessageWebhook.html @@ -1,5 +1,5 @@ MessageWebhook | revolt.js

    Class MessageWebhook

    Message Webhook Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    avatar? id name @@ -7,5 +7,5 @@

    Constructors

    constructor

    Properties

    Optional Readonlyavatar

    avatar?: File

    Readonlyid

    id: string

    Readonlyname

    name: string

    Accessors

    avatarURL

    On This Page

    Constructors
    Properties
    Accessors
    +
  • id: string

    • Returns MessageWebhook

    Properties

    Optional Readonlyavatar

    avatar?: File

    Readonlyid

    id: string

    Readonlyname

    name: string

    Accessors

    avatarURL

    On This Page

    Constructors
    Properties
    Accessors
    diff --git a/classes/PublicBot.html b/classes/PublicBot.html index f0b6fe8c..1b31639b 100644 --- a/classes/PublicBot.html +++ b/classes/PublicBot.html @@ -1,5 +1,5 @@ PublicBot | revolt.js

    Class PublicBot

    Public Bot Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    avatar? description? id @@ -13,8 +13,8 @@
  • Optionalavatar?: string

    Description

    Profile Avatar

  • Optionaldescription?: string

    Description

    Profile Description

  • username: string

    Description

    Bot Username

    -

    • Returns PublicBot

    Properties

    Optional Readonlyavatar

    avatar?: File

    Optional Readonlydescription

    description?: string

    Readonlyid

    id: string

    Readonlyusername

    username: string

    Methods

    addToGroup

    • addToGroup(group: string | Channel): void

      Add the bot to a group

      +

    Returns PublicBot

    Properties

    Optional Readonlyavatar

    avatar?: File

    Optional Readonlydescription

    description?: string

    Readonlyid

    id: string

    Readonlyusername

    username: string

    Methods

    addToGroup

    addToServer

    • addToServer(server: string | Server): void

      Add the bot to a server

      +

    Returns void

    addToServer

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/PublicChannelInvite.html b/classes/PublicChannelInvite.html index 861f2e87..2c4d4fb1 100644 --- a/classes/PublicChannelInvite.html +++ b/classes/PublicChannelInvite.html @@ -1,12 +1,12 @@ PublicChannelInvite | revolt.js

    Class PublicChannelInviteAbstract

    Public Channel Invite

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type

    Methods

    from

    Constructors

    constructor

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  member_count: number;
                  server_banner?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_flags?: null
                  | number;
                  server_icon?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_id: string;
                  server_name: string;
                  type: "Server";
                  user_avatar?: | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
                  user_name: string;
              }
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  type: "Group";
                  user_avatar?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  user_name: string;
              },
      ): PublicChannelInvite

      Create an Invite from an API Invite Response

      +

    Returns PublicChannelInvite

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  member_count: number;
                  server_banner?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_flags?: null
                  | number;
                  server_icon?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_id: string;
                  server_name: string;
                  type: "Server";
                  user_avatar?: | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
                  user_name: string;
              }
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  type: "Group";
                  user_avatar?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  user_name: string;
              },
      ): PublicChannelInvite

      Create an Invite from an API Invite Response

      Parameters

      • client: Client

        Client

      • invite:
            | {
                channel_description?: null
                | string;
                channel_id: string;
                channel_name: string;
                code: string;
                member_count: number;
                server_banner?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                server_flags?: null
                | number;
                server_icon?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                server_id: string;
                server_name: string;
                type: "Server";
                user_avatar?: | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
                user_name: string;
            }
            | {
                channel_description?: null
                | string;
                channel_id: string;
                channel_name: string;
                code: string;
                type: "Group";
                user_avatar?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                user_name: string;
            }

        Data

        • {
              channel_description?: null | string;
              channel_id: string;
              channel_name: string;
              code: string;
              member_count: number;
              server_banner?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              server_flags?: null
              | number;
              server_icon?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              server_id: string;
              server_name: string;
              type: "Server";
              user_avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              user_name: string;
          }
          • Optionalchannel_description?: null | string

            Description

            Description of server channel

            @@ -30,4 +30,4 @@
          • type: "Group"
          • Optionaluser_avatar?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                }

            Description

            Avatar of the user who created the invite

          • user_name: string

            Description

            Name of user who created the invite

      Returns PublicChannelInvite

      Invite

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/Server.html b/classes/Server.html index 5a4b9af4..c8ba4e0e 100644 --- a/classes/Server.html +++ b/classes/Server.html @@ -1,5 +1,5 @@ Server | revolt.js

    Class Server

    Server Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists analytics @@ -61,57 +61,57 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    analytics

    animatedIconURL

    • get animatedIconURL(): undefined | string

      URL to the server's animated icon

      -

      Returns undefined | string

    banner

    bannerURL

    • get bannerURL(): undefined | string

      URL to the server's banner

      -

      Returns undefined | string

    categories

    • get categories(): | undefined
      | { channels: string[]; id: string; title: string }[]

      Categories

      +

    Returns Server

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    analytics

    animatedIconURL

    • get animatedIconURL(): undefined | string

      URL to the server's animated icon

      +

      Returns undefined | string

    banner

    bannerURL

    • get bannerURL(): undefined | string

      URL to the server's banner

      +

      Returns undefined | string

    categories

    • get categories(): | undefined
      | { channels: string[]; id: string; title: string }[]

      Categories

      Returns undefined | { channels: string[]; id: string; title: string }[]

      • undefined
      • { channels: string[]; id: string; title: string }[]
        • channels: string[]

          Description

          Channels in this category

        • id: string

          Description

          Unique ID for this category

        • title: string

          Description

          Title for this category

          -

    channelIds

    channels

    createdAt

    defaultChannel

    defaultPermissions

    description

    discoverable

    emojis

    flags

    icon

    iconURL

    mature

    member

    mentions

    • get mentions(): string[]

      Find all message IDs of unread messages

      +

    channelIds

    channels

    createdAt

    defaultChannel

    defaultPermissions

    description

    discoverable

    emojis

    flags

    icon

    iconURL

    mature

    member

    mentions

    name

    orderedChannels

    name

    orderedChannels

    orderedRoles

    orderedRoles

    owner

    ownerId

    path

    permission

    roles

    systemMessages

    owner

    ownerId

    path

    permission

    roles

    systemMessages

    unread

    unread

    Methods

    $delete

    Methods

    $delete

    • $delete(leaveEvent?: boolean): void

      Delete the underlying server

      Parameters

      • OptionalleaveEvent: boolean

        Whether we are leaving

        -

      Returns void

    ack

    banUser

    • banUser(
          user: string | User | ServerMember,
          options?: { reason?: null | string },
      ): Promise<ServerBan>

      Ban user from this server

      +

    Returns void

    ack

    banUser

    createChannel

    • createChannel(
          data: {
              description?: null | string;
              name: string;
              nsfw?: null | boolean;
              type?: "Text" | "Voice";
          },
      ): Promise<Channel>

      Create a channel

      +

    Returns Promise<ServerBan>

    createChannel

    • createChannel(
          data: {
              description?: null | string;
              name: string;
              nsfw?: null | boolean;
              type?: "Text" | "Voice";
          },
      ): Promise<Channel>

      Create a channel

      Parameters

      • data: {
            description?: null | string;
            name: string;
            nsfw?: null | boolean;
            type?: "Text" | "Voice";
        }

        Channel create route data

        • Optionaldescription?: null | string

          Description

          Channel description

        • name: string

          Description

          Channel name

          @@ -121,18 +121,18 @@ which is smaller for higher priority roles.

      Returns Promise<Channel>

      The newly-created channel

      -

    createEmoji

    • createEmoji(
          autumnId: string,
          options: Omit<
              {
                  name: string;
                  nsfw?: boolean;
                  parent: { id: string; type: "Server" }
                  | { type: "Detached" };
              },
              "parent",
          >,
      ): Promise<Emoji>

      Create an emoji on the server

      +

    createEmoji

    • createEmoji(
          autumnId: string,
          options: Omit<
              {
                  name: string;
                  nsfw?: boolean;
                  parent: { id: string; type: "Server" }
                  | { type: "Detached" };
              },
              "parent",
          >,
      ): Promise<Emoji>

      Create an emoji on the server

      Parameters

      • autumnId: string

        Autumn Id

      • options: Omit<
            {
                name: string;
                nsfw?: boolean;
                parent: { id: string; type: "Server" }
                | { type: "Detached" };
            },
            "parent",
        >

        Options

        -

      Returns Promise<Emoji>

    createRole

    • createRole(
          name: string,
      ): Promise<
          {
              id: string;
              role: {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              };
          },
      >

      Create role

      +

    Returns Promise<Emoji>

    createRole

    • createRole(
          name: string,
      ): Promise<
          {
              id: string;
              role: {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              };
          },
      >

      Create role

      Parameters

      • name: string

        Role name

        -

      Returns Promise<
          {
              id: string;
              role: {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              };
          },
      >

    delete

    • delete(leaveSilently?: boolean): Promise<void>

      Delete or leave a server

      +

    Returns Promise<
        {
            id: string;
            role: {
                colour?: null
                | string;
                hoist?: boolean;
                name: string;
                permissions: { a: number; d: number };
                rank?: number;
            };
        },
    >

    delete

    • delete(leaveSilently?: boolean): Promise<void>

      Delete or leave a server

      Parameters

      • OptionalleaveSilently: boolean

        Whether to not send a message on leave

        -

      Returns Promise<void>

    deleteEmoji

    • deleteEmoji(emojiId: string): Promise<void>

      Delete emoji

      +

    Returns Promise<void>

    deleteEmoji

    • deleteEmoji(emojiId: string): Promise<void>

      Delete emoji

      Parameters

      • emojiId: string

        Emoji ID

        -

      Returns Promise<void>

    deleteRole

    • deleteRole(roleId: string): Promise<void>

      Delete role

      +

    Returns Promise<void>

    deleteRole

    • deleteRole(roleId: string): Promise<void>

      Delete role

      Parameters

      • roleId: string

        Role ID

        -

      Returns Promise<void>

    edit

    • edit(
          data: {
              analytics?: null | boolean;
              banner?: null | string;
              categories?: null | { channels: string[]; id: string; title: string }[];
              description?: null | string;
              discoverable?: null | boolean;
              flags?: null | number;
              icon?: null | string;
              name?: null | string;
              remove?: (
                  "Description"
                  | "Icon"
                  | "Categories"
                  | "SystemMessages"
                  | "Banner"
              )[];
              system_messages?:
                  | null
                  | {
                      user_banned?: null
                      | string;
                      user_joined?: null | string;
                      user_kicked?: null | string;
                      user_left?: null | string;
                  };
          },
      ): Promise<void>

      Edit a server

      +

    Returns Promise<void>

    edit

    • edit(
          data: {
              analytics?: null | boolean;
              banner?: null | string;
              categories?: null | { channels: string[]; id: string; title: string }[];
              description?: null | string;
              discoverable?: null | boolean;
              flags?: null | number;
              icon?: null | string;
              name?: null | string;
              remove?: (
                  "Description"
                  | "Icon"
                  | "Categories"
                  | "SystemMessages"
                  | "Banner"
              )[];
              system_messages?:
                  | null
                  | {
                      user_banned?: null
                      | string;
                      user_joined?: null | string;
                      user_kicked?: null | string;
                      user_left?: null | string;
                  };
          },
      ): Promise<void>

      Edit a server

      Parameters

      • data: {
            analytics?: null | boolean;
            banner?: null | string;
            categories?: null | { channels: string[]; id: string; title: string }[];
            description?: null | string;
            discoverable?: null | boolean;
            flags?: null | number;
            icon?: null | string;
            name?: null | string;
            remove?: (
                "Description"
                | "Icon"
                | "Categories"
                | "SystemMessages"
                | "Banner"
            )[];
            system_messages?:
                | null
                | {
                    user_banned?: null
                    | string;
                    user_joined?: null | string;
                    user_kicked?: null | string;
                    user_left?: null | string;
                };
        }

        Changes

        • Optionalanalytics?: null | boolean

          Description

          Whether analytics should be collected for this server

          Must be enabled in order to show up on Revolt Discover.

          @@ -149,7 +149,7 @@ which is smaller for higher priority roles.

        • Optionalsystem_messages?:
              | null
              | {
                  user_banned?: null
                  | string;
                  user_joined?: null | string;
                  user_kicked?: null | string;
                  user_left?: null | string;
              }

          Description

          System message configuration

          -

      Returns Promise<void>

    editRole

    • editRole(
          roleId: string,
          data: {
              colour?: null | string;
              hoist?: null | boolean;
              name?: null | string;
              rank?: null | number;
              remove?: "Colour"[];
          },
      ): Promise<ServerRole>

      Edit a role

      +

    Returns Promise<void>

    editRole

    • editRole(
          roleId: string,
          data: {
              colour?: null | string;
              hoist?: null | boolean;
              name?: null | string;
              rank?: null | number;
              remove?: "Colour"[];
          },
      ): Promise<ServerRole>

      Edit a role

      Parameters

      • roleId: string

        Role ID

      • data: {
            colour?: null | string;
            hoist?: null | boolean;
            name?: null | string;
            rank?: null | number;
            remove?: "Colour"[];
        }

        Role editing route data

        • Optionalcolour?: null | string

          Description

          Role colour

          @@ -162,44 +162,44 @@ which is smaller for higher priority roles.

          Default

          []
          -

      Returns Promise<ServerRole>

    fetchBans

    • fetchBans(): Promise<ServerBan[]>

      Fetch a server's bans

      +

    Returns Promise<ServerRole>

    fetchBans

    fetchEmojis

    fetchEmojis

    fetchInvites

    fetchInvites

    fetchMember

    fetchMember

    fetchMembers

    fetchMembers

    getMember

    getMember

    • getMember(userId: string): undefined | ServerMember

      Helper function to retrieve cached server member by their ID in this server

      Parameters

      • userId: string

        User's ID

      Returns undefined | ServerMember

      Server Member (if cached)

      -

    havePermission

    • havePermission(
          ...permission: (
              | "Video"
              | "Masquerade"
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "React"
              | "Connect"
              | "Speak"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAllSafe"
          )[],
      ): boolean

      Check whether we have a given permission in a server

      +

    havePermission

    • havePermission(
          ...permission: (
              | "Video"
              | "Masquerade"
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "React"
              | "Connect"
              | "Speak"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAllSafe"
          )[],
      ): boolean

      Check whether we have a given permission in a server

      Parameters

      • ...permission: (
            | "Video"
            | "Masquerade"
            | "ManageChannel"
            | "ManageServer"
            | "ManagePermissions"
            | "ManageRole"
            | "ManageCustomisation"
            | "KickMembers"
            | "BanMembers"
            | "TimeoutMembers"
            | "AssignRoles"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ChangeAvatar"
            | "RemoveAvatars"
            | "ViewChannel"
            | "ReadMessageHistory"
            | "SendMessage"
            | "ManageMessages"
            | "ManageWebhooks"
            | "InviteOthers"
            | "SendEmbeds"
            | "UploadFiles"
            | "React"
            | "Connect"
            | "Speak"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "MentionEveryone"
            | "MentionRoles"
            | "GrantAllSafe"
        )[]

        Permission Names

      Returns boolean

      Whether we have this permission

      -

    kickUser

    kickUser

    orPermission

    • orPermission(
          ...permission: (
              | "Video"
              | "Masquerade"
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "React"
              | "Connect"
              | "Speak"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAllSafe"
          )[],
      ): boolean

      Check whether we have at least one of the given permissions in a server

      +

    Returns Promise<void>

    orPermission

    • orPermission(
          ...permission: (
              | "Video"
              | "Masquerade"
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "React"
              | "Connect"
              | "Speak"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAllSafe"
          )[],
      ): boolean

      Check whether we have at least one of the given permissions in a server

      Parameters

      • ...permission: (
            | "Video"
            | "Masquerade"
            | "ManageChannel"
            | "ManageServer"
            | "ManagePermissions"
            | "ManageRole"
            | "ManageCustomisation"
            | "KickMembers"
            | "BanMembers"
            | "TimeoutMembers"
            | "AssignRoles"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ChangeAvatar"
            | "RemoveAvatars"
            | "ViewChannel"
            | "ReadMessageHistory"
            | "SendMessage"
            | "ManageMessages"
            | "ManageWebhooks"
            | "InviteOthers"
            | "SendEmbeds"
            | "UploadFiles"
            | "React"
            | "Connect"
            | "Speak"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "MentionEveryone"
            | "MentionRoles"
            | "GrantAllSafe"
        )[]

        Permission Names

      Returns boolean

      Whether we have one of the permissions

      -

    queryMembersExperimental

    queryMembersExperimental

    • queryMembersExperimental(
          query: string,
      ): Promise<{ members: ServerMember[]; users: User[] }>

      Query members from a server by name

      Parameters

      • query: string

        Name

      Returns Promise<{ members: ServerMember[]; users: User[] }>

      List of the server's members and their user objects

      -

    resetSyncStatus

    setPermissions

    • setPermissions(
          roleId?: string,
          permissions: number | { allow: number; deny: number },
      ): Promise<
          {
              _id: string;
              analytics?: boolean;
              banner?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              categories?: null
              | { channels: string[]; id: string; title: string }[];
              channels: string[];
              default_permissions: number;
              description?: null | string;
              discoverable?: boolean;
              flags?: number;
              icon?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              name: string;
              nsfw?: boolean;
              owner: string;
              roles?: {
                  [key: string]: {
                      colour?: null
                      | string;
                      hoist?: boolean;
                      name: string;
                      permissions: { a: number; d: number };
                      rank?: number;
                  };
              };
              system_messages?: | null
              | {
                  user_banned?: null
                  | string;
                  user_joined?: null | string;
                  user_kicked?: null | string;
                  user_left?: null | string;
              };
          },
      >

      Set role permissions

      +

    resetSyncStatus

    setPermissions

    • setPermissions(
          roleId?: string,
          permissions: number | { allow: number; deny: number },
      ): Promise<
          {
              _id: string;
              analytics?: boolean;
              banner?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              categories?: null
              | { channels: string[]; id: string; title: string }[];
              channels: string[];
              default_permissions: number;
              description?: null | string;
              discoverable?: boolean;
              flags?: number;
              icon?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              name: string;
              nsfw?: boolean;
              owner: string;
              roles?: {
                  [key: string]: {
                      colour?: null
                      | string;
                      hoist?: boolean;
                      name: string;
                      permissions: { a: number; d: number };
                      rank?: number;
                  };
              };
              system_messages?: | null
              | {
                  user_banned?: null
                  | string;
                  user_joined?: null | string;
                  user_kicked?: null | string;
                  user_left?: null | string;
              };
          },
      >

      Set role permissions

      Parameters

      • roleId: string = "default"

        Role Id, set to 'default' to affect all users

      • permissions: number | { allow: number; deny: number }

        Permission value

        • number
        • { allow: number; deny: number }
          • allow: number

            Format: uint64

            Description

            Allow bit flags

          • deny: number

            Format: uint64

            Description

            Disallow bit flags

            -

      Returns Promise<
          {
              _id: string;
              analytics?: boolean;
              banner?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              categories?: null
              | { channels: string[]; id: string; title: string }[];
              channels: string[];
              default_permissions: number;
              description?: null | string;
              discoverable?: boolean;
              flags?: number;
              icon?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              name: string;
              nsfw?: boolean;
              owner: string;
              roles?: {
                  [key: string]: {
                      colour?: null
                      | string;
                      hoist?: boolean;
                      name: string;
                      permissions: { a: number; d: number };
                      rank?: number;
                  };
              };
              system_messages?: | null
              | {
                  user_banned?: null
                  | string;
                  user_joined?: null | string;
                  user_kicked?: null | string;
                  user_left?: null | string;
              };
          },
      >

    setRoleOrdering

    • setRoleOrdering(roleIds: string[]): Promise<void>

      Set ordering of roles

      +

    Returns Promise<
        {
            _id: string;
            analytics?: boolean;
            banner?: | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
            categories?: null
            | { channels: string[]; id: string; title: string }[];
            channels: string[];
            default_permissions: number;
            description?: null | string;
            discoverable?: boolean;
            flags?: number;
            icon?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
            name: string;
            nsfw?: boolean;
            owner: string;
            roles?: {
                [key: string]: {
                    colour?: null
                    | string;
                    hoist?: boolean;
                    name: string;
                    permissions: { a: number; d: number };
                    rank?: number;
                };
            };
            system_messages?: | null
            | {
                user_banned?: null
                | string;
                user_joined?: null | string;
                user_kicked?: null | string;
                user_left?: null | string;
            };
        },
    >

    setRoleOrdering

    • setRoleOrdering(roleIds: string[]): Promise<void>

      Set ordering of roles

      Parameters

      • roleIds: string[]

        Role IDs

        -

      Returns Promise<void>

    syncMembers

    • syncMembers(excludeOffline?: boolean): Promise<void>

      Optimised member fetch route

      -

      Parameters

      • OptionalexcludeOffline: boolean

      Returns Promise<void>

    toString

    • toString(): string

      Convert to string

      +

    Returns Promise<void>

    syncMembers

    • syncMembers(excludeOffline?: boolean): Promise<void>

      Optimised member fetch route

      +

      Parameters

      • OptionalexcludeOffline: boolean

      Returns Promise<void>

    toString

    unbanUser

    unbanUser

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns Promise<void>

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ServerBan.html b/classes/ServerBan.html index ac7d0034..dfe31d73 100644 --- a/classes/ServerBan.html +++ b/classes/ServerBan.html @@ -1,5 +1,5 @@ ServerBan | revolt.js

    Class ServerBan

    Server Ban

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    client id reason? @@ -17,8 +17,8 @@
  • Optionalavatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }

    Description

    Avatar of the banned user

  • discriminator: string

    Description

    Discriminator of the banned user

  • username: string

    Description

    Username of the banned user

    -

    • Returns ServerBan

    Properties

    Protectedclient

    client: Client

    Readonlyid

    id: { server: string; user: string }

    Type declaration

    • server: string

      Description

      Server Id

      +

    Returns ServerBan

    Properties

    Protectedclient

    client: Client

    Readonlyid

    id: { server: string; user: string }

    Type declaration

    • server: string

      Description

      Server Id

    • user: string

      Description

      User Id

      -

    Optional Readonlyreason

    reason?: string

    Optional Readonlyuser

    user?: BannedUser

    Accessors

    server

    Methods

    pardon

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Optional Readonlyreason

    reason?: string

    Optional Readonlyuser

    user?: BannedUser

    Accessors

    server

    Methods

    pardon

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ServerCollection.html b/classes/ServerCollection.html index 7b289855..c64bb282 100644 --- a/classes/ServerCollection.html +++ b/classes/ServerCollection.html @@ -1,5 +1,5 @@ ServerCollection | revolt.js

    Class ServerCollection

    Collection of Servers

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -23,37 +23,37 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedServer

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServer>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Server,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns ServerCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedServer

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServer>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Server,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: Server

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    createServer

    • createServer(
          data: {
              description?: null | string;
              name: string;
              nsfw?: null | boolean;
          },
      ): Promise<Server>

      Create a server

      +

    Returns void

    createServer

    delete

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns Server[]

    find

    forEach

    Returns undefined | Server

    forEach

    get

    get

    getOrCreate

    getOrCreate

    getOrPartial

    Returns Server

    getOrPartial

    has

    Returns undefined | Server

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ServerInvite.html b/classes/ServerInvite.html index 68c093ab..2a2989ed 100644 --- a/classes/ServerInvite.html +++ b/classes/ServerInvite.html @@ -1,5 +1,5 @@ ServerInvite | revolt.js

    Class ServerInvite

    Server Invite

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    channelId client? creatorId @@ -21,11 +21,11 @@
  • type: "Server"
  • { _id: string; channel: string; creator: string; type: "Group" }
    • _id: string

      Description

      Invite code

    • channel: string

      Description

      Id of the group channel this invite points to

    • creator: string

      Description

      Id of user who created this invite

      -
    • type: "Group"
    • type: "Server"

    Returns ServerInvite

    Properties

    ReadonlychannelId

    channelId: string

    Protected Optionalclient

    client?: Client

    ReadonlycreatorId

    creatorId: string

    Readonlyid

    id: string

    ReadonlyserverId

    serverId: string

    Readonlytype

    type: "Group" | "Server" | "None"

    Accessors

    channel

    creator

    server

    Methods

    delete

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  _id: string;
                  channel: string;
                  creator: string;
                  server: string;
                  type: "Server";
              }
              | { _id: string; channel: string; creator: string; type: "Group" },
      ): ChannelInvite

      Create an Invite from an API Invite

      +
    • type: "Group"
    • type: "Server"

    Returns ServerInvite

    Properties

    ReadonlychannelId

    channelId: string

    Protected Optionalclient

    client?: Client

    ReadonlycreatorId

    creatorId: string

    Readonlyid

    id: string

    ReadonlyserverId

    serverId: string

    Readonlytype

    type: "Group" | "Server" | "None"

    Accessors

    channel

    creator

    server

    Methods

    delete

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  _id: string;
                  channel: string;
                  creator: string;
                  server: string;
                  type: "Server";
              }
              | { _id: string; channel: string; creator: string; type: "Group" },
      ): ChannelInvite

      Create an Invite from an API Invite

      Parameters

      • client: Client

        Client

      • invite:
            | {
                _id: string;
                channel: string;
                creator: string;
                server: string;
                type: "Server";
            }
            | { _id: string; channel: string; creator: string; type: "Group" }

        Data

        • {
              _id: string;
              channel: string;
              creator: string;
              server: string;
              type: "Server";
          }
          • _id: string

            Description

            Invite code

            @@ -36,4 +36,4 @@
          • channel: string

            Description

            Id of the group channel this invite points to

          • creator: string

            Description

            Id of user who created this invite

          • type: "Group"

      Returns ChannelInvite

      Invite

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ServerMember.html b/classes/ServerMember.html index fb0aa6e3..09fda16e 100644 --- a/classes/ServerMember.html +++ b/classes/ServerMember.html @@ -1,5 +1,5 @@ ServerMember | revolt.js

    Class ServerMember

    Server Member Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists animatedAvatarURL @@ -28,28 +28,28 @@
  • id: { server: string; user: string }

    Id

    • server: string

      Description

      Server Id

    • user: string

      Description

      User Id

      -

    • Returns ServerMember

    Properties

    Readonlyid

    id: { server: string; user: string }

    Type declaration

    • server: string

      Description

      Server Id

      +

    Returns ServerMember

    Properties

    Readonlyid

    id: { server: string; user: string }

    Type declaration

    • server: string

      Description

      Server Id

    • user: string

      Description

      User Id

      -

    Accessors

    $exists

    animatedAvatarURL

    avatar

    avatarURL

    displayName

    hoistedRole

    • get hoistedRole(): | null
      | Partial<
          {
              colour?: null
              | string;
              hoist?: boolean;
              name: string;
              permissions: { a: number; d: number };
              rank?: number;
          },
      >

      Member's currently hoisted role.

      -

      Returns
          | null
          | Partial<
              {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              },
          >

    joinedAt

    nickname

    orderedRoles

    • get orderedRoles(): (
          Partial<
              {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              },
          > & { id: string }
      )[]

      Ordered list of roles for this member, from lowest to highest priority.

      -

      Returns (
          Partial<
              {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              },
          > & { id: string }
      )[]

    ranking

    • get ranking(): number

      Member's ranking +

    Accessors

    $exists

    animatedAvatarURL

    avatar

    avatarURL

    displayName

    hoistedRole

    • get hoistedRole(): | null
      | Partial<
          {
              colour?: null
              | string;
              hoist?: boolean;
              name: string;
              permissions: { a: number; d: number };
              rank?: number;
          },
      >

      Member's currently hoisted role.

      +

      Returns
          | null
          | Partial<
              {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              },
          >

    joinedAt

    nickname

    orderedRoles

    • get orderedRoles(): (
          Partial<
              {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              },
          > & { id: string }
      )[]

      Ordered list of roles for this member, from lowest to highest priority.

      +

      Returns (
          Partial<
              {
                  colour?: null
                  | string;
                  hoist?: boolean;
                  name: string;
                  permissions: { a: number; d: number };
                  rank?: number;
              },
          > & { id: string }
      )[]

    ranking

    roleColour

    roles

    server

    timeout

    user

    Methods

    ban

    roleColour

    roles

    server

    timeout

    user

    Methods

    ban

    • ban(options: { reason?: null | string }): Promise<void>

      Ban this member from the server

      Parameters

      • options: { reason?: null | string }

        Ban options

        • Optionalreason?: null | string

          Description

          Ban reason

          -

      Returns Promise<void>

    edit

    • edit(
          data: {
              avatar?: null | string;
              nickname?: null | string;
              remove?: ("Avatar" | "Nickname" | "Roles" | "Timeout")[];
              roles?: null | string[];
              timeout?: null | string;
          },
      ): Promise<void>

      Edit a member

      +

    Returns Promise<void>

    edit

    • edit(
          data: {
              avatar?: null | string;
              nickname?: null | string;
              remove?: ("Avatar" | "Nickname" | "Roles" | "Timeout")[];
              roles?: null | string[];
              timeout?: null | string;
          },
      ): Promise<void>

      Edit a member

      Parameters

      • data: {
            avatar?: null | string;
            nickname?: null | string;
            remove?: ("Avatar" | "Nickname" | "Roles" | "Timeout")[];
            roles?: null | string[];
            timeout?: null | string;
        }

        Changes

        • Optionalavatar?: null | string

          Description

          Attachment Id to set for avatar

        • Optionalnickname?: null | string

          Description

          Member nickname

          @@ -59,17 +59,17 @@ Smaller values are ranked as higher priority

        • Optionalroles?: null | string[]

          Description

          Array of role ids

        • Optionaltimeout?: null | string

          Description

          Timestamp this member is timed out until

          -

      Returns Promise<void>

    getPermissions

    • getPermissions(target: Channel | Server): number

      Get the permissions that this member has against a certain object

      +

    Returns Promise<void>

    getPermissions

    hasPermission

    • hasPermission(
          target: Channel | Server,
          ...permission: (
              | "Video"
              | "Masquerade"
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "React"
              | "Connect"
              | "Speak"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAllSafe"
          )[],
      ): boolean

      Check whether a member has a certain permission against a certain object

      +

    hasPermission

    • hasPermission(
          target: Channel | Server,
          ...permission: (
              | "Video"
              | "Masquerade"
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "React"
              | "Connect"
              | "Speak"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAllSafe"
          )[],
      ): boolean

      Check whether a member has a certain permission against a certain object

      Parameters

      • target: Channel | Server

        Target object to check permissions against

      • ...permission: (
            | "Video"
            | "Masquerade"
            | "ManageChannel"
            | "ManageServer"
            | "ManagePermissions"
            | "ManageRole"
            | "ManageCustomisation"
            | "KickMembers"
            | "BanMembers"
            | "TimeoutMembers"
            | "AssignRoles"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ChangeAvatar"
            | "RemoveAvatars"
            | "ViewChannel"
            | "ReadMessageHistory"
            | "SendMessage"
            | "ManageMessages"
            | "ManageWebhooks"
            | "InviteOthers"
            | "SendEmbeds"
            | "UploadFiles"
            | "React"
            | "Connect"
            | "Speak"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "MentionEveryone"
            | "MentionRoles"
            | "GrantAllSafe"
        )[]

        Permission names to check for

      Returns boolean

      Whether the member has this permission

      -

    inferiorTo

    inferiorTo

    kick

    toString

    kick

    toString

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ServerMemberCollection.html b/classes/ServerMemberCollection.html index 9774bac2..cb404a9d 100644 --- a/classes/ServerMemberCollection.html +++ b/classes/ServerMemberCollection.html @@ -1,5 +1,5 @@ ServerMemberCollection | revolt.js

    Class ServerMemberCollection

    Collection of Server Members

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -25,36 +25,36 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedServerMember

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServerMember>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: ServerMember,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns ServerMemberCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedServerMember

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedServerMember>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: ServerMember,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: ServerMember

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns ServerMember[]

    find

    forEach

    Returns undefined | ServerMember

    forEach

    get

    get

    getByKey

    getByKey

    getOrCreate

    getOrCreate

    getOrPartial

    Returns ServerMember

    getOrPartial

    has

    Returns undefined | ServerMember

    has

    hasByKey

    hasByKey

    isPartial

    isPartial

    isPartialByKey

    isPartialByKey

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/ServerPublicInvite.html b/classes/ServerPublicInvite.html index 2f043e4b..f332ddac 100644 --- a/classes/ServerPublicInvite.html +++ b/classes/ServerPublicInvite.html @@ -1,5 +1,5 @@ ServerPublicInvite | revolt.js

    Class ServerPublicInvite

    Public Server Invite

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    channelDescription? channelId channelName @@ -40,9 +40,9 @@
  • code: string

    Description

    Invite code

  • type: "Group"
  • Optionaluser_avatar?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }

    Description

    Avatar of the user who created the invite

  • user_name: string

    Description

    Name of user who created the invite

    -
    • type: "Server"

    Returns ServerPublicInvite

    Properties

    Optional ReadonlychannelDescription

    channelDescription?: string

    ReadonlychannelId

    channelId: string

    ReadonlychannelName

    channelName: string

    Protected Optionalclient

    client?: Client

    Readonlycode

    code: string

    ReadonlymemberCount

    memberCount: number

    Optional ReadonlyserverBanner

    serverBanner?: File

    ReadonlyserverFlags

    serverFlags: ServerFlags

    Optional ReadonlyserverIcon

    serverIcon?: File

    ReadonlyserverId

    serverId: string

    ReadonlyserverName

    serverName: string

    Readonlytype

    type: "Group" | "Server" | "None"

    Optional ReadonlyuserAvatar

    userAvatar?: File

    ReadonlyuserName

    userName: string

    Accessors

    server

    Methods

    join

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  member_count: number;
                  server_banner?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_flags?: null
                  | number;
                  server_icon?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_id: string;
                  server_name: string;
                  type: "Server";
                  user_avatar?: | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
                  user_name: string;
              }
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  type: "Group";
                  user_avatar?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  user_name: string;
              },
      ): PublicChannelInvite

      Create an Invite from an API Invite Response

      +
    • type: "Server"

    Returns ServerPublicInvite

    Properties

    Optional ReadonlychannelDescription

    channelDescription?: string

    ReadonlychannelId

    channelId: string

    ReadonlychannelName

    channelName: string

    Protected Optionalclient

    client?: Client

    Readonlycode

    code: string

    ReadonlymemberCount

    memberCount: number

    Optional ReadonlyserverBanner

    serverBanner?: File

    ReadonlyserverFlags

    serverFlags: ServerFlags

    Optional ReadonlyserverIcon

    serverIcon?: File

    ReadonlyserverId

    serverId: string

    ReadonlyserverName

    serverName: string

    Readonlytype

    type: "Group" | "Server" | "None"

    Optional ReadonlyuserAvatar

    userAvatar?: File

    ReadonlyuserName

    userName: string

    Accessors

    server

    Methods

    join

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  member_count: number;
                  server_banner?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_flags?: null
                  | number;
                  server_icon?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_id: string;
                  server_name: string;
                  type: "Server";
                  user_avatar?: | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
                  user_name: string;
              }
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  type: "Group";
                  user_avatar?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  user_name: string;
              },
      ): PublicChannelInvite

      Create an Invite from an API Invite Response

      Parameters

      • client: Client

        Client

      • invite:
            | {
                channel_description?: null
                | string;
                channel_id: string;
                channel_name: string;
                code: string;
                member_count: number;
                server_banner?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                server_flags?: null
                | number;
                server_icon?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                server_id: string;
                server_name: string;
                type: "Server";
                user_avatar?: | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
                user_name: string;
            }
            | {
                channel_description?: null
                | string;
                channel_id: string;
                channel_name: string;
                code: string;
                type: "Group";
                user_avatar?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                user_name: string;
            }

        Data

        • {
              channel_description?: null | string;
              channel_id: string;
              channel_name: string;
              code: string;
              member_count: number;
              server_banner?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              server_flags?: null
              | number;
              server_icon?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              server_id: string;
              server_name: string;
              type: "Server";
              user_avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              user_name: string;
          }
          • Optionalchannel_description?: null | string

            Description

            Description of server channel

            @@ -66,4 +66,4 @@
          • type: "Group"
          • Optionaluser_avatar?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                }

            Description

            Avatar of the user who created the invite

          • user_name: string

            Description

            Name of user who created the invite

      Returns PublicChannelInvite

      Invite

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/ServerRole.html b/classes/ServerRole.html index e33e370b..7a7f866c 100644 --- a/classes/ServerRole.html +++ b/classes/ServerRole.html @@ -1,5 +1,5 @@ ServerRole | revolt.js

    Class ServerRole

    Server Role

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    client colour? hoist @@ -29,11 +29,11 @@

    Default

    0
    -

    Returns ServerRole

    Properties

    Protectedclient

    client: Client

    Optional Readonlycolour

    colour?: string

    Readonlyhoist

    hoist: boolean

    Readonlyid

    id: string

    Readonlyname

    name: string

    Readonlypermissions

    permissions: { a: number; d: number }

    Type declaration

    • a: number

      Format: int64

      +

    Returns ServerRole

    Properties

    Protectedclient

    client: Client

    Optional Readonlycolour

    colour?: string

    Readonlyhoist

    hoist: boolean

    Readonlyid

    id: string

    Readonlyname

    name: string

    Readonlypermissions

    permissions: { a: number; d: number }

    Type declaration

    • a: number

      Format: int64

      Description

      Allow bit flags

    • d: number

      Format: int64

      Description

      Disallow bit flags

      -

    Readonlyrank

    rank: number

    ProtectedserverId

    serverId: string

    Accessors

    assigned

    Methods

    toString

    • toString(): string

      Write to string as a role mention

      +

    Readonlyrank

    rank: number

    ProtectedserverId

    serverId: string

    Accessors

    assigned

    Methods

    toString

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/Session.html b/classes/Session.html index aec2685d..475b68c0 100644 --- a/classes/Session.html +++ b/classes/Session.html @@ -1,5 +1,5 @@ Session | revolt.js

    Class Session

    Session Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists createdAt @@ -11,13 +11,13 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    createdAt

    current

    name

    Methods

    delete

    rename

    • rename(name: string): Promise<void>

      Rename a session

      +

    Returns Session

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    createdAt

    current

    name

    Methods

    delete

    rename

    • rename(name: string): Promise<void>

      Rename a session

      Parameters

      • name: string

        New name

        -

      Returns Promise<void>

    toString

    • toString(): string

      Convert to string

      +

    Returns Promise<void>

    toString

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/SessionCollection.html b/classes/SessionCollection.html index bdc3aecf..84872afa 100644 --- a/classes/SessionCollection.html +++ b/classes/SessionCollection.html @@ -1,5 +1,5 @@ SessionCollection | revolt.js

    Class SessionCollection

    Collection of Sessions

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -22,48 +22,48 @@ values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedSession

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedSession>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Session,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

    Returns SessionCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedSession

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedSession>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: Session,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: Session

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    deleteAll

    Returns void

    deleteAll

    entries

    Returns Promise<void>

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns Session[]

    find

    forEach

    Returns undefined | Session

    forEach

    get

    get

    getOrCreate

    getOrCreate

    has

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/StoreCollection.html b/classes/StoreCollection.html index 65f06b97..48be03eb 100644 --- a/classes/StoreCollection.html +++ b/classes/StoreCollection.html @@ -1,5 +1,5 @@ StoreCollection | revolt.js

    Class StoreCollection<T, V>Abstract

    Collection backed by a Solid.js Store

    -

    Type Parameters

    • T
    • V

    Hierarchy (View Summary)

    Constructors

    constructor +

    Type Parameters

    • T
    • V

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    getUnderlyingObject updateUnderlyingObject

    Methods

    create @@ -17,40 +17,40 @@ toList values

    Constructors

    constructor

    Properties

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => V

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, V>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: T,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

      Type Parameters

      • T
      • V

      Returns StoreCollection<T, V>

    Properties

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => V

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, V>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: T,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: T

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    filter

    filter

    find

    Returns T[]

    find

    forEach

    Returns undefined | T

    forEach

    get

    get

    has

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/SystemMessage.html b/classes/SystemMessage.html index a5d19058..32156e9c 100644 --- a/classes/SystemMessage.html +++ b/classes/SystemMessage.html @@ -1,12 +1,12 @@ SystemMessage | revolt.js

    Class SystemMessageAbstract

    System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type

    Methods

    from

    Constructors

    constructor

    • new SystemMessage(
          client: Client,
          type:
              | "text"
              | "user_added"
              | "user_remove"
              | "user_joined"
              | "user_left"
              | "user_kicked"
              | "user_banned"
              | "channel_renamed"
              | "channel_description_changed"
              | "channel_icon_changed"
              | "channel_ownership_changed"
              | "message_pinned"
              | "message_unpinned",
      ): SystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • type:
            | "text"
            | "user_added"
            | "user_remove"
            | "user_joined"
            | "user_left"
            | "user_kicked"
            | "user_banned"
            | "channel_renamed"
            | "channel_description_changed"
            | "channel_icon_changed"
            | "channel_ownership_changed"
            | "message_pinned"
            | "message_unpinned"

        Type

        -

      Returns SystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns SystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/TextEmbed.html b/classes/TextEmbed.html index 1a636750..bf7a1ec4 100644 --- a/classes/TextEmbed.html +++ b/classes/TextEmbed.html @@ -1,5 +1,5 @@ TextEmbed | revolt.js

    Class TextEmbed

    Text Embed

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? colour? description? @@ -13,8 +13,8 @@

    Constructors

    constructor

    • new TextEmbed(
          client: Client,
          embed: Omit<
              (
                  | {
                      colour?: null
                      | string;
                      description?: null | string;
                      icon_url?: null | string;
                      image?:
                          | null
                          | {
                              height: number;
                              size: "Large"
                              | "Preview";
                              url: string;
                              width: number;
                          };
                      original_url?: null
                      | string;
                      site_name?: null | string;
                      special?:
                          | null
                          | { type: "None" }
                          | { type: "GIF" }
                          | { id: string; timestamp?: null | string; type: "YouTube" }
                          | { content_type: "Channel"; id: string; type: "Lightspeed" }
                          | {
                              content_type: "Video" | "Channel" | "Clip";
                              id: string;
                              type: "Twitch";
                          }
                          | { content_type: string; id: string; type: "Spotify" }
                          | { type: "Soundcloud" }
                          | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                          | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                          | { id: string; type: "Streamable" };
                      title?: null | string;
                      type: "Website";
                      url?: null | string;
                      video?: null | { height: number; url: string; width: number };
                  }
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      type: "Image";
                      url: string;
                      width: number;
                  }
                  | { height: number; type: "Video"; url: string; width: number }
                  | {
                      colour?: null | string;
                      description?: null | string;
                      icon_url?: null | string;
                      media?:
                          | null
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: null
                              | boolean;
                              filename: string;
                              message_id?: null | string;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: null | string;
                              reported?: null | boolean;
                              server_id?: null | string;
                              size: number;
                              tag: string;
                              user_id?: null | string;
                          };
                      title?: null
                      | string;
                      type: "Text";
                      url?: null | string;
                  }
                  | { type: "None" }
              ) & { type: "Text" },
              "type",
          >,
      ): TextEmbed

      Construct Video Embed

      Parameters

      • client: Client

        Client

      • embed: Omit<
            (
                | {
                    colour?: null
                    | string;
                    description?: null | string;
                    icon_url?: null | string;
                    image?:
                        | null
                        | {
                            height: number;
                            size: "Large"
                            | "Preview";
                            url: string;
                            width: number;
                        };
                    original_url?: null
                    | string;
                    site_name?: null | string;
                    special?:
                        | null
                        | { type: "None" }
                        | { type: "GIF" }
                        | { id: string; timestamp?: null | string; type: "YouTube" }
                        | { content_type: "Channel"; id: string; type: "Lightspeed" }
                        | {
                            content_type: "Video" | "Channel" | "Clip";
                            id: string;
                            type: "Twitch";
                        }
                        | { content_type: string; id: string; type: "Spotify" }
                        | { type: "Soundcloud" }
                        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                        | { id: string; type: "Streamable" };
                    title?: null | string;
                    type: "Website";
                    url?: null | string;
                    video?: null | { height: number; url: string; width: number };
                }
                | {
                    height: number;
                    size: "Large"
                    | "Preview";
                    type: "Image";
                    url: string;
                    width: number;
                }
                | { height: number; type: "Video"; url: string; width: number }
                | {
                    colour?: null | string;
                    description?: null | string;
                    icon_url?: null | string;
                    media?:
                        | null
                        | {
                            _id: string;
                            content_type: string;
                            deleted?: null
                            | boolean;
                            filename: string;
                            message_id?: null | string;
                            metadata:
                                | { type: "File" }
                                | { type: "Text" }
                                | { height: number; type: "Image"; width: number }
                                | { height: number; type: "Video"; width: number }
                                | { type: "Audio" };
                            object_id?: null | string;
                            reported?: null | boolean;
                            server_id?: null | string;
                            size: number;
                            tag: string;
                            user_id?: null | string;
                        };
                    title?: null
                    | string;
                    type: "Text";
                    url?: null | string;
                }
                | { type: "None" }
            ) & { type: "Text" },
            "type",
        >

        Embed

        -

      Returns TextEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Optional Readonlycolour

    colour?: string

    Optional Readonlydescription

    description?: string

    Optional ReadonlyiconUrl

    iconUrl?: string

    Optional Readonlymedia

    media?: File

    Optional Readonlytitle

    title?: string

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Optional Readonlyurl

    url?: string

    Accessors

    proxiedIconURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      +

    Returns TextEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Optional Readonlycolour

    colour?: string

    Optional Readonlydescription

    description?: string

    Optional ReadonlyiconUrl

    iconUrl?: string

    Optional Readonlymedia

    media?: File

    Optional Readonlytitle

    title?: string

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Optional Readonlyurl

    url?: string

    Accessors

    proxiedIconURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      Parameters

      • client: Client

        Client

      • embed:
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                image?:
                    | null
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        url: string;
                        width: number;
                    };
                original_url?: null
                | string;
                site_name?: null | string;
                special?:
                    | null
                    | { type: "None" }
                    | { type: "GIF" }
                    | { id: string; timestamp?: null | string; type: "YouTube" }
                    | { content_type: "Channel"; id: string; type: "Lightspeed" }
                    | {
                        content_type: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { id: string; type: "Streamable" };
                title?: null | string;
                type: "Website";
                url?: null | string;
                video?: null | { height: number; url: string; width: number };
            }
            | {
                height: number;
                size: "Large"
                | "Preview";
                type: "Image";
                url: string;
                width: number;
            }
            | { height: number; type: "Video"; url: string; width: number }
            | {
                colour?: null | string;
                description?: null | string;
                icon_url?: null | string;
                media?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                title?: null
                | string;
                type: "Text";
                url?: null | string;
            }
            | { type: "None" }

        Data

        • {
              colour?: null | string;
              description?: null | string;
              icon_url?: null | string;
              image?:
                  | null
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      url: string;
                      width: number;
                  };
              original_url?: null
              | string;
              site_name?: null | string;
              special?:
                  | null
                  | { type: "None" }
                  | { type: "GIF" }
                  | { id: string; timestamp?: null | string; type: "YouTube" }
                  | { content_type: "Channel"; id: string; type: "Lightspeed" }
                  | {
                      content_type: "Video" | "Channel" | "Clip";
                      id: string;
                      type: "Twitch";
                  }
                  | { content_type: string; id: string; type: "Spotify" }
                  | { type: "Soundcloud" }
                  | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                  | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                  | { id: string; type: "Streamable" };
              title?: null | string;
              type: "Website";
              url?: null | string;
              video?: null | { height: number; url: string; width: number };
          }
          • Optionalcolour?: null | string

            Description

            CSS Colour

            @@ -45,4 +45,4 @@
          • Optionaltitle?: null | string

            Description

            Title of text embed

          • type: "Text"
          • Optionalurl?: null | string

            Description

            URL for title

        • { type: "None" }

      Returns MessageEmbed

      Embed

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/TextSystemMessage.html b/classes/TextSystemMessage.html index 106eb9fb..c5d295a9 100644 --- a/classes/TextSystemMessage.html +++ b/classes/TextSystemMessage.html @@ -1,5 +1,5 @@ TextSystemMessage | revolt.js

    Class TextSystemMessage

    Text System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? content type @@ -7,7 +7,7 @@

    Constructors

    constructor

    • new TextSystemMessage(
          client: Client,
          systemMessage: (
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" }
          ) & { type: "text" },
      ): TextSystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • systemMessage: (
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }
        ) & { type: "text" }

        System Message

        -

      Returns TextSystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    Readonlycontent

    content: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns TextSystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    Readonlycontent

    content: string

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/UnknownEmbed.html b/classes/UnknownEmbed.html index d7583ca2..88380065 100644 --- a/classes/UnknownEmbed.html +++ b/classes/UnknownEmbed.html @@ -1,12 +1,12 @@ UnknownEmbed | revolt.js

    Class UnknownEmbed

    Embed of unknown type

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type

    Methods

    from

    Constructors

    constructor

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      +

    Returns UnknownEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      Parameters

      • client: Client

        Client

      • embed:
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                image?:
                    | null
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        url: string;
                        width: number;
                    };
                original_url?: null
                | string;
                site_name?: null | string;
                special?:
                    | null
                    | { type: "None" }
                    | { type: "GIF" }
                    | { id: string; timestamp?: null | string; type: "YouTube" }
                    | { content_type: "Channel"; id: string; type: "Lightspeed" }
                    | {
                        content_type: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { id: string; type: "Streamable" };
                title?: null | string;
                type: "Website";
                url?: null | string;
                video?: null | { height: number; url: string; width: number };
            }
            | {
                height: number;
                size: "Large"
                | "Preview";
                type: "Image";
                url: string;
                width: number;
            }
            | { height: number; type: "Video"; url: string; width: number }
            | {
                colour?: null | string;
                description?: null | string;
                icon_url?: null | string;
                media?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                title?: null
                | string;
                type: "Text";
                url?: null | string;
            }
            | { type: "None" }

        Data

        • {
              colour?: null | string;
              description?: null | string;
              icon_url?: null | string;
              image?:
                  | null
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      url: string;
                      width: number;
                  };
              original_url?: null
              | string;
              site_name?: null | string;
              special?:
                  | null
                  | { type: "None" }
                  | { type: "GIF" }
                  | { id: string; timestamp?: null | string; type: "YouTube" }
                  | { content_type: "Channel"; id: string; type: "Lightspeed" }
                  | {
                      content_type: "Video" | "Channel" | "Clip";
                      id: string;
                      type: "Twitch";
                  }
                  | { content_type: string; id: string; type: "Spotify" }
                  | { type: "Soundcloud" }
                  | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                  | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                  | { id: string; type: "Streamable" };
              title?: null | string;
              type: "Website";
              url?: null | string;
              video?: null | { height: number; url: string; width: number };
          }
          • Optionalcolour?: null | string

            Description

            CSS Colour

            @@ -37,4 +37,4 @@
          • Optionaltitle?: null | string

            Description

            Title of text embed

          • type: "Text"
          • Optionalurl?: null | string

            Description

            URL for title

        • { type: "None" }

      Returns MessageEmbed

      Embed

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/UnknownInvite.html b/classes/UnknownInvite.html index 0302c688..16b26926 100644 --- a/classes/UnknownInvite.html +++ b/classes/UnknownInvite.html @@ -1,12 +1,12 @@ UnknownInvite | revolt.js

    Class UnknownInvite

    Invite of unknown type

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type

    Methods

    from

    Constructors

    constructor

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  _id: string;
                  channel: string;
                  creator: string;
                  server: string;
                  type: "Server";
              }
              | { _id: string; channel: string; creator: string; type: "Group" },
      ): ChannelInvite

      Create an Invite from an API Invite

      +

    Returns UnknownInvite

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  _id: string;
                  channel: string;
                  creator: string;
                  server: string;
                  type: "Server";
              }
              | { _id: string; channel: string; creator: string; type: "Group" },
      ): ChannelInvite

      Create an Invite from an API Invite

      Parameters

      • client: Client

        Client

      • invite:
            | {
                _id: string;
                channel: string;
                creator: string;
                server: string;
                type: "Server";
            }
            | { _id: string; channel: string; creator: string; type: "Group" }

        Data

        • {
              _id: string;
              channel: string;
              creator: string;
              server: string;
              type: "Server";
          }
          • _id: string

            Description

            Invite code

            @@ -17,4 +17,4 @@
          • channel: string

            Description

            Id of the group channel this invite points to

          • creator: string

            Description

            Id of user who created this invite

          • type: "Group"

      Returns ChannelInvite

      Invite

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/UnknownPublicInvite.html b/classes/UnknownPublicInvite.html index 9f035099..2624af60 100644 --- a/classes/UnknownPublicInvite.html +++ b/classes/UnknownPublicInvite.html @@ -1,12 +1,12 @@ UnknownPublicInvite | revolt.js

    Class UnknownPublicInvite

    Public invite of unknown type

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type

    Methods

    from

    Constructors

    constructor

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  member_count: number;
                  server_banner?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_flags?: null
                  | number;
                  server_icon?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_id: string;
                  server_name: string;
                  type: "Server";
                  user_avatar?: | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
                  user_name: string;
              }
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  type: "Group";
                  user_avatar?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  user_name: string;
              },
      ): PublicChannelInvite

      Create an Invite from an API Invite Response

      +

    Returns UnknownPublicInvite

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type: "Group" | "Server" | "None"

    Methods

    Staticfrom

    • from(
          client: Client,
          invite:
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  member_count: number;
                  server_banner?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_flags?: null
                  | number;
                  server_icon?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  server_id: string;
                  server_name: string;
                  type: "Server";
                  user_avatar?: | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
                  user_name: string;
              }
              | {
                  channel_description?: null
                  | string;
                  channel_id: string;
                  channel_name: string;
                  code: string;
                  type: "Group";
                  user_avatar?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  user_name: string;
              },
      ): PublicChannelInvite

      Create an Invite from an API Invite Response

      Parameters

      • client: Client

        Client

      • invite:
            | {
                channel_description?: null
                | string;
                channel_id: string;
                channel_name: string;
                code: string;
                member_count: number;
                server_banner?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                server_flags?: null
                | number;
                server_icon?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                server_id: string;
                server_name: string;
                type: "Server";
                user_avatar?: | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
                user_name: string;
            }
            | {
                channel_description?: null
                | string;
                channel_id: string;
                channel_name: string;
                code: string;
                type: "Group";
                user_avatar?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                user_name: string;
            }

        Data

        • {
              channel_description?: null | string;
              channel_id: string;
              channel_name: string;
              code: string;
              member_count: number;
              server_banner?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              server_flags?: null
              | number;
              server_icon?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              server_id: string;
              server_name: string;
              type: "Server";
              user_avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              user_name: string;
          }
          • Optionalchannel_description?: null | string

            Description

            Description of server channel

            @@ -30,4 +30,4 @@
          • type: "Group"
          • Optionaluser_avatar?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                }

            Description

            Avatar of the user who created the invite

          • user_name: string

            Description

            Name of user who created the invite

      Returns PublicChannelInvite

      Invite

      -

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/User.html b/classes/User.html index 52c29dc6..6ef117d4 100644 --- a/classes/User.html +++ b/classes/User.html @@ -1,5 +1,5 @@ User | revolt.js

    Class User

    User Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    id

    Accessors

    $exists animatedAvatarURL @@ -34,31 +34,31 @@

    Constructors

    constructor

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    animatedAvatarURL

    avatar

    avatarURL

    badges

    bot

    • get bot(): undefined | { owner: string }

      Bot information

      -

      Returns undefined | { owner: string }

    createdAt

    defaultAvatarURL

    discriminator

    displayName

    flags

    online

    permission

    presence

    • get presence(): "Online" | "Idle" | "Focus" | "Busy" | "Invisible"

      Presence

      -

      Returns "Online" | "Idle" | "Focus" | "Busy" | "Invisible"

    privileged

    relationship

    self

    status

    • get status(): | undefined
      | {
          presence?: null
          | "Online"
          | "Idle"
          | "Focus"
          | "Busy"
          | "Invisible";
          text?: null | string;
      }

      User Status

      -

      Returns
          | undefined
          | {
              presence?: null
              | "Online"
              | "Idle"
              | "Focus"
              | "Busy"
              | "Invisible";
              text?: null | string;
          }

    username

    Methods

    addFriend

    blockUser

    changeUsername

    • changeUsername(
          username: string,
          password: string,
      ): Promise<
          {
              _id: string;
              avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              badges?: number;
              bot?: null
              | { owner: string };
              discriminator: string;
              display_name?: null | string;
              flags?: number;
              online: boolean;
              privileged?: boolean;
              relations?: {
                  _id: string;
                  status:
                      | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
              }[];
              relationship: | "User"
              | "None"
              | "Friend"
              | "Outgoing"
              | "Incoming"
              | "Blocked"
              | "BlockedOther";
              status?: | null
              | {
                  presence?: null
                  | "Online"
                  | "Idle"
                  | "Focus"
                  | "Busy"
                  | "Invisible";
                  text?: null | string;
              };
              username: string;
          },
      >

      Change the username of the current user

      +

    Returns User

    Properties

    Readonlyid

    id: string

    Accessors

    $exists

    animatedAvatarURL

    avatar

    avatarURL

    badges

    bot

    • get bot(): undefined | { owner: string }

      Bot information

      +

      Returns undefined | { owner: string }

    createdAt

    defaultAvatarURL

    discriminator

    displayName

    flags

    online

    permission

    presence

    • get presence(): "Online" | "Idle" | "Focus" | "Busy" | "Invisible"

      Presence

      +

      Returns "Online" | "Idle" | "Focus" | "Busy" | "Invisible"

    privileged

    relationship

    self

    status

    • get status(): | undefined
      | {
          presence?: null
          | "Online"
          | "Idle"
          | "Focus"
          | "Busy"
          | "Invisible";
          text?: null | string;
      }

      User Status

      +

      Returns
          | undefined
          | {
              presence?: null
              | "Online"
              | "Idle"
              | "Focus"
              | "Busy"
              | "Invisible";
              text?: null | string;
          }

    username

    Methods

    addFriend

    blockUser

    changeUsername

    • changeUsername(
          username: string,
          password: string,
      ): Promise<
          {
              _id: string;
              avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              badges?: number;
              bot?: null
              | { owner: string };
              discriminator: string;
              display_name?: null | string;
              flags?: number;
              online: boolean;
              privileged?: boolean;
              relations?: {
                  _id: string;
                  status:
                      | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
              }[];
              relationship: | "User"
              | "None"
              | "Friend"
              | "Outgoing"
              | "Incoming"
              | "Blocked"
              | "BlockedOther";
              status?: | null
              | {
                  presence?: null
                  | "Online"
                  | "Idle"
                  | "Focus"
                  | "Busy"
                  | "Invisible";
                  text?: null | string;
              };
              username: string;
          },
      >

      Change the username of the current user

      Parameters

      • username: string

        New username

      • password: string

        Current password

        -

      Returns Promise<
          {
              _id: string;
              avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              badges?: number;
              bot?: null
              | { owner: string };
              discriminator: string;
              display_name?: null | string;
              flags?: number;
              online: boolean;
              privileged?: boolean;
              relations?: {
                  _id: string;
                  status:
                      | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
              }[];
              relationship: | "User"
              | "None"
              | "Friend"
              | "Outgoing"
              | "Incoming"
              | "Blocked"
              | "BlockedOther";
              status?: | null
              | {
                  presence?: null
                  | "Online"
                  | "Idle"
                  | "Focus"
                  | "Busy"
                  | "Invisible";
                  text?: null | string;
              };
              username: string;
          },
      >

    edit

    • edit(
          data: {
              avatar?: null | string;
              badges?: null | number;
              display_name?: null | string;
              flags?: null | number;
              profile?: null | { background?: null | string; content?: null | string };
              remove?: (
                  | "Avatar"
                  | "StatusText"
                  | "StatusPresence"
                  | "ProfileContent"
                  | "ProfileBackground"
                  | "DisplayName"
                  | "Internal"
              )[];
              status?: | null
              | {
                  presence?: null
                  | "Online"
                  | "Idle"
                  | "Focus"
                  | "Busy"
                  | "Invisible";
                  text?: null | string;
              };
          },
      ): Promise<void>

      Edit the user

      +

    Returns Promise<
        {
            _id: string;
            avatar?: | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
            badges?: number;
            bot?: null
            | { owner: string };
            discriminator: string;
            display_name?: null | string;
            flags?: number;
            online: boolean;
            privileged?: boolean;
            relations?: {
                _id: string;
                status:
                    | "User"
                    | "None"
                    | "Friend"
                    | "Outgoing"
                    | "Incoming"
                    | "Blocked"
                    | "BlockedOther";
            }[];
            relationship: | "User"
            | "None"
            | "Friend"
            | "Outgoing"
            | "Incoming"
            | "Blocked"
            | "BlockedOther";
            status?: | null
            | {
                presence?: null
                | "Online"
                | "Idle"
                | "Focus"
                | "Busy"
                | "Invisible";
                text?: null | string;
            };
            username: string;
        },
    >

    edit

    Returns Promise<void>

    fetchMutual

    Returns Promise<void>

    fetchMutual

    fetchProfile

    fetchProfile

    openDM

    openDM

    removeFriend

    statusMessage

    removeFriend

    statusMessage

    toString

    toString

    unblockUser

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    unblockUser

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/UserCollection.html b/classes/UserCollection.html index c2eee71d..350bd8cc 100644 --- a/classes/UserCollection.html +++ b/classes/UserCollection.html @@ -1,5 +1,5 @@ UserCollection | revolt.js

    Class UserCollection

    Collection of Users

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client getUnderlyingObject updateUnderlyingObject @@ -21,30 +21,30 @@ toList values

    Constructors

    constructor

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedUser

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedUser>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: User,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      +

      Parameters

      Returns UserCollection

    Properties

    Readonlyclient

    client: Client

    ReadonlygetUnderlyingObject

    getUnderlyingObject: (id: string) => HydratedUser

    ReadonlyupdateUnderlyingObject

    updateUnderlyingObject: SetStoreFunction<Record<string, HydratedUser>>

    Methods

    create

    • create(
          id: string,
          type:
              | "user"
              | "server"
              | "channel"
              | "bot"
              | "channelUnread"
              | "channelWebhook"
              | "emoji"
              | "message"
              | "serverMember"
              | "session",
          instance: User,
          context: unknown,
          data?: unknown,
      ): void

      Create a new instance of an object

      Parameters

      • id: string

        Id

      • type:
            | "user"
            | "server"
            | "channel"
            | "bot"
            | "channelUnread"
            | "channelWebhook"
            | "emoji"
            | "message"
            | "serverMember"
            | "session"

        Type

      • instance: User

        Instance

      • context: unknown

        Context

      • Optionaldata: unknown

        Data

        -

      Returns void

    delete

    • delete(id: string): void

      Delete an object

      +

    Returns void

    delete

    entries

    Returns void

    entries

    fetch

    fetch

    filter

    filter

    find

    Returns User[]

    find

    forEach

    Returns undefined | User

    forEach

    get

    get

    getOrCreate

    getOrCreate

    getOrPartial

    Returns User

    getOrPartial

    has

    Returns undefined | User

    has

    isPartial

    isPartial

    keys

    keys

    map

    map

    size

    Returns O[]

    size

    toList

    toList

    values

    values

    On This Page

    Constructors
    Properties
    Methods
    +

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/classes/UserModeratedSystemMessage.html b/classes/UserModeratedSystemMessage.html index ede08fe6..83070501 100644 --- a/classes/UserModeratedSystemMessage.html +++ b/classes/UserModeratedSystemMessage.html @@ -1,5 +1,5 @@ UserModeratedSystemMessage | revolt.js

    Class UserModeratedSystemMessage

    User Moderated System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    byId client? type @@ -10,9 +10,9 @@

    Constructors

    constructor

    • new UserModeratedSystemMessage(
          client: Client,
          systemMessage: (
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" }
          ) & { type: "user_added" | "user_remove" },
      ): UserModeratedSystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • systemMessage: (
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }
        ) & { type: "user_added" | "user_remove" }

        System Message

        -

      Returns UserModeratedSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    ReadonlyuserId

    userId: string

    Accessors

    by

    user

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns UserModeratedSystemMessage

    Properties

    ReadonlybyId

    byId: string

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    ReadonlyuserId

    userId: string

    Accessors

    by

    user

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/UserProfile.html b/classes/UserProfile.html index 3d04ad5c..d6a189f1 100644 --- a/classes/UserProfile.html +++ b/classes/UserProfile.html @@ -1,5 +1,5 @@ UserProfile | revolt.js

    Class UserProfile

    User Profile Class

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    banner? content?

    Accessors

    animatedBannerURL @@ -9,6 +9,6 @@
  • data: {
        background?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        content?: null
        | string;
    }

    Data

    • Optionalbackground?:
          | null
          | {
              _id: string;
              content_type: string;
              deleted?: null
              | boolean;
              filename: string;
              message_id?: null | string;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | { height: number; type: "Image"; width: number }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          }

      Description

      Background visible on user's profile

    • Optionalcontent?: null | string

      Description

      Text content on user's profile

      -

    • Returns UserProfile

    Properties

    Optional Readonlybanner

    banner?: File

    Optional Readonlycontent

    content?: string

    Accessors

    animatedBannerURL

    bannerURL

    On This Page

    Constructors
    Properties
    Accessors
    +

    Returns UserProfile

    Properties

    Optional Readonlybanner

    banner?: File

    Optional Readonlycontent

    content?: string

    Accessors

    animatedBannerURL

    bannerURL

    On This Page

    Constructors
    Properties
    Accessors
    diff --git a/classes/UserSystemMessage.html b/classes/UserSystemMessage.html index da7dddde..2d8d8214 100644 --- a/classes/UserSystemMessage.html +++ b/classes/UserSystemMessage.html @@ -1,5 +1,5 @@ UserSystemMessage | revolt.js

    Class UserSystemMessage

    User System Message

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? type userId @@ -8,8 +8,8 @@

    Constructors

    constructor

    • new UserSystemMessage(
          client: Client,
          systemMessage: (
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" }
          ) & {
              type:
                  | "user_added"
                  | "user_remove"
                  | "user_joined"
                  | "user_left"
                  | "user_kicked"
                  | "user_banned";
          },
      ): UserSystemMessage

      Construct System Message

      Parameters

      • client: Client

        Client

      • systemMessage: (
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }
        ) & {
            type:
                | "user_added"
                | "user_remove"
                | "user_joined"
                | "user_left"
                | "user_kicked"
                | "user_banned";
        }

        System Message

        -

      Returns UserSystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    ReadonlyuserId

    userId: string

    Accessors

    user

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      +

    Returns UserSystemMessage

    Properties

    Protected Optionalclient

    client?: Client

    Readonlytype

    type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"

    ReadonlyuserId

    userId: string

    Accessors

    user

    Methods

    Staticfrom

    • from(
          client: Client,
          message:
              | { content: string; type: "text" }
              | { by: string; id: string; type: "user_added" }
              | { by: string; id: string; type: "user_remove" }
              | { id: string; type: "user_joined" }
              | { id: string; type: "user_left" }
              | { id: string; type: "user_kicked" }
              | { id: string; type: "user_banned" }
              | { by: string; name: string; type: "channel_renamed" }
              | { by: string; type: "channel_description_changed" }
              | { by: string; type: "channel_icon_changed" }
              | { from: string; to: string; type: "channel_ownership_changed" }
              | { by: string; id: string; type: "message_pinned" }
              | { by: string; id: string; type: "message_unpinned" },
      ): SystemMessage

      Create an System Message from an API System Message

      Parameters

      • client: Client

        Client

      • message:
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" }

      Returns SystemMessage

      System Message

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/VideoEmbed.html b/classes/VideoEmbed.html index 226f6b9d..db31fdfd 100644 --- a/classes/VideoEmbed.html +++ b/classes/VideoEmbed.html @@ -1,5 +1,5 @@ VideoEmbed | revolt.js

    Class VideoEmbed

    Video Embed

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? height type @@ -10,8 +10,8 @@

    Constructors

    constructor

    • new VideoEmbed(
          client: Client,
          embed: Omit<
              (
                  | {
                      colour?: null
                      | string;
                      description?: null | string;
                      icon_url?: null | string;
                      image?:
                          | null
                          | {
                              height: number;
                              size: "Large"
                              | "Preview";
                              url: string;
                              width: number;
                          };
                      original_url?: null
                      | string;
                      site_name?: null | string;
                      special?:
                          | null
                          | { type: "None" }
                          | { type: "GIF" }
                          | { id: string; timestamp?: null | string; type: "YouTube" }
                          | { content_type: "Channel"; id: string; type: "Lightspeed" }
                          | {
                              content_type: "Video" | "Channel" | "Clip";
                              id: string;
                              type: "Twitch";
                          }
                          | { content_type: string; id: string; type: "Spotify" }
                          | { type: "Soundcloud" }
                          | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                          | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                          | { id: string; type: "Streamable" };
                      title?: null | string;
                      type: "Website";
                      url?: null | string;
                      video?: null | { height: number; url: string; width: number };
                  }
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      type: "Image";
                      url: string;
                      width: number;
                  }
                  | { height: number; type: "Video"; url: string; width: number }
                  | {
                      colour?: null | string;
                      description?: null | string;
                      icon_url?: null | string;
                      media?:
                          | null
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: null
                              | boolean;
                              filename: string;
                              message_id?: null | string;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: null | string;
                              reported?: null | boolean;
                              server_id?: null | string;
                              size: number;
                              tag: string;
                              user_id?: null | string;
                          };
                      title?: null
                      | string;
                      type: "Text";
                      url?: null | string;
                  }
                  | { type: "None" }
              ) & { type: "Video" },
              "type",
          >,
      ): VideoEmbed

      Construct Video Embed

      Parameters

      • client: Client

        Client

      • embed: Omit<
            (
                | {
                    colour?: null
                    | string;
                    description?: null | string;
                    icon_url?: null | string;
                    image?:
                        | null
                        | {
                            height: number;
                            size: "Large"
                            | "Preview";
                            url: string;
                            width: number;
                        };
                    original_url?: null
                    | string;
                    site_name?: null | string;
                    special?:
                        | null
                        | { type: "None" }
                        | { type: "GIF" }
                        | { id: string; timestamp?: null | string; type: "YouTube" }
                        | { content_type: "Channel"; id: string; type: "Lightspeed" }
                        | {
                            content_type: "Video" | "Channel" | "Clip";
                            id: string;
                            type: "Twitch";
                        }
                        | { content_type: string; id: string; type: "Spotify" }
                        | { type: "Soundcloud" }
                        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                        | { id: string; type: "Streamable" };
                    title?: null | string;
                    type: "Website";
                    url?: null | string;
                    video?: null | { height: number; url: string; width: number };
                }
                | {
                    height: number;
                    size: "Large"
                    | "Preview";
                    type: "Image";
                    url: string;
                    width: number;
                }
                | { height: number; type: "Video"; url: string; width: number }
                | {
                    colour?: null | string;
                    description?: null | string;
                    icon_url?: null | string;
                    media?:
                        | null
                        | {
                            _id: string;
                            content_type: string;
                            deleted?: null
                            | boolean;
                            filename: string;
                            message_id?: null | string;
                            metadata:
                                | { type: "File" }
                                | { type: "Text" }
                                | { height: number; type: "Image"; width: number }
                                | { height: number; type: "Video"; width: number }
                                | { type: "Audio" };
                            object_id?: null | string;
                            reported?: null | boolean;
                            server_id?: null | string;
                            size: number;
                            tag: string;
                            user_id?: null | string;
                        };
                    title?: null
                    | string;
                    type: "Text";
                    url?: null | string;
                }
                | { type: "None" }
            ) & { type: "Video" },
            "type",
        >

        Embed

        -

      Returns VideoEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Readonlyheight

    height: number

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Readonlyurl

    url: string

    Readonlywidth

    width: number

    Accessors

    proxiedURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      +

    Returns VideoEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Readonlyheight

    height: number

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Readonlyurl

    url: string

    Readonlywidth

    width: number

    Accessors

    proxiedURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      Parameters

      • client: Client

        Client

      • embed:
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                image?:
                    | null
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        url: string;
                        width: number;
                    };
                original_url?: null
                | string;
                site_name?: null | string;
                special?:
                    | null
                    | { type: "None" }
                    | { type: "GIF" }
                    | { id: string; timestamp?: null | string; type: "YouTube" }
                    | { content_type: "Channel"; id: string; type: "Lightspeed" }
                    | {
                        content_type: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { id: string; type: "Streamable" };
                title?: null | string;
                type: "Website";
                url?: null | string;
                video?: null | { height: number; url: string; width: number };
            }
            | {
                height: number;
                size: "Large"
                | "Preview";
                type: "Image";
                url: string;
                width: number;
            }
            | { height: number; type: "Video"; url: string; width: number }
            | {
                colour?: null | string;
                description?: null | string;
                icon_url?: null | string;
                media?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                title?: null
                | string;
                type: "Text";
                url?: null | string;
            }
            | { type: "None" }

        Data

        • {
              colour?: null | string;
              description?: null | string;
              icon_url?: null | string;
              image?:
                  | null
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      url: string;
                      width: number;
                  };
              original_url?: null
              | string;
              site_name?: null | string;
              special?:
                  | null
                  | { type: "None" }
                  | { type: "GIF" }
                  | { id: string; timestamp?: null | string; type: "YouTube" }
                  | { content_type: "Channel"; id: string; type: "Lightspeed" }
                  | {
                      content_type: "Video" | "Channel" | "Clip";
                      id: string;
                      type: "Twitch";
                  }
                  | { content_type: string; id: string; type: "Spotify" }
                  | { type: "Soundcloud" }
                  | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                  | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                  | { id: string; type: "Streamable" };
              title?: null | string;
              type: "Website";
              url?: null | string;
              video?: null | { height: number; url: string; width: number };
          }
          • Optionalcolour?: null | string

            Description

            CSS Colour

            @@ -42,4 +42,4 @@
          • Optionaltitle?: null | string

            Description

            Title of text embed

          • type: "Text"
          • Optionalurl?: null | string

            Description

            URL for title

        • { type: "None" }

      Returns MessageEmbed

      Embed

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/classes/WebsiteEmbed.html b/classes/WebsiteEmbed.html index 4a7a8670..8b87faa2 100644 --- a/classes/WebsiteEmbed.html +++ b/classes/WebsiteEmbed.html @@ -1,5 +1,5 @@ WebsiteEmbed | revolt.js

    Class WebsiteEmbed

    Website Embed

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    client? colour? description? @@ -18,9 +18,9 @@

    Constructors

    constructor

    • new WebsiteEmbed(
          client: Client,
          embed: Omit<
              (
                  | {
                      colour?: null
                      | string;
                      description?: null | string;
                      icon_url?: null | string;
                      image?:
                          | null
                          | {
                              height: number;
                              size: "Large"
                              | "Preview";
                              url: string;
                              width: number;
                          };
                      original_url?: null
                      | string;
                      site_name?: null | string;
                      special?:
                          | null
                          | { type: "None" }
                          | { type: "GIF" }
                          | { id: string; timestamp?: null | string; type: "YouTube" }
                          | { content_type: "Channel"; id: string; type: "Lightspeed" }
                          | {
                              content_type: "Video" | "Channel" | "Clip";
                              id: string;
                              type: "Twitch";
                          }
                          | { content_type: string; id: string; type: "Spotify" }
                          | { type: "Soundcloud" }
                          | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                          | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                          | { id: string; type: "Streamable" };
                      title?: null | string;
                      type: "Website";
                      url?: null | string;
                      video?: null | { height: number; url: string; width: number };
                  }
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      type: "Image";
                      url: string;
                      width: number;
                  }
                  | { height: number; type: "Video"; url: string; width: number }
                  | {
                      colour?: null | string;
                      description?: null | string;
                      icon_url?: null | string;
                      media?:
                          | null
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: null
                              | boolean;
                              filename: string;
                              message_id?: null | string;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: null | string;
                              reported?: null | boolean;
                              server_id?: null | string;
                              size: number;
                              tag: string;
                              user_id?: null | string;
                          };
                      title?: null
                      | string;
                      type: "Text";
                      url?: null | string;
                  }
                  | { type: "None" }
              ) & { type: "Website" },
              "type",
          >,
      ): WebsiteEmbed

      Construct Video Embed

      Parameters

      • client: Client

        Client

      • embed: Omit<
            (
                | {
                    colour?: null
                    | string;
                    description?: null | string;
                    icon_url?: null | string;
                    image?:
                        | null
                        | {
                            height: number;
                            size: "Large"
                            | "Preview";
                            url: string;
                            width: number;
                        };
                    original_url?: null
                    | string;
                    site_name?: null | string;
                    special?:
                        | null
                        | { type: "None" }
                        | { type: "GIF" }
                        | { id: string; timestamp?: null | string; type: "YouTube" }
                        | { content_type: "Channel"; id: string; type: "Lightspeed" }
                        | {
                            content_type: "Video" | "Channel" | "Clip";
                            id: string;
                            type: "Twitch";
                        }
                        | { content_type: string; id: string; type: "Spotify" }
                        | { type: "Soundcloud" }
                        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                        | { id: string; type: "Streamable" };
                    title?: null | string;
                    type: "Website";
                    url?: null | string;
                    video?: null | { height: number; url: string; width: number };
                }
                | {
                    height: number;
                    size: "Large"
                    | "Preview";
                    type: "Image";
                    url: string;
                    width: number;
                }
                | { height: number; type: "Video"; url: string; width: number }
                | {
                    colour?: null | string;
                    description?: null | string;
                    icon_url?: null | string;
                    media?:
                        | null
                        | {
                            _id: string;
                            content_type: string;
                            deleted?: null
                            | boolean;
                            filename: string;
                            message_id?: null | string;
                            metadata:
                                | { type: "File" }
                                | { type: "Text" }
                                | { height: number; type: "Image"; width: number }
                                | { height: number; type: "Video"; width: number }
                                | { type: "Audio" };
                            object_id?: null | string;
                            reported?: null | boolean;
                            server_id?: null | string;
                            size: number;
                            tag: string;
                            user_id?: null | string;
                        };
                    title?: null
                    | string;
                    type: "Text";
                    url?: null | string;
                }
                | { type: "None" }
            ) & { type: "Website" },
            "type",
        >

        Embed

        -

      Returns WebsiteEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Optional Readonlycolour

    colour?: string

    Optional Readonlydescription

    description?: string

    Optional ReadonlyiconUrl

    iconUrl?: string

    Optional Readonlyimage

    image?: ImageEmbed

    Optional ReadonlyoriginalUrl

    originalUrl?: string

    Optional ReadonlysiteName

    siteName?: string

    Optional ReadonlyspecialContent

    specialContent?:
        | { type: "None" }
        | { type: "GIF" }
        | { id: string; timestamp?: null | string; type: "YouTube" }
        | { content_type: "Channel"; id: string; type: "Lightspeed" }
        | {
            content_type: "Video" | "Channel" | "Clip";
            id: string;
            type: "Twitch";
        }
        | { content_type: string; id: string; type: "Spotify" }
        | { type: "Soundcloud" }
        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
        | { id: string; type: "Streamable" }

    Optional Readonlytitle

    title?: string

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Optional Readonlyurl

    url?: string

    Optional Readonlyvideo

    video?: VideoEmbed

    Accessors

    embedURL

    • get embedURL(): undefined | string

      If special content is present, generate the embed URL

      -

      Returns undefined | string

    proxiedIconURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      +

    Returns WebsiteEmbed

    Properties

    Protected Optionalclient

    client?: Client

    Optional Readonlycolour

    colour?: string

    Optional Readonlydescription

    description?: string

    Optional ReadonlyiconUrl

    iconUrl?: string

    Optional Readonlyimage

    image?: ImageEmbed

    Optional ReadonlyoriginalUrl

    originalUrl?: string

    Optional ReadonlysiteName

    siteName?: string

    Optional ReadonlyspecialContent

    specialContent?:
        | { type: "None" }
        | { type: "GIF" }
        | { id: string; timestamp?: null | string; type: "YouTube" }
        | { content_type: "Channel"; id: string; type: "Lightspeed" }
        | {
            content_type: "Video" | "Channel" | "Clip";
            id: string;
            type: "Twitch";
        }
        | { content_type: string; id: string; type: "Spotify" }
        | { type: "Soundcloud" }
        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
        | { id: string; type: "Streamable" }

    Optional Readonlytitle

    title?: string

    Readonlytype

    type: "Text" | "Video" | "Image" | "Website" | "None"

    Optional Readonlyurl

    url?: string

    Optional Readonlyvideo

    video?: VideoEmbed

    Accessors

    embedURL

    • get embedURL(): undefined | string

      If special content is present, generate the embed URL

      +

      Returns undefined | string

    proxiedIconURL

    Methods

    Staticfrom

    • from(
          client: Client,
          embed:
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" },
      ): MessageEmbed

      Create an Embed from an API Embed

      Parameters

      • client: Client

        Client

      • embed:
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                image?:
                    | null
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        url: string;
                        width: number;
                    };
                original_url?: null
                | string;
                site_name?: null | string;
                special?:
                    | null
                    | { type: "None" }
                    | { type: "GIF" }
                    | { id: string; timestamp?: null | string; type: "YouTube" }
                    | { content_type: "Channel"; id: string; type: "Lightspeed" }
                    | {
                        content_type: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { id: string; type: "Streamable" };
                title?: null | string;
                type: "Website";
                url?: null | string;
                video?: null | { height: number; url: string; width: number };
            }
            | {
                height: number;
                size: "Large"
                | "Preview";
                type: "Image";
                url: string;
                width: number;
            }
            | { height: number; type: "Video"; url: string; width: number }
            | {
                colour?: null | string;
                description?: null | string;
                icon_url?: null | string;
                media?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                title?: null
                | string;
                type: "Text";
                url?: null | string;
            }
            | { type: "None" }

        Data

        • {
              colour?: null | string;
              description?: null | string;
              icon_url?: null | string;
              image?:
                  | null
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      url: string;
                      width: number;
                  };
              original_url?: null
              | string;
              site_name?: null | string;
              special?:
                  | null
                  | { type: "None" }
                  | { type: "GIF" }
                  | { id: string; timestamp?: null | string; type: "YouTube" }
                  | { content_type: "Channel"; id: string; type: "Lightspeed" }
                  | {
                      content_type: "Video" | "Channel" | "Clip";
                      id: string;
                      type: "Twitch";
                  }
                  | { content_type: string; id: string; type: "Spotify" }
                  | { type: "Soundcloud" }
                  | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                  | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                  | { id: string; type: "Streamable" };
              title?: null | string;
              type: "Website";
              url?: null | string;
              video?: null | { height: number; url: string; width: number };
          }
          • Optionalcolour?: null | string

            Description

            CSS Colour

            @@ -51,4 +51,4 @@
          • Optionaltitle?: null | string

            Description

            Title of text embed

          • type: "Text"
          • Optionalurl?: null | string

            Description

            URL for title

        • { type: "None" }

      Returns MessageEmbed

      Embed

      -

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/enums/BotFlags.html b/enums/BotFlags.html index 68d3e3de..8b2be88b 100644 --- a/enums/BotFlags.html +++ b/enums/BotFlags.html @@ -1,2 +1,2 @@ BotFlags | revolt.js

    Enumeration BotFlags

    Flags attributed to users

    -
    +
    diff --git a/enums/ConnectionState.html b/enums/ConnectionState.html index 0ec63c4c..4bc8d3cb 100644 --- a/enums/ConnectionState.html +++ b/enums/ConnectionState.html @@ -1,6 +1,6 @@ ConnectionState | revolt.js

    Enumeration ConnectionState

    All possible event client states.

    -

    Enumeration Members

    Connected +

    Enumeration Members

    Connected Connecting Disconnected Idle -

    Enumeration Members

    Connected

    Connected: 2

    Connecting

    Connecting: 1

    Disconnected

    Disconnected: 3

    Idle

    Idle: 0

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Connected

    Connected: 2

    Connecting

    Connecting: 1

    Disconnected

    Disconnected: 3

    Idle

    Idle: 0

    On This Page

    Enumeration Members
    diff --git a/enums/ServerFlags.html b/enums/ServerFlags.html index dcbb83f4..5d2c2f1e 100644 --- a/enums/ServerFlags.html +++ b/enums/ServerFlags.html @@ -1,4 +1,4 @@ ServerFlags | revolt.js

    Enumeration ServerFlags

    Flags attributed to servers

    -

    Enumeration Members

    Official +

    Enumeration Members

    Official Verified -

    Enumeration Members

    Official

    Official: 1

    Verified

    Verified: 2

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Official

    Official: 1

    Verified

    Verified: 2

    On This Page

    Enumeration Members
    diff --git a/enums/UserBadges.html b/enums/UserBadges.html index bd2ce423..b255d89c 100644 --- a/enums/UserBadges.html +++ b/enums/UserBadges.html @@ -1,5 +1,5 @@ UserBadges | revolt.js

    Enumeration UserBadges

    Badges available to users

    -

    Enumeration Members

    ActiveSupporter +

    Enumeration Members

    ActiveSupporter Developer EarlyAdopter Founder @@ -10,4 +10,4 @@ ResponsibleDisclosure Supporter Translator -

    Enumeration Members

    ActiveSupporter

    ActiveSupporter: 64

    Developer

    Developer: 1

    EarlyAdopter

    EarlyAdopter: 256

    Founder

    Founder: 16

    Paw

    Paw: 128

    PlatformModeration

    PlatformModeration: 32

    ReservedRelevantJokeBadge1

    ReservedRelevantJokeBadge1: 512

    ReservedRelevantJokeBadge2

    ReservedRelevantJokeBadge2: 1024

    ResponsibleDisclosure

    ResponsibleDisclosure: 8

    Supporter

    Supporter: 4

    Translator

    Translator: 2

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ActiveSupporter

    ActiveSupporter: 64

    Developer

    Developer: 1

    EarlyAdopter

    EarlyAdopter: 256

    Founder

    Founder: 16

    Paw

    Paw: 128

    PlatformModeration

    PlatformModeration: 32

    ReservedRelevantJokeBadge1

    ReservedRelevantJokeBadge1: 512

    ReservedRelevantJokeBadge2

    ReservedRelevantJokeBadge2: 1024

    ResponsibleDisclosure

    ResponsibleDisclosure: 8

    Supporter

    Supporter: 4

    Translator

    Translator: 2

    On This Page

    Enumeration Members
    diff --git a/enums/UserFlags.html b/enums/UserFlags.html index ae39e99e..bc746aa5 100644 --- a/enums/UserFlags.html +++ b/enums/UserFlags.html @@ -1,5 +1,5 @@ UserFlags | revolt.js

    Enumeration UserFlags

    Flags attributed to users

    -

    Enumeration Members

    Banned +

    Enumeration Members

    Banned Deleted Suspended -

    Enumeration Members

    Banned

    Banned: 4

    Deleted

    Deleted: 2

    Suspended

    Suspended: 1

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Banned

    Banned: 4

    Deleted

    Deleted: 2

    Suspended

    Suspended: 1

    On This Page

    Enumeration Members
    diff --git a/types/ClientOptions.html b/types/ClientOptions.html index 1c82e750..9c237e56 100644 --- a/types/ClientOptions.html +++ b/types/ClientOptions.html @@ -26,10 +26,10 @@

    Default

    false
    -
  • retryDelayFunction:function
  • retryDelayFunction:function
    • +
    diff --git a/types/PrivateSession.html b/types/PrivateSession.html index fa49b3ab..2bddf2cd 100644 --- a/types/PrivateSession.html +++ b/types/PrivateSession.html @@ -1 +1 @@ -PrivateSession | revolt.js

    Type Alias PrivateSession

    PrivateSession: { _id: string; token: string; user_id: string } | string
    +PrivateSession | revolt.js

    Type Alias PrivateSession

    PrivateSession: { _id: string; token: string; user_id: string } | string
    diff --git a/variables/ALLOW_IN_TIMEOUT.html b/variables/ALLOW_IN_TIMEOUT.html index a1a1341e..9876e8af 100644 --- a/variables/ALLOW_IN_TIMEOUT.html +++ b/variables/ALLOW_IN_TIMEOUT.html @@ -1,2 +1,2 @@ ALLOW_IN_TIMEOUT | revolt.js

    Variable ALLOW_IN_TIMEOUTConst

    ALLOW_IN_TIMEOUT: number = ...

    Permissions allowed for a user while in timeout

    -
    +
    diff --git a/variables/DEFAULT_PERMISSION.html b/variables/DEFAULT_PERMISSION.html index dbe3e05b..0477ec3f 100644 --- a/variables/DEFAULT_PERMISSION.html +++ b/variables/DEFAULT_PERMISSION.html @@ -1,2 +1,2 @@ DEFAULT_PERMISSION | revolt.js

    Variable DEFAULT_PERMISSIONConst

    DEFAULT_PERMISSION: number = ...

    Default base permissions for channels

    -
    +
    diff --git a/variables/DEFAULT_PERMISSION_DIRECT_MESSAGE.html b/variables/DEFAULT_PERMISSION_DIRECT_MESSAGE.html index 71f171a1..6c0c9ca2 100644 --- a/variables/DEFAULT_PERMISSION_DIRECT_MESSAGE.html +++ b/variables/DEFAULT_PERMISSION_DIRECT_MESSAGE.html @@ -1,2 +1,2 @@ DEFAULT_PERMISSION_DIRECT_MESSAGE | revolt.js

    Variable DEFAULT_PERMISSION_DIRECT_MESSAGEConst

    DEFAULT_PERMISSION_DIRECT_MESSAGE: number = ...

    Permissions in direct message channels / default permissions for group DMs

    -
    +
    diff --git a/variables/DEFAULT_PERMISSION_SAVED_MESSAGES.html b/variables/DEFAULT_PERMISSION_SAVED_MESSAGES.html index ee71dba1..3ccc07ec 100644 --- a/variables/DEFAULT_PERMISSION_SAVED_MESSAGES.html +++ b/variables/DEFAULT_PERMISSION_SAVED_MESSAGES.html @@ -1,2 +1,2 @@ DEFAULT_PERMISSION_SAVED_MESSAGES | revolt.js

    Variable DEFAULT_PERMISSION_SAVED_MESSAGESConst

    DEFAULT_PERMISSION_SAVED_MESSAGES: number = Permission.GrantAllSafe

    Permissions in saved messages channel

    -
    +
    diff --git a/variables/DEFAULT_PERMISSION_SERVER.html b/variables/DEFAULT_PERMISSION_SERVER.html index 762fa109..d294a33a 100644 --- a/variables/DEFAULT_PERMISSION_SERVER.html +++ b/variables/DEFAULT_PERMISSION_SERVER.html @@ -1,2 +1,2 @@ DEFAULT_PERMISSION_SERVER | revolt.js

    Variable DEFAULT_PERMISSION_SERVERConst

    DEFAULT_PERMISSION_SERVER: number = ...

    Permissions in server text / voice channel

    -
    +
    diff --git a/variables/DEFAULT_PERMISSION_VIEW_ONLY.html b/variables/DEFAULT_PERMISSION_VIEW_ONLY.html index 411a7a73..e03af039 100644 --- a/variables/DEFAULT_PERMISSION_VIEW_ONLY.html +++ b/variables/DEFAULT_PERMISSION_VIEW_ONLY.html @@ -1,2 +1,2 @@ DEFAULT_PERMISSION_VIEW_ONLY | revolt.js

    Variable DEFAULT_PERMISSION_VIEW_ONLYConst

    DEFAULT_PERMISSION_VIEW_ONLY: number = ...

    Default permissions if we can only view

    -
    +
    diff --git a/variables/Permission.html b/variables/Permission.html index 12ea095d..925f0cac 100644 --- a/variables/Permission.html +++ b/variables/Permission.html @@ -1,2 +1,2 @@ Permission | revolt.js

    Variable PermissionConst

    Permission: {
        AssignRoles: number;
        BanMembers: number;
        ChangeAvatar: number;
        ChangeNickname: number;
        Connect: number;
        DeafenMembers: number;
        GrantAllSafe: number;
        InviteOthers: number;
        KickMembers: number;
        ManageChannel: number;
        ManageCustomisation: number;
        ManageMessages: number;
        ManageNicknames: number;
        ManagePermissions: number;
        ManageRole: number;
        ManageServer: number;
        ManageWebhooks: number;
        Masquerade: number;
        MentionEveryone: number;
        MentionRoles: number;
        MoveMembers: number;
        MuteMembers: number;
        React: number;
        ReadMessageHistory: number;
        RemoveAvatars: number;
        SendEmbeds: number;
        SendMessage: number;
        Speak: number;
        TimeoutMembers: number;
        UploadFiles: number;
        Video: number;
        ViewChannel: number;
    } = ...

    Permission against Server / Channel

    -

    Type declaration

    • AssignRoles: number
    • BanMembers: number
    • ChangeAvatar: number
    • ChangeNickname: number
    • Connect: number
    • DeafenMembers: number
    • GrantAllSafe: number
    • InviteOthers: number
    • KickMembers: number
    • ManageChannel: number
    • ManageCustomisation: number
    • ManageMessages: number
    • ManageNicknames: number
    • ManagePermissions: number
    • ManageRole: number
    • ManageServer: number
    • ManageWebhooks: number
    • Masquerade: number
    • MentionEveryone: number
    • MentionRoles: number
    • MoveMembers: number
    • MuteMembers: number
    • React: number
    • ReadMessageHistory: number
    • RemoveAvatars: number
    • SendEmbeds: number
    • SendMessage: number
    • Speak: number
    • TimeoutMembers: number
    • UploadFiles: number
    • Video: number
    • ViewChannel: number
    +

    Type declaration

    diff --git a/variables/RE_CHANNELS.html b/variables/RE_CHANNELS.html index e041179b..64c79ddb 100644 --- a/variables/RE_CHANNELS.html +++ b/variables/RE_CHANNELS.html @@ -1,2 +1,2 @@ RE_CHANNELS | revolt.js

    Variable RE_CHANNELSConst

    RE_CHANNELS: RegExp = ...

    Regular expression for channels.

    -
    +
    diff --git a/variables/RE_MENTIONS.html b/variables/RE_MENTIONS.html index a4792f6d..eab37e6f 100644 --- a/variables/RE_MENTIONS.html +++ b/variables/RE_MENTIONS.html @@ -1,2 +1,2 @@ RE_MENTIONS | revolt.js

    Variable RE_MENTIONSConst

    RE_MENTIONS: RegExp = ...

    Regular expression for mentions.

    -
    +
    diff --git a/variables/RE_SPOILER.html b/variables/RE_SPOILER.html index 239b090e..a219484d 100644 --- a/variables/RE_SPOILER.html +++ b/variables/RE_SPOILER.html @@ -1,2 +1,2 @@ RE_SPOILER | revolt.js

    Variable RE_SPOILERConst

    RE_SPOILER: RegExp = ...

    Regular expression for spoilers.

    -
    +
    diff --git a/variables/U32_MAX.html b/variables/U32_MAX.html index 10799446..ad9585ff 100644 --- a/variables/U32_MAX.html +++ b/variables/U32_MAX.html @@ -1,2 +1,2 @@ U32_MAX | revolt.js

    Variable U32_MAXConst

    U32_MAX: number = ...

    Maximum safe value

    -
    +
    diff --git a/variables/UserPermission.html b/variables/UserPermission.html index 76f7b8a6..6db4c266 100644 --- a/variables/UserPermission.html +++ b/variables/UserPermission.html @@ -1,2 +1,2 @@ UserPermission | revolt.js

    Variable UserPermissionConst

    UserPermission: {
        Access: number;
        Invite: number;
        SendMessage: number;
        ViewProfile: number;
    } = ...

    Permission against User

    -

    Type declaration

    • Access: number
    • Invite: number
    • SendMessage: number
    • ViewProfile: number
    +

    Type declaration