Class ChannelManager

constructor

• new ChannelManager(client: client, maxSize?: number): ChannelManager

  Parameters

  • client: client
  • maxSize: number = BaseManager.defaultMaxSize

  Returns ChannelManager

holds

_add

• _add(
      data:
          | { _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;
          },
  ): Channel

  Adds a raw object to the cache, constructing the holdable class. Automatically evicts oldest entries if the max size is exceeded.

  Parameters

  • data:
        | { _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;
        }
    • { _id: string; channel_type: "SavedMessages"; user: string }

      • _id: string

        Description

        Unique Id

      • channel_type: "SavedMessages"

      • user: string

        Description

        Id of the user this channel belongs to

    • {
          _id: string;
          active: boolean;
          channel_type: "DirectMessage";
          last_message_id?: null | string;
          recipients: string[];
      }

      • _id: string

        Description

        Unique Id

      • active: boolean

        Description

        Whether this direct message channel is currently open on both sides

      • channel_type: "DirectMessage"

      • Optionallast_message_id?: null | string

        Description

        Id of the last message sent in this channel

      • recipients: string[]

        Description

        2-tuple of user ids participating in direct message

    • {
          _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

        Description

        Unique Id

      • channel_type: "Group"

      • Optionaldescription?: null | string

        Description

        Channel description

      • Optionalicon?:
            | 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

        Custom icon attachment

      • Optionallast_message_id?: null | string

        Description

        Id of the last message sent in this channel

      • name: string

        Description

        Display name of the channel

      • Optionalnsfw?: boolean

        Description

        Whether this group is marked as not safe for work

      • owner: string

        Description

        User id of the owner of the group

      • Optionalpermissions?: null | number

        Format: int64

        Description

        Permissions assigned to members of this group (does not apply to the owner of the group)

      • recipients: string[]

        Description

        Array of user ids participating in channel

    • {
          _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

        Description

        Unique Id

      • channel_type: "TextChannel"

      • Optionaldefault_permissions?: null | { a: number; d: number }

        Description

        Default permissions assigned to users in this channel

      • Optionaldescription?: null | string

        Description

        Channel description

      • Optionalicon?:
            | 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

        Custom icon attachment

      • Optionallast_message_id?: null | string

        Description

        Id of the last message sent in this channel

      • name: string

        Description

        Display name of the channel

      • Optionalnsfw?: boolean

        Description

        Whether this channel is marked as not safe for work

      • Optionalrole_permissions?: { [key: string]: { a: number; d: number } }

        Description

        Permissions assigned based on role to this channel

      • server: string

        Description

        Id of the server this channel belongs to

    • {
          _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;
      }

      • _id: string

        Description

        Unique Id

      • channel_type: "VoiceChannel"

      • Optionaldefault_permissions?: null | { a: number; d: number }

        Description

        Default permissions assigned to users in this channel

      • Optionaldescription?: null | string

        Description

        Channel description

      • Optionalicon?:
            | 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

        Custom icon attachment

      • name: string

        Description

        Display name of the channel

      • Optionalnsfw?: boolean

        Description

        Whether this channel is marked as not safe for work

      • Optionalrole_permissions?: { [key: string]: { a: number; d: number } }

        Description

        Permissions assigned based on role to this channel

      • server: string

        Description

        Id of the server this channel belongs to

  Returns Channel

_remove

• _remove(id: string): void

  Remove an entry by id.

  Parameters

  • id: string

  Returns void

delete

• delete(channel: ChannelResolvable): Promise<void>

  used to delete a channel

  Parameters

  • channel: ChannelResolvable

    The channel to delete

  Returns Promise<void>

  A promise that resolves when the channel is deleted

fetch

• fetch(channel: ChannelResolvable, force?: { force?: boolean }): Promise<Channel>

  used to fetch a channel

  Parameters

  • channel: ChannelResolvable

    The channel to fetch
  • force: { force?: boolean } = {}

    Whether to force fetch the channel using the api or return it form cache if able

  Returns Promise<Channel>

  A promise that resolves with the fetched channel

resolve

• resolve(channel: ChannelResolvable): null | Channel

  resolves a channel from a string or a channel object

  Parameters

  • channel: ChannelResolvable

    The channel to resolve

  Returns null | Channel

  the resolved channel or null if not found

resolveId

• resolveId(channel: ChannelResolvable): null | string

  resolves a channel id from a string or a channel object

  Parameters

  • channel: ChannelResolvable

    The channel to resolve

  Returns null | string

  the resolved channel id or null if not found