Class VoiceChannel

Hierarchy

  • Omit<ServerChannel, "mentions" | "messages" | "ack" | "checkUnread" | "createInvite" | "fetchLastMessage" | "fetchMessage" | "getMentions" | "lastMessage" | "lastMessageID" | "markRead" | "send" | "unread">
    • VoiceChannel

Constructors

constructor

Properties

client createdAt defaultPermissions deleted description icon id name nsfw permissions rolePermissions server serverID source type typing typingIDs

Methods

delete edit fireUpdate generateIconURL isDM isDMBased isGroupDM isSavedMessages isServerBased isText isTextBased isVoice joinCall lastMessageBy offUpdate onUpdate permissionsFor setPermissions startTyping stopTyping toString update

Constructors

constructor

  • Parameters

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

    Returns VoiceChannel

Properties

client

client: Client

createdAt

createdAt: number

defaultPermissions

defaultPermissions: PermissionOverride

deleted

deleted: boolean = false

description

description: string

icon

icon: any

id

id: string

name

name: string

nsfw

nsfw: boolean

permissions

permissions: PermissionFlags

rolePermissions

rolePermissions: {
    allow: PermissionFlags;
    deny: PermissionFlags;
    id: string;
}[]

server

server: Server

serverID

serverID: string

source

source: {
    _id: string;
    channel_type: "TextChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    last_message_id?: string;
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
} | {
    _id: string;
    channel_type: "VoiceChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
}

type

type: Voice = ChannelType.Voice

typing

typing: User[]

typingIDs

typingIDs: Set<string> = ...

Can include your own user ID.

Methods

delete

  • Delete or leave this channel.

    Parameters

    • Optional silent: boolean

    Returns Promise<void>

edit

  • Parameters

    • data: {
          archived?: boolean;
          description?: string;
          icon?: string;
          name?: string;
          nsfw?: boolean;
          owner?: string;
          remove?: ("Description" | "Icon" | "DefaultPermissions")[];
      }
      • Optional archived?: boolean

        Description

        Whether this channel is archived

      • Optional description?: string

        Description

        Channel description

      • Optional icon?: string

        Description

        Icon

        Provide an Autumn attachment Id.

      • Optional name?: string

        Description

        Channel name

      • Optional nsfw?: boolean

        Description

        Whether this channel is age-restricted

      • Optional owner?: string

        Description

        Group owner

      • Optional remove?: ("Description" | "Icon" | "DefaultPermissions")[]

    Returns Promise<ServerChannel>

fireUpdate

  • Runs all of the callbacks for this emitter. (meant to run when an update occurs)

    Parameters

    • Optional updated: any[]

      The objects that caused this update.

    Returns void

generateIconURL

  • Parameters

    Returns any

isDM

  • Returns this is DMChannel

isDMBased

isGroupDM

  • Returns this is GroupDMChannel

isSavedMessages

  • Returns this is SavedMessagesChannel

isServerBased

  • Returns this is ServerChannel

isText

  • Returns this is TextChannel

isTextBased

isVoice

  • Returns this is VoiceChannel

joinCall

lastMessageBy

  • Parameters

    Returns Message

offUpdate

  • Stops listening for Map updates.

    Returns

    this, useful for chaining.

    Parameters

    Returns ServerChannel

onUpdate

  • Listen for an update to this Map.

    Returns

    this, useful for chaining.

    Parameters

    Returns ServerChannel

permissionsFor

  • Parameters

    Returns PermissionFlags

setPermissions

  • Set permissions for a role or 'default' for everyone.

    Parameters

    • role: Role | "default"
    • permissions: {
          allow: number;
          deny: number;
      }
      • allow: number

        Format: uint64

        Description

        Allow bit flags

      • deny: number

        Format: uint64

        Description

        Disallow bit flags

    Returns Promise<void>

startTyping

  • Returns void

stopTyping

  • Returns void

toString

  • Returns

    The channel formatted for markdown. <#id>

    Returns string

update

  • Update this object with new API data.

    Parameters

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

    Returns ServerChannel