Class GuildChannel

constructor

• new GuildChannel(data, client): GuildChannel

• Parameters

  • data: RawGuildChannel
  • client: Client<ClientEvents>

  Returns GuildChannel

guildID

name

parentID

type

guild

• get guild(): Guild

• The guild associated with this channel. This will throw an error if the guild is not cached.

  Returns Guild

isObfuscated

• get isObfuscated(): boolean

• If this channel's metadata has been obfuscated because the client can't view it. Requires the CHANNEL_OBFUSCATION capability.

  Returns boolean

parent

• get parent(): undefined | null | ParentChannelType<this>

• The parent of this channel, if applicable.

  If the channel is an AnnouncementThread, PublicThread, or PrivateThread, this will be a TextChannel, AnnouncementChannel, ForumChannel, or MediaChannel.

  If the channel is a TextChannel, VoiceChannel, AnnouncementChannel, ForumChannel, or MediaChannel, this will be a CategoryChannel.

  Returns undefined | null | ParentChannelType<this>

  If undefined, no attempt was made to resolve the parent channel. If null, the parent channel was attempted to be resolved but was not found in the client's cache.

edit

• edit(options): Promise<GuildChannel>

• Edit this channel.

  Parameters

  • options: EditTextChannelOptions | EditAnyGuildChannelOptions | EditVoiceChannelOptions | EditAnnouncementChannelOptions | EditPublicThreadChannelOptions | EditPrivateThreadChannelOptions | EditStageChannelOptions | EditForumChannelOptions | EditMediaChannelOptions

    The options for editing the channel.

  Returns Promise<GuildChannel>

getMemberPermissions

• getMemberPermissions(userID, options?): Promise<Permission>

• Get the computed permissions of a member in this channel, including their roles and member-specific overwrites. Requires the VIEW_CHANNEL permission, and CONNECT for voice and stage channels.

  Parameters

  • userID: string

    The ID of the member.
  • Optional options: GetChannelPermissionsOptions

    The options for getting the permissions.

  Returns Promise<Permission>

getRolePermissions

• getRolePermissions(roleID, options?): Promise<Permission>

• Get the permissions granted by a role together with @everyone in this channel, applying their overwrites. Requires the VIEW_CHANNEL permission, and CONNECT for voice and stage channels.

  Parameters

  • roleID: string

    The ID of the role.
  • Optional options: GetChannelPermissionsOptions

    The options for getting the permissions.

  Returns Promise<Permission>

toJSON

• toJSON(): JSONGuildChannel

• Returns JSONGuildChannel