Skip to main content

DiscordChannel

@discordeno/bot • Docs

Documentation / @discordeno/bot / DiscordChannel

Interface: DiscordChannel

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

Properties​

application_id?​

optional application_id: string

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

Defined in​

packages/types/dist/types/discord.d.ts:964

applied_tags?​

optional applied_tags: string[]

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

Defined in​

packages/types/dist/types/discord.d.ts:994

available_tags?​

optional available_tags: DiscordForumTag[]

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

Defined in​

packages/types/dist/types/discord.d.ts:992

bitrate?​

optional bitrate: number

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

Defined in​

packages/types/dist/types/discord.d.ts:952

default_auto_archive_duration?​

optional default_auto_archive_duration: number

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

Defined in​

packages/types/dist/types/discord.d.ts:984

default_forum_layout?​

optional default_forum_layout: ForumLayout

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

Defined in​

packages/types/dist/types/discord.d.ts:1002

default_reaction_emoji?​

optional default_reaction_emoji: null | DiscordDefaultReactionEmoji

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

Defined in​

packages/types/dist/types/discord.d.ts:996

default_sort_order?​

optional default_sort_order: null | SortOrderTypes

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

Defined in​

packages/types/dist/types/discord.d.ts:1000

default_thread_rate_limit_per_user?​

optional default_thread_rate_limit_per_user: number

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.

Defined in​

packages/types/dist/types/discord.d.ts:998

flags?​

optional flags: ChannelFlags

The flags of the channel

Defined in​

packages/types/dist/types/discord.d.ts:988

guild_id?​

optional guild_id: string

The id of the guild

Defined in​

packages/types/dist/types/discord.d.ts:938

icon?​

optional icon: string

icon hash of the group DM

Defined in​

packages/types/dist/types/discord.d.ts:960

id​

id: string

The id of the channel

Defined in​

packages/types/dist/types/discord.d.ts:934

last_message_id?​

optional last_message_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:950

last_pin_timestamp?​

optional last_pin_timestamp: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:970

managed?​

optional managed: boolean

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

Defined in​

packages/types/dist/types/discord.d.ts:966

member?​

optional member: DiscordThreadMember

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

Defined in​

packages/types/dist/types/discord.d.ts:982

member_count?​

optional member_count: number

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

Defined in​

packages/types/dist/types/discord.d.ts:978

message_count?​

optional message_count: number

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

Defined in​

packages/types/dist/types/discord.d.ts:976

name?​

optional name: string

The name of the channel (1-100 characters)

Defined in​

packages/types/dist/types/discord.d.ts:944

newly_created?​

optional newly_created: boolean

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

Defined in​

packages/types/dist/types/discord.d.ts:1004

nsfw?​

optional nsfw: boolean

Whether the channel is nsfw

Defined in​

packages/types/dist/types/discord.d.ts:948

owner_id?​

optional owner_id: string

Id of the creator of the thread

Defined in​

packages/types/dist/types/discord.d.ts:962

parent_id?​

optional parent_id: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:968

permission_overwrites?​

optional permission_overwrites: DiscordOverwrite[]

Explicit permission overwrites for members and roles

Defined in​

packages/types/dist/types/discord.d.ts:942

permissions?​

optional permissions: string

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.

Defined in​

packages/types/dist/types/discord.d.ts:986

position?​

optional position: number

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

Defined in​

packages/types/dist/types/discord.d.ts:940

rate_limit_per_user?​

optional rate_limit_per_user: number

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

Defined in​

packages/types/dist/types/discord.d.ts:956

recipients?​

optional recipients: DiscordUser[]

the recipients of the DM

Defined in​

packages/types/dist/types/discord.d.ts:958

rtc_region?​

optional rtc_region: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:972

thread_metadata?​

optional thread_metadata: DiscordThreadMetadata

Thread-specific fields not needed by other channels

Defined in​

packages/types/dist/types/discord.d.ts:980

topic?​

optional topic: null | string

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

Defined in​

packages/types/dist/types/discord.d.ts:946

total_message_sent?​

optional total_message_sent: number

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

Defined in​

packages/types/dist/types/discord.d.ts:990

type​

type: ChannelTypes

The type of channel

Defined in​

packages/types/dist/types/discord.d.ts:936

user_limit?​

optional user_limit: number

The user limit of the voice or stage channel

Defined in​

packages/types/dist/types/discord.d.ts:954

video_quality_mode?​

optional video_quality_mode: VideoQualityModes

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

Defined in​

packages/types/dist/types/discord.d.ts:974