gluon
    Preparing search index...

    Class TextChannel

    Represents a text channel within Discord.

    https://discord.com/developers/docs/resources/channel#channel-object-example-guild-text-channel

    Hierarchy (View Summary)

    Implements

    • TextChannel
    Index

    Constructors

    constructor

    Accessors

    _cacheOptions guild guildId id mention messages name nsfw parent parentId permissionOverwrites position rateLimitPerUser topic type

    Methods

    [custom] bulkDelete checkPermission send toJSON toString fetchWebhooks follow getMention shouldCache

    Constructors

    • Creates the structure for a text channel.

      Parameters

      • client: Client

        The client instance.

      • data:
            | GuildChannelCacheJSON
            | GuildChannelDiscordJSON
            | GuildChannelStorageJSON
            | APIGuildTextChannel<GuildTextChannelType>
            | APIGuildTextChannel<GuildForum>
            | APIGuildTextChannel<GuildMedia>

        Raw channel data.

      • options: { guildId: string; nocache?: boolean }

        Additional options for this structure.

        • guildId: string

          The ID of the guild that this channel belongs to.

        • Optionalnocache?: boolean

          Whether this channel should be cached or not.

      Returns TextChannel

      https://discord.com/developers/docs/resources/channel#channel-object-example-guild-text-channel

    Accessors

    _cacheOptions

    • get _cacheOptions(): ChannelCacheOptions

      The cache options for this channel.

      Returns ChannelCacheOptions

    • get guild(): null | Guild

      The guild that this channel belongs to.

      Returns null | Guild

    • get guildId(): string

      The ID of the guild that this channel belongs to.

      Returns string

    • get mention(): string

      Returns the mention for this channel.

      Returns string

    • get messages(): ChannelMessageManager

      The messages in this channel.

      Returns ChannelMessageManager

    • get name(): string

      The name of the channel.

      Returns string

    • get nsfw(): boolean

      Whether this channel is marked as NSFW or not.

      Returns boolean

    • get parent(): null | AllChannels

      The parent channel.

      Returns null | AllChannels

    • get parentId(): null | string

      The ID of the parent channel.

      Returns null | string

    • get permissionOverwrites(): PermissionOverwrite[]

      The permission overwrites for this channel.

      Returns PermissionOverwrite[]

    • get position(): undefined | number

      The position of the channel.

      Returns undefined | number

    • get rateLimitPerUser(): undefined | number

      The message send cooldown for the channel.

      Returns undefined | number

    • get topic(): null | string

      The topic of the channel.

      Returns null | string

    • get type(): ChannelType

      The type of channel.

      Returns ChannelType

    Methods

    • Bulk deletes all the message IDs provided.

      Parameters

      • messages: string[]

        An array of message IDs, as strings.

      • Optionaloptions: { reason?: string } = {}

        Additional options for this method.

        • Optionalreason?: string

          The reason for this action.

      Returns Promise<void>

    • Returns the permissions for a member in this channel.

      Parameters

      • member: Member

        The member to check the permissions for.

      Returns string

    • Sends a message to this channel.

      Parameters

      • Optionaldata: {
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
            suppressMentions?: boolean;
        }

        Embeds, components and files to include with the message.

        • Optionalcomponents?: MessageComponents

          The components to include with the message.

        • Optionalcontent?: string

          The content of the message.

        • Optionalembeds?: Embed[]

          The embeds to include with the message.

        • Optionalfiles?: FileUpload[]

          The files to include with the message.

        • OptionalsuppressMentions?: boolean

          Whether to suppress mentions in the message.

      Returns Promise<Message>

      https://discord.com/developers/docs/resources/channel#create-message

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns
          | {
              _attributes: number;
              _cache_options: number;
              id: string;
              messages: MessageCacheJSON[];
              name: string;
              parent_id?: null
              | string;
              permission_overwrites: PermissionOverwriteCacheJSON[];
              position?: number;
              rate_limit_per_user?: number;
              topic?: string;
              type: ChannelType;
          }
          | {
              id: string;
              messages: MessageDiscordJSON[];
              name: string;
              nsfw: boolean;
              parent_id?: null
              | string;
              permission_overwrites: PermissionOverwriteDiscordJSON[];
              position?: number;
              rate_limit_per_user?: number;
              topic?: string;
              type: ChannelType;
          }
          | {
              _attributes: number;
              _cache_options: number;
              id: string;
              messages: MessageStorageJSON[];
              name: string;
              parent_id?: null
              | string;
              permission_overwrites: PermissionOverwriteStorageJSON[];
              position?: number;
              rate_limit_per_user?: number;
              topic?: string;
              type: ChannelType;
          }

    • Returns an array of webhooks for the specified channel.

      Parameters

      • client: Client

        The client instance.

      • channelId: string

        The ID of the channel.

      Returns Promise<APIWebhook[]>

    • Follows a news channel.

      Parameters

      • client: Client

        The client instance.

      • channelId: string

        The ID of the channel.

      • followChannelId: string

        THe ID of the channel to follow.

      Returns Promise<void>

    • Determines whether the channel should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      • guildCacheOptions: GuildCacheOptions

        The cache options for the guild.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods