ForumChannel
ForumChannel ⇐ Channel
A class representing a forum channel on Discord.
Kind: global class
Extends: Channel
- ForumChannel ⇐
Channel
- new ForumChannel([data], [guildId], [client])
- .createThread([options]) ⇒
Promise.<Object>
new ForumChannel([data], [guildId], [client])
Param | Type | Description |
---|---|---|
[data] | Object | The data for the forum channel |
[guildId] | string | The ID of the guild that the channel belongs to |
[client] | Client | The client that instantiated the channel |
forumChannel.createThread([options]) ⇒ Promise.<Object>
Creates a new thread in the forum channel.
Kind: instance method of ForumChannel
Returns: Promise.<Object>
- The thread data
Param | Type | Description |
---|---|---|
[options] | Object | The options for the thread |
[options.name] | string | The name of the thread |
[options.autoArchiveDuration] | number | The duration in minutes to automatically archive the thread |
[options.rateLimitPerUser] | number | The rate limit per user for the thread in seconds |
[options.reason] | string | The reason for creating the thread |
[options.message] | Message | The message to use as a basis for the thread |