Channel
@discordeno/bot • Docs
Documentation / @discordeno/bot / Channel
Interface: Channel
Properties
applicationId?
optionalapplicationId:bigint
Application id of the group DM creator if it is bot-created
Defined in
packages/bot/src/transformers/types.ts:438
appliedTags?
optionalappliedTags:bigint[]
The IDs of the set of tags that have been applied to a thread in a GUILD_FORUM or a GUILD_MEDIA channel
Defined in
packages/bot/src/transformers/types.ts:444
archived
archived:
boolean
Whether the thread is archived
Defined in
packages/bot/src/transformers/types.ts:463
availableTags?
optionalavailableTags:ForumTag[]
The set of tags that can be used in a GUILD_FORUM or a GUILD_MEDIA channel
Defined in
packages/bot/src/transformers/types.ts:442
bitrate?
optionalbitrate:number
The bitrate (in bits) of the voice or stage channel
Defined in
packages/bot/src/transformers/types.ts:393
defaultAutoArchiveDuration?
optionaldefaultAutoArchiveDuration: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/bot/src/transformers/types.ts:421
defaultForumLayout?
optionaldefaultForumLayout:ForumLayout
Defined in
packages/bot/src/transformers/types.ts:451
defaultReactionEmoji?
optionaldefaultReactionEmoji:DefaultReactionEmoji
The emoji to show in the add reaction button on a thread in a GUILD_FORUM or a GUILD_MEDIA channel
Defined in
packages/bot/src/transformers/types.ts:446
defaultSortOrder?
optionaldefaultSortOrder:null|SortOrderTypes
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
Defined in
packages/bot/src/transformers/types.ts:450
defaultThreadRateLimitPerUser?
optionaldefaultThreadRateLimitPerUser:number
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.
Defined in
packages/bot/src/transformers/types.ts:448
flags?
optionalflags:number
The flags of the channel
Defined in
packages/bot/src/transformers/types.ts:425
guildId?
optionalguildId:bigint
The id of the guild
Defined in
packages/bot/src/transformers/types.ts:383
icon?
optionalicon:bigint
Icon hash of the group dm
Defined in
packages/bot/src/transformers/types.ts:436
id
id:
bigint
The id of the channel
Defined in
packages/bot/src/transformers/types.ts:377
internalOverwrites?
optionalinternalOverwrites:bigint[]
Internal
Explicit permission overwrites for members and roles
Use channel.permissionOverwrites. This is for internal use only, and prone to breaking changes.
Defined in
packages/bot/src/transformers/types.ts:432
internalThreadMetadata?
optionalinternalThreadMetadata:InternalChannelThreadMetadata
Internal
Thread-specific fields not needed by other channels.
This field is an internal field, subject to breaking changes.
Defined in
packages/bot/src/transformers/types.ts:418
invitable
invitable:
boolean
whether non-moderators can add other non-moderators to a thread; only available on private threads
Defined in
packages/bot/src/transformers/types.ts:461
lastMessageId?
optionallastMessageId:bigint
The id of the last message sent in this channel (may not point to an existing or valid message)
Defined in
packages/bot/src/transformers/types.ts:391
lastPinTimestamp?
optionallastPinTimestamp:number
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/bot/src/transformers/types.ts:403
locked
locked:
boolean
When a thread is locked, only users with MANAGE_THREADS can unarchive it
Defined in
packages/bot/src/transformers/types.ts:459
managed
managed:
boolean
for group DM channels: whether the channel is managed by an application via the gdm.join OAuth2 scope
Defined in
packages/bot/src/transformers/types.ts:465
member?
optionalmember:ThreadMember
Defined in
packages/bot/src/transformers/types.ts:419
memberCount?
optionalmemberCount:number
An approximate count of users in a thread, stops counting at 50
Defined in
packages/bot/src/transformers/types.ts:411
messageCount?
optionalmessageCount:number
An approximate count of messages in a thread, stops counting at 50
Defined in
packages/bot/src/transformers/types.ts:409
name?
optionalname:string
The name of the channel (1-100 characters)
Defined in
packages/bot/src/transformers/types.ts:387
newlyCreated
newlyCreated:
boolean
When a thread is created this will be true on that channel payload for the thread.
Defined in
packages/bot/src/transformers/types.ts:457
nsfw
nsfw:
boolean
Whether the channel is nsfw
Defined in
packages/bot/src/transformers/types.ts:453
ownerId?
optionalownerId:bigint
Id of the creator of the thread
Defined in
packages/bot/src/transformers/types.ts:399
parentId?
optionalparentId:bigint
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/bot/src/transformers/types.ts:401
permissionOverwrites
permissionOverwrites:
OverwriteReadable[]
Explicit permission overwrites for members and roles.
Defined in
packages/bot/src/transformers/types.ts:467
permissions?
optionalpermissions:Permissions
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/bot/src/transformers/types.ts:423
position?
optionalposition:number
Sorting position of the channel
Defined in
packages/bot/src/transformers/types.ts:385
rateLimitPerUser?
optionalrateLimitPerUser: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/bot/src/transformers/types.ts:397
recipients?
optionalrecipients:User[]
The recipients of a group dm
Defined in
packages/bot/src/transformers/types.ts:434
rtcRegion?
optionalrtcRegion:string
Voice region id for the voice or stage channel, automatic when set to null
Defined in
packages/bot/src/transformers/types.ts:405
threadMetadata?
optionalthreadMetadata:ChannelThreadMetadata
Thread-specific fields not needed by other channels
Defined in
packages/bot/src/transformers/types.ts:455
toggles
toggles:
ChannelToggles
The compressed form of all the boolean values on this channel.
Defined in
packages/bot/src/transformers/types.ts:379
topic?
optionaltopic:string
The channel topic (0-4096 characters for GUILD_FORUM channels, 0-1024 characters for all others)
Defined in
packages/bot/src/transformers/types.ts:389
totalMessageSent?
optionaltotalMessageSent: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/bot/src/transformers/types.ts:440
type
type:
ChannelTypes
The type of channel
Defined in
packages/bot/src/transformers/types.ts:381
userLimit?
optionaluserLimit:number
The user limit of the voice or stage channel
Defined in
packages/bot/src/transformers/types.ts:395
videoQualityMode?
optionalvideoQualityMode:VideoQualityModes
The camera video quality mode of the voice channel, 1 when not present