Skip to main content

Channel

Documentation

Documentation / @discordeno/bot / Channel

Interface: Channel

Defined in: transformers/types.ts:422

Properties​

applicationId?​

optional applicationId: bigint

Defined in: transformers/types.ts:485

Application id of the group DM creator if it is bot-created

appliedTags?​

optional appliedTags: bigint[]

Defined in: transformers/types.ts:491

The IDs of the set of tags that have been applied to a thread in a GUILD_FORUM or a GUILD_MEDIA channel

archived​

archived: boolean

Defined in: transformers/types.ts:510

Whether the thread is archived

availableTags?​

optional availableTags: ForumTag[]

Defined in: transformers/types.ts:489

The set of tags that can be used in a GUILD_FORUM or a GUILD_MEDIA channel

bitrate?​

optional bitrate: number

Defined in: transformers/types.ts:440

The bitrate (in bits) of the voice or stage channel

defaultAutoArchiveDuration?​

optional defaultAutoArchiveDuration: number

Defined in: transformers/types.ts:468

Default duration for newly created threads, in minutes, to automatically archive the thread after recent activity, can be set to: 60, 1440, 4320, 10080

defaultForumLayout?​

optional defaultForumLayout: ForumLayout

Defined in: transformers/types.ts:498

defaultReactionEmoji?​

optional defaultReactionEmoji: DefaultReactionEmoji

Defined in: transformers/types.ts:493

The emoji to show in the add reaction button on a thread in a GUILD_FORUM or a GUILD_MEDIA channel

defaultSortOrder?​

optional defaultSortOrder: SortOrderTypes | null

Defined in: transformers/types.ts:497

The default sort order type used to order posts in GUILD_FORUM and GUILD_MEDIA channels. Defaults to null, which indicates a preferred sort order hasn't been set by a channel admin

defaultThreadRateLimitPerUser?​

optional defaultThreadRateLimitPerUser: number

Defined in: transformers/types.ts:495

the initial rateLimitPerUser to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update.

flags?​

optional flags: number

Defined in: transformers/types.ts:472

The flags of the channel

guildId?​

optional guildId: bigint

Defined in: transformers/types.ts:430

The id of the guild

icon?​

optional icon: bigint

Defined in: transformers/types.ts:483

Icon hash of the group dm

id​

id: bigint

Defined in: transformers/types.ts:424

The id of the channel

invitable​

invitable: boolean

Defined in: transformers/types.ts:508

whether non-moderators can add other non-moderators to a thread; only available on private threads

lastMessageId?​

optional lastMessageId: bigint

Defined in: transformers/types.ts:438

The id of the last message sent in this channel (may not point to an existing or valid message)

lastPinTimestamp?​

optional lastPinTimestamp: number

Defined in: transformers/types.ts:450

When the last pinned message was pinned. This may be null in events such as GUILD_CREATE when a message is not pinned.

locked​

locked: boolean

Defined in: transformers/types.ts:506

When a thread is locked, only users with MANAGE_THREADS can unarchive it

managed​

managed: boolean

Defined in: transformers/types.ts:512

for group DM channels: whether the channel is managed by an application via the gdm.join OAuth2 scope

member?​

optional member: ThreadMember

Defined in: transformers/types.ts:466

memberCount?​

optional memberCount: number

Defined in: transformers/types.ts:458

An approximate count of users in a thread, stops counting at 50

messageCount?​

optional messageCount: number

Defined in: transformers/types.ts:456

An approximate count of messages in a thread, stops counting at 50

name?​

optional name: string

Defined in: transformers/types.ts:434

The name of the channel (1-100 characters)

newlyCreated​

newlyCreated: boolean

Defined in: transformers/types.ts:504

When a thread is created this will be true on that channel payload for the thread.

nsfw​

nsfw: boolean

Defined in: transformers/types.ts:500

Whether the channel is nsfw

ownerId?​

optional ownerId: bigint

Defined in: transformers/types.ts:446

Id of the creator of the thread

parentId?​

optional parentId: bigint

Defined in: transformers/types.ts:448

For guild channels: Id of the parent category for a channel (each parent category can contain up to 50 channels), for threads: id of the text channel this thread was created

permissionOverwrites​

permissionOverwrites: object[]

Defined in: transformers/types.ts:514

Explicit permission overwrites for members and roles.

allow​

allow: ("CREATE_INSTANT_INVITE" | "KICK_MEMBERS" | "BAN_MEMBERS" | "ADMINISTRATOR" | "MANAGE_CHANNELS" | "MANAGE_GUILD" | "ADD_REACTIONS" | "VIEW_AUDIT_LOG" | "PRIORITY_SPEAKER" | "STREAM" | "VIEW_CHANNEL" | "SEND_MESSAGES" | "SEND_TTS_MESSAGES" | "MANAGE_MESSAGES" | "EMBED_LINKS" | "ATTACH_FILES" | "READ_MESSAGE_HISTORY" | "MENTION_EVERYONE" | "USE_EXTERNAL_EMOJIS" | "VIEW_GUILD_INSIGHTS" | "CONNECT" | "SPEAK" | "MUTE_MEMBERS" | "DEAFEN_MEMBERS" | "MOVE_MEMBERS" | "USE_VAD" | "CHANGE_NICKNAME" | "MANAGE_NICKNAMES" | "MANAGE_ROLES" | "MANAGE_WEBHOOKS" | "MANAGE_GUILD_EXPRESSIONS" | "USE_SLASH_COMMANDS" | "REQUEST_TO_SPEAK" | "MANAGE_EVENTS" | "MANAGE_THREADS" | "CREATE_PUBLIC_THREADS" | "CREATE_PRIVATE_THREADS" | "USE_EXTERNAL_STICKERS" | "SEND_MESSAGES_IN_THREADS" | "USE_EMBEDDED_ACTIVITIES" | "MODERATE_MEMBERS" | "VIEW_CREATOR_MONETIZATION_ANALYTICS" | "USE_SOUNDBOARD" | "CREATE_GUILD_EXPRESSIONS" | "CREATE_EVENTS" | "USE_EXTERNAL_SOUNDS" | "SEND_VOICE_MESSAGES" | "SEND_POLLS" | "USE_EXTERNAL_APPS" | "PIN_MESSAGES" | "BYPASS_SLOWMODE")[]

Permission bit set

deny​

deny: ("CREATE_INSTANT_INVITE" | "KICK_MEMBERS" | "BAN_MEMBERS" | "ADMINISTRATOR" | "MANAGE_CHANNELS" | "MANAGE_GUILD" | "ADD_REACTIONS" | "VIEW_AUDIT_LOG" | "PRIORITY_SPEAKER" | "STREAM" | "VIEW_CHANNEL" | "SEND_MESSAGES" | "SEND_TTS_MESSAGES" | "MANAGE_MESSAGES" | "EMBED_LINKS" | "ATTACH_FILES" | "READ_MESSAGE_HISTORY" | "MENTION_EVERYONE" | "USE_EXTERNAL_EMOJIS" | "VIEW_GUILD_INSIGHTS" | "CONNECT" | "SPEAK" | "MUTE_MEMBERS" | "DEAFEN_MEMBERS" | "MOVE_MEMBERS" | "USE_VAD" | "CHANGE_NICKNAME" | "MANAGE_NICKNAMES" | "MANAGE_ROLES" | "MANAGE_WEBHOOKS" | "MANAGE_GUILD_EXPRESSIONS" | "USE_SLASH_COMMANDS" | "REQUEST_TO_SPEAK" | "MANAGE_EVENTS" | "MANAGE_THREADS" | "CREATE_PUBLIC_THREADS" | "CREATE_PRIVATE_THREADS" | "USE_EXTERNAL_STICKERS" | "SEND_MESSAGES_IN_THREADS" | "USE_EMBEDDED_ACTIVITIES" | "MODERATE_MEMBERS" | "VIEW_CREATOR_MONETIZATION_ANALYTICS" | "USE_SOUNDBOARD" | "CREATE_GUILD_EXPRESSIONS" | "CREATE_EVENTS" | "USE_EXTERNAL_SOUNDS" | "SEND_VOICE_MESSAGES" | "SEND_POLLS" | "USE_EXTERNAL_APPS" | "PIN_MESSAGES" | "BYPASS_SLOWMODE")[]

Permission bit set

id​

id: bigint

Role or user id

type​

type: OverwriteTypes

Either 0 (role) or 1 (member)

permissions?​

optional permissions: Permissions

Defined in: transformers/types.ts:470

computed permissions for the invoking user in the channel, including overwrites, only included when part of the resolved data received on an interaction. This does not include implicit permissions, which may need to be checked separately.

position?​

optional position: number

Defined in: transformers/types.ts:432

Sorting position of the channel

rateLimitPerUser?​

optional rateLimitPerUser: number

Defined in: transformers/types.ts:444

Amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission manage_messages or manage_channel, are unaffected

recipients?​

optional recipients: User[]

Defined in: transformers/types.ts:481

The recipients of a group dm

rtcRegion?​

optional rtcRegion: string

Defined in: transformers/types.ts:452

Voice region id for the voice or stage channel, automatic when set to null

threadMetadata?​

optional threadMetadata: ChannelThreadMetadata

Defined in: transformers/types.ts:502

Thread-specific fields not needed by other channels

toggles​

toggles: ChannelToggles

Defined in: transformers/types.ts:426

The compressed form of all the boolean values on this channel.

topic?​

optional topic: string

Defined in: transformers/types.ts:436

The channel topic (0-4096 characters for GUILD_FORUM channels, 0-1024 characters for all others)

totalMessageSent?​

optional totalMessageSent: number

Defined in: transformers/types.ts:487

Number of messages ever sent in a thread, it's similar to message_count on message creation, but will not decrement the number when a message is deleted

type​

type: ChannelTypes

Defined in: transformers/types.ts:428

The type of channel

userLimit?​

optional userLimit: number

Defined in: transformers/types.ts:442

The user limit of the voice or stage channel

videoQualityMode?​

optional videoQualityMode: VideoQualityModes

Defined in: transformers/types.ts:454

The camera video quality mode of the voice channel, 1 when not present