Skip to main content

Channel

Documentation

Documentation / @discordeno/bot / Channel

Interface: Channel

Defined in: transformers/types.ts:472

Properties​

applicationId?​

optional applicationId?: bigint

Defined in: transformers/types.ts:537

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

appliedTags?​

optional appliedTags?: bigint[]

Defined in: transformers/types.ts:543

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

appPermissions?​

optional appPermissions?: Permissions

Defined in: transformers/types.ts:522

computed permissions for the bot 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

archived​

archived: boolean

Defined in: transformers/types.ts:562

Whether the thread is archived

availableTags?​

optional availableTags?: ForumTag[]

Defined in: transformers/types.ts:541

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:490

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

defaultAutoArchiveDuration?​

optional defaultAutoArchiveDuration?: number

Defined in: transformers/types.ts:518

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:550

defaultReactionEmoji?​

optional defaultReactionEmoji?: DefaultReactionEmoji

Defined in: transformers/types.ts:545

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:549

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:547

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:524

The flags of the channel

guildId?​

optional guildId?: bigint

Defined in: transformers/types.ts:480

The id of the guild

icon?​

optional icon?: bigint

Defined in: transformers/types.ts:535

Icon hash of the group dm

id​

id: bigint

Defined in: transformers/types.ts:474

The id of the channel

invitable​

invitable: boolean

Defined in: transformers/types.ts:560

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:488

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:500

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:558

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

managed​

managed: boolean

Defined in: transformers/types.ts:564

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:516

memberCount?​

optional memberCount?: number

Defined in: transformers/types.ts:508

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

messageCount?​

optional messageCount?: number

Defined in: transformers/types.ts:506

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

name?​

optional name?: string

Defined in: transformers/types.ts:484

The name of the channel (1-100 characters)

newlyCreated​

newlyCreated: boolean

Defined in: transformers/types.ts:556

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

nsfw​

nsfw: boolean

Defined in: transformers/types.ts:552

Whether the channel is age-restricted

ownerId?​

optional ownerId?: bigint

Defined in: transformers/types.ts:496

Id of the creator of the thread

parentId?​

optional parentId?: bigint

Defined in: transformers/types.ts:498

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:566

Explicit permission overwrites for members and roles.

allow​

allow: bigint

Permission bit set

deny​

deny: bigint

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:520

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:482

Sorting position of the channel

rateLimitPerUser?​

optional rateLimitPerUser?: number

Defined in: transformers/types.ts:494

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

recipients?​

optional recipients?: User[]

Defined in: transformers/types.ts:533

The recipients of a group dm

rtcRegion?​

optional rtcRegion?: string

Defined in: transformers/types.ts:502

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

threadMetadata?​

optional threadMetadata?: ChannelThreadMetadata

Defined in: transformers/types.ts:554

Thread-specific fields not needed by other channels

toggles​

toggles: ChannelToggles

Defined in: transformers/types.ts:476

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

topic?​

optional topic?: string

Defined in: transformers/types.ts:486

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:539

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:478

The type of channel

userLimit?​

optional userLimit?: number

Defined in: transformers/types.ts:492

The user limit of the voice or stage channel

videoQualityMode?​

optional videoQualityMode?: VideoQualityModes

Defined in: transformers/types.ts:504

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