Skip to main content
Version: 0.37.11

APIGuildForumChannel

Hierarchy

Index

Properties

Properties

available_tags

available_tags: APIGuildForumTag[]

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

optionaldefault_auto_archive_duration

default_auto_archive_duration?: ThreadAutoArchiveDuration

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

default_reaction_emoji

default_reaction_emoji: null | APIGuildForumDefaultReactionEmoji

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

default_sort_order

default_sort_order: null | SortOrderType

The default sort order type used to order posts in forum channels

optionaldefault_thread_rate_limit_per_user

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

optionalflags

flags?: ChannelFlags

optionalguild_id

guild_id?: string

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

id

id: string

The id of the channel

optionallast_message_id

last_message_id?: null | string

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

optionallast_pin_timestamp

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

optionalname

name?: string

The name of the channel (2-100 characters)

optionalnsfw

nsfw?: boolean

Whether the channel is nsfw

optionalparent_id

parent_id?: null | string

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

OR

ID of the parent channel for a thread

optionalpermission_overwrites

permission_overwrites?: APIOverwrite[]

Explicit permission overwrites for members and roles

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

optionalposition

position?: number

Sorting position of the channel

optionalrate_limit_per_user

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 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.

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.

optionaltopic

topic?: null | string

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

type

type: GuildForum

The type of the channel

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