Skip to main content

DiscordChannel

@discordeno/bot

Documentation / @discordeno/bot / DiscordChannel

Interface: DiscordChannel

Defined in: packages/types/dist/types/discord/channel.d.ts:6

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

Properties​

application_id?​

optional application_id: string

Defined in: packages/types/dist/types/discord/channel.d.ts:38

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

applied_tags?​

optional applied_tags: string[]

Defined in: packages/types/dist/types/discord/channel.d.ts:68

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

available_tags?​

optional available_tags: DiscordForumTag[]

Defined in: packages/types/dist/types/discord/channel.d.ts:66

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

bitrate?​

optional bitrate: number

Defined in: packages/types/dist/types/discord/channel.d.ts:26

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

default_auto_archive_duration?​

optional default_auto_archive_duration: number

Defined in: packages/types/dist/types/discord/channel.d.ts:58

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

default_forum_layout?​

optional default_forum_layout: ForumLayout

Defined in: packages/types/dist/types/discord/channel.d.ts:76

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: null | DiscordDefaultReactionEmoji

Defined in: packages/types/dist/types/discord/channel.d.ts:70

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

default_sort_order?​

optional default_sort_order: null | SortOrderTypes

Defined in: packages/types/dist/types/discord/channel.d.ts:74

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: packages/types/dist/types/discord/channel.d.ts:72

the initial rate_limit_per_user 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: ChannelFlags

Defined in: packages/types/dist/types/discord/channel.d.ts:62

The flags of the channel

guild_id?​

optional guild_id: string

Defined in: packages/types/dist/types/discord/channel.d.ts:12

The id of the guild

icon?​

optional icon: string

Defined in: packages/types/dist/types/discord/channel.d.ts:34

icon hash of the group DM

id​

id: string

Defined in: packages/types/dist/types/discord/channel.d.ts:8

The id of the channel

last_message_id?​

optional last_message_id: null | string

Defined in: packages/types/dist/types/discord/channel.d.ts:24

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

last_pin_timestamp?​

optional last_pin_timestamp: null | string

Defined in: packages/types/dist/types/discord/channel.d.ts:44

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

managed?​

optional managed: boolean

Defined in: packages/types/dist/types/discord/channel.d.ts:40

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

member?​

optional member: DiscordThreadMember

Defined in: packages/types/dist/types/discord/channel.d.ts:56

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: packages/types/dist/types/discord/channel.d.ts:52

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

message_count?​

optional message_count: number

Defined in: packages/types/dist/types/discord/channel.d.ts:50

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

name?​

optional name: string

Defined in: packages/types/dist/types/discord/channel.d.ts:18

The name of the channel (1-100 characters)

newly_created?​

optional newly_created: boolean

Defined in: packages/types/dist/types/discord/channel.d.ts:78

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

nsfw?​

optional nsfw: boolean

Defined in: packages/types/dist/types/discord/channel.d.ts:22

Whether the channel is nsfw

owner_id?​

optional owner_id: string

Defined in: packages/types/dist/types/discord/channel.d.ts:36

Id of the creator of the thread

parent_id?​

optional parent_id: null | string

Defined in: packages/types/dist/types/discord/channel.d.ts:42

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

permission_overwrites?​

optional permission_overwrites: DiscordOverwrite[]

Defined in: packages/types/dist/types/discord/channel.d.ts:16

Explicit permission overwrites for members and roles

permissions?​

optional permissions: string

Defined in: packages/types/dist/types/discord/channel.d.ts:60

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/types/dist/types/discord/channel.d.ts:14

Sorting position of the channel (channels with the same position are sorted by id)

rate_limit_per_user?​

optional rate_limit_per_user: number

Defined in: packages/types/dist/types/discord/channel.d.ts:30

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

Defined in: packages/types/dist/types/discord/channel.d.ts:32

the recipients of the DM

rtc_region?​

optional rtc_region: null | string

Defined in: packages/types/dist/types/discord/channel.d.ts:46

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

thread_metadata?​

optional thread_metadata: DiscordThreadMetadata

Defined in: packages/types/dist/types/discord/channel.d.ts:54

Thread-specific fields not needed by other channels

topic?​

optional topic: null | string

Defined in: packages/types/dist/types/discord/channel.d.ts:20

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

total_message_sent?​

optional total_message_sent: number

Defined in: packages/types/dist/types/discord/channel.d.ts:64

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/types/dist/types/discord/channel.d.ts:10

The type of channel

user_limit?​

optional user_limit: number

Defined in: packages/types/dist/types/discord/channel.d.ts:28

The user limit of the voice or stage channel

video_quality_mode?​

optional video_quality_mode: VideoQualityModes

Defined in: packages/types/dist/types/discord/channel.d.ts:48

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