Skip to main content

DiscordChannel

Documentation

Documentation / @discordeno/types / DiscordChannel

Interface: DiscordChannel

Defined in: discord/channel.ts:8

https://docs.discord.com/developers/resources/channel#channel-object-channel-structure

Extends​

Properties​

application_id?​

optional application_id?: string

Defined in: discord/channel.ts:61

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

applied_tags?​

optional applied_tags?: string[]

Defined in: discord/channel.ts:121

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

available_tags?​

optional available_tags?: DiscordForumTag[]

Defined in: discord/channel.ts:119

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

bitrate?​

optional bitrate?: number

Defined in: discord/channel.ts:43

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

default_auto_archive_duration?​

optional default_auto_archive_duration?: number

Defined in: discord/channel.ts:104

Default duration for newly created threads, in minutes, to automatically archive the thread after recent activity.

Remarks​

Can be set to: 60, 1440, 4320, 10080

default_forum_layout?​

optional default_forum_layout?: ForumLayout

Defined in: discord/channel.ts:134

the default forum layout view used to display posts in GUILD_FORUM channels. Defaults to 0, which indicates a layout view has not been set by a channel admin

default_reaction_emoji?​

optional default_reaction_emoji?: DiscordDefaultReactionEmoji | null

Defined in: discord/channel.ts:123

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

default_sort_order?​

optional default_sort_order?: SortOrderTypes | null

Defined in: discord/channel.ts:132

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

default_thread_rate_limit_per_user?​

optional default_thread_rate_limit_per_user?: number

Defined in: discord/channel.ts:130

The initial rate_limit_per_user to set on newly created threads in a channel.

Remarks​

This field is copied to the thread at creation time and does not live update.

flags?​

optional flags?: ChannelFlags

Defined in: discord/channel.ts:115

The flags of the channel

guild_id?​

optional guild_id?: string

Defined in: discord/channel.ts:19

The id of the guild

Remarks​

May be missing for some channel object received over gateway guild dispatches

icon?​

optional icon?: string

Defined in: discord/channel.ts:57

icon hash of the group DM

id​

id: string

Defined in: discord/channel.ts:10

The id of the channel

last_message_id?​

optional last_message_id?: string | null

Defined in: discord/channel.ts:41

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

last_pin_timestamp?​

optional last_pin_timestamp?: string | null

Defined in: discord/channel.ts:79

When the last pinned message was pinned.

Remarks​

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

managed?​

optional managed?: boolean

Defined in: discord/channel.ts:63

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

member?​

optional member?: DiscordThreadMember

Defined in: discord/channel.ts:97

Thread member object for the current user, if they have joined the thread, only included on certain API endpoints

member_count?​

optional member_count?: number

Defined in: discord/channel.ts:93

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

message_count?​

optional message_count?: number

Defined in: discord/channel.ts:91

An approximate count of messages in a thread, does not include deleted messages or the initial message

Remarks​

For threads created before July 1, 2022, the message count is inaccurate when it's greater than 50.

name?​

optional name?: string

Defined in: discord/channel.ts:30

The name of the channel (1-100 characters)

newly_created?​

optional newly_created?: boolean

Defined in: discord/gateway.ts:379

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

Remarks​

The Thread Create event may fire for a few reasons, however this fields only exists when it is fired because a thread was created.

Inherited from​

DiscordThreadCreateExtra.newly_created

nsfw?​

optional nsfw?: boolean

Defined in: discord/channel.ts:39

Whether the channel is nsfw

owner_id?​

optional owner_id?: string

Defined in: discord/channel.ts:59

Id of the creator of the group DM or the thread

parent_id?​

optional parent_id?: string | null

Defined in: discord/channel.ts:72

Id of the parent channel.

Remarks​

For a guild channel this will reference a category ID, each category can contain up to 50 channels.

For threads this will reference the text channel the thread was created in.

permission_overwrites?​

optional permission_overwrites?: DiscordOverwrite[]

Defined in: discord/channel.ts:28

Explicit permission overwrites for members and roles

permissions?​

optional permissions?: string

Defined in: discord/channel.ts:113

Computed permissions for the invoking user in the channel.

Remarks​

The computed permissions include channel overwrites but does not include implicit permissions, those need to be checked separatly.

Only presented when part of resolved data received on an interaction.

position?​

optional position?: number

Defined in: discord/channel.ts:26

Sorting position of the channel

Remarks​

Channels with the same position are sorted by id

rate_limit_per_user?​

optional rate_limit_per_user?: number

Defined in: discord/channel.ts:53

Amount of seconds a user has to wait before sending another message (0-21600)

Remarks​

Bots, as well as users with the permission manage_messages or manage_channel, are unaffected rate_limit_per_user also applies to thread creation. Users can send one message and create one thread during each rate_limit_per_user interval.

recipients?​

optional recipients?: DiscordUser[]

Defined in: discord/channel.ts:55

the recipients of the DM

rtc_region?​

optional rtc_region?: string | null

Defined in: discord/channel.ts:81

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

thread_metadata?​

optional thread_metadata?: DiscordThreadMetadata

Defined in: discord/channel.ts:95

Thread-specific fields not needed by other channels

topic?​

optional topic?: string | null

Defined in: discord/channel.ts:37

The channel topic

Remarks​

The limit is max of 4096 characters for GUILD_FORUM channels and a max of 1024 characters for all others channel types

total_message_sent?​

optional total_message_sent?: number

Defined in: discord/channel.ts:117

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: discord/channel.ts:12

The type of channel

user_limit?​

optional user_limit?: number

Defined in: discord/channel.ts:45

The user limit of the voice or stage channel

video_quality_mode?​

optional video_quality_mode?: VideoQualityModes

Defined in: discord/channel.ts:83

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