Skip to main content

Channel

@discordeno/bot

Documentation / @discordeno/bot / Channel

Interface: Channel

Defined in: packages/bot/src/transformers/types.ts:375

Properties​

applicationId?​

optional applicationId: bigint

Defined in: packages/bot/src/transformers/types.ts:438

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

appliedTags?​

optional appliedTags: bigint[]

Defined in: packages/bot/src/transformers/types.ts:444

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: packages/bot/src/transformers/types.ts:463

Whether the thread is archived

availableTags?​

optional availableTags: ForumTag[]

Defined in: packages/bot/src/transformers/types.ts:442

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

bitrate?​

optional bitrate: number

Defined in: packages/bot/src/transformers/types.ts:393

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

defaultAutoArchiveDuration?​

optional defaultAutoArchiveDuration: number

Defined in: packages/bot/src/transformers/types.ts:421

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: packages/bot/src/transformers/types.ts:451

defaultReactionEmoji?​

optional defaultReactionEmoji: DefaultReactionEmoji

Defined in: packages/bot/src/transformers/types.ts:446

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

defaultSortOrder?​

optional defaultSortOrder: null | SortOrderTypes

Defined in: packages/bot/src/transformers/types.ts:450

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: packages/bot/src/transformers/types.ts:448

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: packages/bot/src/transformers/types.ts:425

The flags of the channel

guildId?​

optional guildId: bigint

Defined in: packages/bot/src/transformers/types.ts:383

The id of the guild

icon?​

optional icon: bigint

Defined in: packages/bot/src/transformers/types.ts:436

Icon hash of the group dm

id​

id: bigint

Defined in: packages/bot/src/transformers/types.ts:377

The id of the channel

internalOverwrites?​

optional internalOverwrites: bigint[]

Defined in: packages/bot/src/transformers/types.ts:432

Internal

Explicit permission overwrites for members and roles

Use channel.permissionOverwrites. This is for internal use only, and prone to breaking changes.

internalThreadMetadata?​

optional internalThreadMetadata: InternalChannelThreadMetadata

Defined in: packages/bot/src/transformers/types.ts:418

Internal

Thread-specific fields not needed by other channels.

This field is an internal field, subject to breaking changes.

invitable​

invitable: boolean

Defined in: packages/bot/src/transformers/types.ts:461

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

lastMessageId?​

optional lastMessageId: bigint

Defined in: packages/bot/src/transformers/types.ts:391

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: packages/bot/src/transformers/types.ts:403

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: packages/bot/src/transformers/types.ts:459

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

managed​

managed: boolean

Defined in: packages/bot/src/transformers/types.ts:465

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

member?​

optional member: ThreadMember

Defined in: packages/bot/src/transformers/types.ts:419

memberCount?​

optional memberCount: number

Defined in: packages/bot/src/transformers/types.ts:411

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

messageCount?​

optional messageCount: number

Defined in: packages/bot/src/transformers/types.ts:409

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

name?​

optional name: string

Defined in: packages/bot/src/transformers/types.ts:387

The name of the channel (1-100 characters)

newlyCreated​

newlyCreated: boolean

Defined in: packages/bot/src/transformers/types.ts:457

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

nsfw​

nsfw: boolean

Defined in: packages/bot/src/transformers/types.ts:453

Whether the channel is nsfw

ownerId?​

optional ownerId: bigint

Defined in: packages/bot/src/transformers/types.ts:399

Id of the creator of the thread

parentId?​

optional parentId: bigint

Defined in: packages/bot/src/transformers/types.ts:401

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: OverwriteReadable[]

Defined in: packages/bot/src/transformers/types.ts:467

Explicit permission overwrites for members and roles.

permissions?​

optional permissions: Permissions

Defined in: packages/bot/src/transformers/types.ts:423

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

position?​

optional position: number

Defined in: packages/bot/src/transformers/types.ts:385

Sorting position of the channel

rateLimitPerUser?​

optional rateLimitPerUser: number

Defined in: packages/bot/src/transformers/types.ts:397

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: packages/bot/src/transformers/types.ts:434

The recipients of a group dm

rtcRegion?​

optional rtcRegion: string

Defined in: packages/bot/src/transformers/types.ts:405

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

threadMetadata?​

optional threadMetadata: ChannelThreadMetadata

Defined in: packages/bot/src/transformers/types.ts:455

Thread-specific fields not needed by other channels

toggles​

toggles: ChannelToggles

Defined in: packages/bot/src/transformers/types.ts:379

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

topic?​

optional topic: string

Defined in: packages/bot/src/transformers/types.ts:389

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

totalMessageSent?​

optional totalMessageSent: number

Defined in: packages/bot/src/transformers/types.ts:440

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: packages/bot/src/transformers/types.ts:381

The type of channel

userLimit?​

optional userLimit: number

Defined in: packages/bot/src/transformers/types.ts:395

The user limit of the voice or stage channel

videoQualityMode?​

optional videoQualityMode: VideoQualityModes

Defined in: packages/bot/src/transformers/types.ts:407

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