Class DMChannel

Readonlyclient

id

createdAt

• get createdAt(): Date

  Gets the date and time when the channel was created.

  Returns Date

  The creation date of the channel.

createdTimestamp

• get createdTimestamp(): number

  Gets the timestamp (in milliseconds) when the channel was created.

  Returns number

  The timestamp of the channel's creation.

_clone

• _clone(): this

  Creates a deep clone of the object.

  Returns this

  A clone of the object.

_update

• _update(data: PartialObject, clear?: string[]): this

  Updates the object with new data and returns a clone of the object.

  Parameters

  • data: PartialObject

    The data to update the object with.

  • Optionalclear: string[]

    Fields to clear in the object.

  Returns this

  A clone of the updated object.

createWebhook

• createWebhook(
      name: string,
      avatar?: string | Readable | File,
  ): Promise<createWebhookResponse>

  Creates a new webhook in this channel.

  Parameters

  • name: string

    The name of the webhook

  • Optionalavatar: string | Readable | File

    Optional avatar for the webhook. Can be a URL string, Readable stream, or File object

  Returns Promise<createWebhookResponse>

  Promise resolving to the created webhook response

  Example

  const webhook = await channel.createWebhook("My Webhook", "https://example.com/avatar.png");
  Copy

delete

• delete(): Promise<void>

  Deletes the current channel instance from the client's channel collection.

  This method interacts with the client's channel management system to remove the channel. Once deleted, the channel will no longer be accessible through the client.

  Returns Promise<void>

  A promise that resolves when the channel has been successfully deleted.

  Example

  const channel = client.channels.get('1234567890');
  if (channel) {
    await channel.delete();
    console.log('Channel deleted successfully.');
  }
  Copy

deleteWebhook

• deleteWebhook(webhookId: string, token: string): Promise<void>

  Deletes a webhook.

  Parameters

  • webhookId: string

    The ID of the webhook to delete

  • token: string

    The token of the webhook

  Returns Promise<void>

  Promise that resolves when the webhook is deleted

  Example

  await channel.deleteWebhook("webhookId", "webhookToken");
  console.log("Webhook deleted successfully");
  Copy

edit

• edit(
      data: Partial<CreateChannelOptions>,
  ): Promise<{ _id: string; channel_type: string; user: string }>

  Parameters

  • data: Partial<CreateChannelOptions>

  Returns Promise<{ _id: string; channel_type: string; user: string }>

editWebhook

• editWebhook(
      webhookId: string,
      token: string,
      options: editWebhookOptions,
  ): Promise<createWebhookResponse>

  Edits a webhook's properties.

  Parameters

  • webhookId: string

    The ID of the webhook to edit

  • token: string

    The token of the webhook

  • options: editWebhookOptions

    The options to edit on the webhook

  Returns Promise<createWebhookResponse>

  Promise resolving to the updated webhook response

  Example

  const updatedWebhook = await channel.editWebhook("webhookId", "token", {
    name: "New Webhook Name",
    avatar: "https://example.com/new-avatar.png"
  });
  Copy

equals

• equals(obj?: DMChannel | null): boolean

  Compares this object with another to determine if they are equal.

  Parameters

  • Optionalobj: DMChannel | null

    The object to compare with.

  Returns boolean

  true if the objects are equal, otherwise false.

fetch

• fetch(force?: boolean): Promise<Channel>

  Fetches the latest data for the channel from the client's channel collection.

  Parameters

  • Optionalforce: boolean = true

    Whether to force a fetch even if the channel is cached.

  Returns Promise<Channel>

  A promise that resolves with the updated channel instance.

getPartialWebhook

• getPartialWebhook(webhookId: string): Promise<createWebhookResponse>

  Retrieves partial information about a webhook using only its ID. This method provides limited webhook information without requiring a token.

  Parameters

  • webhookId: string

    The ID of the webhook to retrieve partial information for

  Returns Promise<createWebhookResponse>

  Promise resolving to the webhook response with partial information

  Example

  const partialWebhook = await channel.getPartialWebhook("webhookId");
  console.log(`Webhook name: ${partialWebhook.name}`);
  Copy

getWebhook

• getWebhook(webhookId: string, token: string): Promise<createWebhookResponse>

  Retrieves a specific webhook by ID and token.

  Parameters

  • webhookId: string

    The ID of the webhook to retrieve

  • token: string

    The token of the webhook

  Returns Promise<createWebhookResponse>

  Promise resolving to the webhook response

  Example

  const webhook = await channel.getWebhook("webhookId", "webhookToken");
  console.log(`Webhook name: ${webhook.name}`);
  Copy

getWebhooks

• getWebhooks(): Promise<createWebhookResponse[]>

  Retrieves all webhooks for this channel.

  Returns Promise<createWebhookResponse[]>

  Promise resolving to an array of webhook responses

  Example

  const webhooks = await channel.getWebhooks();
  console.log(`Found ${webhooks.length} webhooks`);
  Copy

inServer

• inServer(): this is ServerChannel

  Checks if the channel is part of a server.

  Returns this is ServerChannel

  True if the channel is a server channel, otherwise false.

isGroup

• isGroup(): this is GroupChannel

  Checks if the channel is a group channel.

  Returns this is GroupChannel

  True if the channel is a group channel, otherwise false.

isText

• isText(): this is DMChannel | TextChannel | GroupChannel

  Checks if the channel is a text-based channel.

  Returns this is DMChannel | TextChannel | GroupChannel

  True if the channel is a text-based channel, otherwise false.

isVoice

• isVoice(): this is VoiceChannel

  Checks if the channel is a voice channel.

  Returns this is VoiceChannel

  True if the channel is a voice channel, otherwise false.

sendWebhookMessage

• sendWebhookMessage(
      webhookId: string,
      token: string,
      content: string | MessageOptions,
  ): Promise<
      {
          _id: string;
          attachments?: | {
              _id: string;
              content_type: string;
              deleted?: boolean
              | null;
              filename: string;
              message_id?: string | null;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | { height: number; type: "Image"; width: number }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: string | null;
              reported?: boolean | null;
              server_id?: string | null;
              size: number;
              tag: string;
              user_id?: string | null;
          }[]
          | null;
          author: string;
          channel: string;
          content?: string
          | null;
          edited?: string | null;
          embeds?:
              | (
                  | {
                      colour?: string
                      | null;
                      description?: string | null;
                      icon_url?: string | null;
                      image?:
                          | {
                              height: number;
                              size: "Large"
                              | "Preview";
                              url: string;
                              width: number;
                          }
                          | null;
                      original_url?: string
                      | null;
                      site_name?: string | null;
                      special?:
                          | { type: "None" }
                          | { type: "GIF" }
                          | { id: string; timestamp?: string | null; 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?: string | null; type: "AppleMusic" }
                          | { id: string; type: "Streamable" }
                          | null;
                      title?: string | null;
                      type: "Website";
                      url?: string | null;
                      video?: { height: number; url: string; width: number } | null;
                  }
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      type: "Image";
                      url: string;
                      width: number;
                  }
                  | { height: number; type: "Video"; url: string; width: number }
                  | {
                      colour?: string | null;
                      description?: string | null;
                      icon_url?: string | null;
                      media?:
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: boolean
                              | null;
                              filename: string;
                              message_id?: string | null;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: string | null;
                              reported?: boolean | null;
                              server_id?: string | null;
                              size: number;
                              tag: string;
                              user_id?: string | null;
                          }
                          | null;
                      title?: string
                      | null;
                      type: "Text";
                      url?: string | null;
                  }
                  | { type: "None" }
              )[]
              | null;
          flags?: number;
          interactions?: {
              reactions?: string[] | null;
              restrict_reactions?: boolean;
          };
          masquerade?: | {
              avatar?: string
              | null;
              colour?: string | null;
              name?: string | null;
          }
          | null;
          member?: | {
              _id: { server: string; user: string };
              avatar?:
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: boolean
                      | null;
                      filename: string;
                      message_id?: string | null;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: string | null;
                      reported?: boolean | null;
                      server_id?: string | null;
                      size: number;
                      tag: string;
                      user_id?: string | null;
                  }
                  | null;
              joined_at: string;
              nickname?: string
              | null;
              roles?: string[];
              timeout?: string | null;
          }
          | null;
          mentions?: string[]
          | null;
          nonce?: string | null;
          pinned?: boolean | null;
          reactions?: { [key: string]: string[] };
          replies?: string[] | null;
          role_mentions?: string[] | null;
          system?:
              | { 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" }
              | null;
          user?:
              | {
                  _id: string;
                  avatar?: | {
                      _id: string;
                      content_type: string;
                      deleted?: boolean
                      | null;
                      filename: string;
                      message_id?: string | null;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: string | null;
                      reported?: boolean | null;
                      server_id?: string | null;
                      size: number;
                      tag: string;
                      user_id?: string | null;
                  }
                  | null;
                  badges?: number;
                  bot?: { owner: string }
                  | null;
                  discriminator: string;
                  display_name?: string | null;
                  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?: | {
                      presence?: "Online"
                      | "Idle"
                      | "Focus"
                      | "Busy"
                      | "Invisible"
                      | null;
                      text?: string | null;
                  }
                  | null;
                  username: string;
              }
              | null;
          webhook?: { avatar?: string | null; name: string }
          | null;
      },
  >

  Sends a message through a webhook in this channel.

  Parameters

  • webhookId: string

    The ID of the webhook to send the message through

  • token: string

    The token of the webhook

  • content: string | MessageOptions

    The message content. Can be a string or MessageOptions object with attachments and embeds

  Returns Promise<
      {
          _id: string;
          attachments?: | {
              _id: string;
              content_type: string;
              deleted?: boolean
              | null;
              filename: string;
              message_id?: string | null;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | { height: number; type: "Image"; width: number }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: string | null;
              reported?: boolean | null;
              server_id?: string | null;
              size: number;
              tag: string;
              user_id?: string | null;
          }[]
          | null;
          author: string;
          channel: string;
          content?: string
          | null;
          edited?: string | null;
          embeds?:
              | (
                  | {
                      colour?: string
                      | null;
                      description?: string | null;
                      icon_url?: string | null;
                      image?:
                          | {
                              height: number;
                              size: "Large"
                              | "Preview";
                              url: string;
                              width: number;
                          }
                          | null;
                      original_url?: string
                      | null;
                      site_name?: string | null;
                      special?:
                          | { type: "None" }
                          | { type: "GIF" }
                          | { id: string; timestamp?: string | null; 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?: string | null; type: "AppleMusic" }
                          | { id: string; type: "Streamable" }
                          | null;
                      title?: string | null;
                      type: "Website";
                      url?: string | null;
                      video?: { height: number; url: string; width: number } | null;
                  }
                  | {
                      height: number;
                      size: "Large"
                      | "Preview";
                      type: "Image";
                      url: string;
                      width: number;
                  }
                  | { height: number; type: "Video"; url: string; width: number }
                  | {
                      colour?: string | null;
                      description?: string | null;
                      icon_url?: string | null;
                      media?:
                          | {
                              _id: string;
                              content_type: string;
                              deleted?: boolean
                              | null;
                              filename: string;
                              message_id?: string | null;
                              metadata:
                                  | { type: "File" }
                                  | { type: "Text" }
                                  | { height: number; type: "Image"; width: number }
                                  | { height: number; type: "Video"; width: number }
                                  | { type: "Audio" };
                              object_id?: string | null;
                              reported?: boolean | null;
                              server_id?: string | null;
                              size: number;
                              tag: string;
                              user_id?: string | null;
                          }
                          | null;
                      title?: string
                      | null;
                      type: "Text";
                      url?: string | null;
                  }
                  | { type: "None" }
              )[]
              | null;
          flags?: number;
          interactions?: {
              reactions?: string[] | null;
              restrict_reactions?: boolean;
          };
          masquerade?: | {
              avatar?: string
              | null;
              colour?: string | null;
              name?: string | null;
          }
          | null;
          member?: | {
              _id: { server: string; user: string };
              avatar?:
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: boolean
                      | null;
                      filename: string;
                      message_id?: string | null;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: string | null;
                      reported?: boolean | null;
                      server_id?: string | null;
                      size: number;
                      tag: string;
                      user_id?: string | null;
                  }
                  | null;
              joined_at: string;
              nickname?: string
              | null;
              roles?: string[];
              timeout?: string | null;
          }
          | null;
          mentions?: string[]
          | null;
          nonce?: string | null;
          pinned?: boolean | null;
          reactions?: { [key: string]: string[] };
          replies?: string[] | null;
          role_mentions?: string[] | null;
          system?:
              | { 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" }
              | null;
          user?:
              | {
                  _id: string;
                  avatar?: | {
                      _id: string;
                      content_type: string;
                      deleted?: boolean
                      | null;
                      filename: string;
                      message_id?: string | null;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: string | null;
                      reported?: boolean | null;
                      server_id?: string | null;
                      size: number;
                      tag: string;
                      user_id?: string | null;
                  }
                  | null;
                  badges?: number;
                  bot?: { owner: string }
                  | null;
                  discriminator: string;
                  display_name?: string | null;
                  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?: | {
                      presence?: "Online"
                      | "Idle"
                      | "Focus"
                      | "Busy"
                      | "Invisible"
                      | null;
                      text?: string | null;
                  }
                  | null;
                  username: string;
              }
              | null;
          webhook?: { avatar?: string | null; name: string }
          | null;
      },
  >

  Promise resolving to the sent message

  Example

  // Send a simple text message
  await channel.sendWebhookMessage("webhookId", "token", "Hello, world!");
  
  // Send a message with embeds and attachments
  await channel.sendWebhookMessage("webhookId", "token", {
    content: "Check out this image!",
    attachments: ["https://example.com/image.png"],
    embeds: [myEmbed]
  });
  Copy

setDefaultPermissions

• setDefaultPermissions(
      allow:
          | (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[]
          | undefined,
  ): Promise<void>

  Sets default permissions for this channel.

  Parameters

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

    Array of permissions to allow by default.

  Returns Promise<void>

  A promise that resolves when the permissions have been updated.

  Throws

  If the channel ID is invalid.

  Example

  // Allow specific permissions
  await channel.setDefaultPermissions(["ViewChannel", "SendMessage"]);
  Copy

• setDefaultPermissions(
      options: {
          allow?: (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[];
          deny?: (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[];
      },
  ): Promise<void>

  Sets default permissions for this channel.

  Parameters

  • options: {
        allow?: (
            | "ManageChannel"
            | "ManageServer"
            | "ManagePermissions"
            | "ManageRole"
            | "ManageCustomisation"
            | "KickMembers"
            | "BanMembers"
            | "TimeoutMembers"
            | "AssignRoles"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ChangeAvatar"
            | "RemoveAvatars"
            | "ViewChannel"
            | "ReadMessageHistory"
            | "SendMessage"
            | "ManageMessages"
            | "ManageWebhooks"
            | "InviteOthers"
            | "SendEmbeds"
            | "UploadFiles"
            | "Masquerade"
            | "React"
            | "Connect"
            | "Speak"
            | "Video"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "MentionEveryone"
            | "MentionRoles"
            | "GrantAll"
        )[];
        deny?: (
            | "ManageChannel"
            | "ManageServer"
            | "ManagePermissions"
            | "ManageRole"
            | "ManageCustomisation"
            | "KickMembers"
            | "BanMembers"
            | "TimeoutMembers"
            | "AssignRoles"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ChangeAvatar"
            | "RemoveAvatars"
            | "ViewChannel"
            | "ReadMessageHistory"
            | "SendMessage"
            | "ManageMessages"
            | "ManageWebhooks"
            | "InviteOthers"
            | "SendEmbeds"
            | "UploadFiles"
            | "Masquerade"
            | "React"
            | "Connect"
            | "Speak"
            | "Video"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "MentionEveryone"
            | "MentionRoles"
            | "GrantAll"
        )[];
    }

    Object containing allow and/or deny permissions.

  Returns Promise<void>

  A promise that resolves when the permissions have been updated.

  Throws

  If the channel ID is invalid or if both allow and deny are undefined.

  Example

  // Allow specific permissions only
  await channel.setDefaultPermissions({ allow: ["ViewChannel", "SendMessage"] });
  
  // Deny specific permissions only
  await channel.setDefaultPermissions({ deny: ["ManageMessages"] });
  
  // Set both allow and deny permissions
  await channel.setDefaultPermissions({
    allow: ["ViewChannel"],
    deny: ["ManageMessages"]
  });
  Copy

• setDefaultPermissions(permissions: editablePermissions): Promise<void>

  Sets default permissions for this channel (legacy format).

  Parameters

  • permissions: editablePermissions

    Object containing allow and deny permissions.

  Returns Promise<void>

  A promise that resolves when the permissions have been updated.

  Throws

  If the channel ID is invalid.

  Example

  // Legacy format
  await channel.setDefaultPermissions({
    a: ["ViewChannel"],
    d: ["ManageMessages"]
  });
  Copy

setRolePermissions

• setRolePermissions(
      roleId: string,
      allow:
          | (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[]
          | undefined,
  ): Promise<void>

  Sets role permissions for this channel.

  Parameters

  • roleId: string

    The ID of the role to set permissions for.

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

    Array of permissions to allow for the role.

  Returns Promise<void>

  A promise that resolves when the permissions have been updated.

  Throws

  If the channel ID is invalid.

  Example

  // Allow specific permissions
  await channel.setRolePermissions(roleId, ["ViewChannel", "SendMessage"]);
  Copy

• setRolePermissions(
      roleId: string,
      allow:
          | (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[]
          | undefined,
      deny:
          | (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[]
          | undefined,
  ): Promise<void>

  Sets role permissions for this channel.

  Parameters

  • roleId: string

    The ID of the role to set permissions for.

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

    Array of permissions to allow for the role.

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

    Array of permissions to deny for the role.

  Returns Promise<void>

  A promise that resolves when the permissions have been updated.

  Throws

  If the channel ID is invalid.

  Example

  // Set both allow and deny permissions
  await channel.setRolePermissions(roleId, ["ViewChannel"], ["ManageMessages"]);
  Copy

• setRolePermissions(
      roleId: string,
      options: {
          allow?: (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[];
          deny?: (
              | "ManageChannel"
              | "ManageServer"
              | "ManagePermissions"
              | "ManageRole"
              | "ManageCustomisation"
              | "KickMembers"
              | "BanMembers"
              | "TimeoutMembers"
              | "AssignRoles"
              | "ChangeNickname"
              | "ManageNicknames"
              | "ChangeAvatar"
              | "RemoveAvatars"
              | "ViewChannel"
              | "ReadMessageHistory"
              | "SendMessage"
              | "ManageMessages"
              | "ManageWebhooks"
              | "InviteOthers"
              | "SendEmbeds"
              | "UploadFiles"
              | "Masquerade"
              | "React"
              | "Connect"
              | "Speak"
              | "Video"
              | "MuteMembers"
              | "DeafenMembers"
              | "MoveMembers"
              | "MentionEveryone"
              | "MentionRoles"
              | "GrantAll"
          )[];
      },
  ): Promise<void>

  Sets role permissions for this channel.

  Parameters

  • roleId: string

    The ID of the role to set permissions for.

  • options: {
        allow?: (
            | "ManageChannel"
            | "ManageServer"
            | "ManagePermissions"
            | "ManageRole"
            | "ManageCustomisation"
            | "KickMembers"
            | "BanMembers"
            | "TimeoutMembers"
            | "AssignRoles"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ChangeAvatar"
            | "RemoveAvatars"
            | "ViewChannel"
            | "ReadMessageHistory"
            | "SendMessage"
            | "ManageMessages"
            | "ManageWebhooks"
            | "InviteOthers"
            | "SendEmbeds"
            | "UploadFiles"
            | "Masquerade"
            | "React"
            | "Connect"
            | "Speak"
            | "Video"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "MentionEveryone"
            | "MentionRoles"
            | "GrantAll"
        )[];
        deny?: (
            | "ManageChannel"
            | "ManageServer"
            | "ManagePermissions"
            | "ManageRole"
            | "ManageCustomisation"
            | "KickMembers"
            | "BanMembers"
            | "TimeoutMembers"
            | "AssignRoles"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ChangeAvatar"
            | "RemoveAvatars"
            | "ViewChannel"
            | "ReadMessageHistory"
            | "SendMessage"
            | "ManageMessages"
            | "ManageWebhooks"
            | "InviteOthers"
            | "SendEmbeds"
            | "UploadFiles"
            | "Masquerade"
            | "React"
            | "Connect"
            | "Speak"
            | "Video"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "MentionEveryone"
            | "MentionRoles"
            | "GrantAll"
        )[];
    }

    Object containing allow and/or deny permissions.

  Returns Promise<void>

  A promise that resolves when the permissions have been updated.

  Throws

  If the channel ID is invalid or if both allow and deny are undefined.

  Example

  // Allow specific permissions only
  await channel.setRolePermissions(roleId, { allow: ["ViewChannel", "SendMessage"] });
  
  // Deny specific permissions only
  await channel.setRolePermissions(roleId, { deny: ["ManageMessages"] });
  
  // Set both allow and deny permissions
  await channel.setRolePermissions(roleId, {
    allow: ["ViewChannel"],
    deny: ["ManageMessages"]
  });
  Copy

toString

• toString(): string

  Converts the channel to a string representation.

  Returns string

  A string representation of the channel in the format <#channelId>.