Preview environment

interface APIGuildTextChannel

export interface APIGuildTextChannel<T extends ChannelType.GuildForum | ChannelType.GuildMedia | GuildTextChannelType> extends APITextBasedChannel<T>, APIGuildChannel<T>, APISortableChannel, APIPinChannel<T>

Type Parameters

optional
default_auto_archive_duration? : ThreadAutoArchiveDuration

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

optional
default_thread_rate_limit_per_user? : number

The initial rate_limit_per_user to set on newly created threads. This field is copied to the thread at creation time and does not live update

optional
flags? : ChannelFlags

Inherited from: APIChannelBase

optional
guild_id? : Snowflake

The id of the guild (may be missing for some channel objects received over gateway guild dispatches)

Inherited from: APIGuildChannel

id : Snowflake

The id of the channel

Inherited from: APIBasePartialChannel

optional
last_message_id? : Snowflake | null

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

Inherited from: APITextBasedChannel

optional
last_pin_timestamp? : string | null

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

Inherited from: APIPinChannel

name : string

The name of the channel (1-100 characters)

Inherited from: APIGuildChannel

optional
nsfw? : boolean

Whether the channel is nsfw

Inherited from: APIGuildChannel

optional
parent_id? : Snowflake | null

ID of the parent category for a channel (each parent category can contain up to 50 channels)

Inherited from: APIGuildChannel

optional
permission_overwrites? : APIOverwrite[]

Explicit permission overwrites for members and roles

Inherited from: APIGuildChannel

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

position : number

Sorting position of the channel

Inherited from: APISortableChannel

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_CHANNELS, are unaffectedrate_limit_per_user also applies to thread creation. Users can send one message and create one thread during each rate_limit_per_user interval.For thread channels, rate_limit_per_user is only returned if the field is set to a non-zero and non-null value. The absence of this field in API calls and Gateway events should indicate that slowmode has been reset to the default value.

Inherited from: APISlowmodeChannel

optional
topic? : string | null

The channel topic (0-1024 characters)

type : T

Inherited from: APIChannelBase