Class ForumChannel

Represents a forum channel.

Hierarchy

GuildChannel
- ForumChannel

Index

Constructors

Properties

archivedAt archivedBy categoryID client createdAt creatorID description editedTimestamp groupID guildID id isPublic name parentID threads type visibility

Methods

archive createThread delete deleteThread edit editThread lockThread pinThread toJSON unarchive unlockThread unpinThread

Constructors

constructor

new ForumChannel(data, client): ForumChannel
Parameters
- data: APIGuildChannel
  
  raw data
- client: Client
  
  client
Returns ForumChannel
Overrides GuildChannel.constructor
- Defined in lib/structures/ForumChannel.ts:19

Properties

archivedAt

archivedAt: null | Date

When the channel was last archived.

archivedBy

archivedBy: null | string

ID of the member that archived the channel (if archived)

categoryID

categoryID: null | number

ID of the category the channel is in.

client

client: Client

Bot's client.

createdAt

createdAt: Date

When this channel was created.

creatorID

creatorID: string

ID of the member who created this channel.

description

description: null | string

Channel description

editedTimestamp

editedTimestamp: null | Date

Timestamp at which this channel was last edited.

groupID

groupID: string

ID of the group the channel is in.

guildID

guildID: string

Server ID

id

id: string

Item ID

isPublic

isPublic: boolean

name

name: string

Channel name

parentID

parentID: null | string

ID of the parent category.

threads

threads: TypedCollection<number, APIForumTopic, ForumThread<ForumChannel>, []>

Cached threads.

type

type: string

Channel type

visibility

visibility: string

Channel visibility

Methods

createThread

createThread(options): Promise<ForumThread<ForumChannel>>
Create a thread in this channel.
Parameters
- options: CreateForumThreadOptions
  
  Thread's options including title & content.
Returns Promise<ForumThread<ForumChannel>>
- Defined in lib/structures/ForumChannel.ts:28

delete

delete(): Promise<void>
Delete the channel.

Returns Promise<void>
Inherited from GuildChannel.delete
- Defined in lib/structures/GuildChannel.ts:148

deleteThread

deleteThread(threadID): Promise<void>
Delete a thread from this channel.
Parameters
- threadID: number
  
  ID of a thread.
Returns Promise<void>
- Defined in lib/structures/ForumChannel.ts:43

edit

edit(options): Promise<Channel>
Edit the channel.
Parameters
- options: EditChannelOptions
Returns Promise<Channel>
Inherited from GuildChannel.edit
- Defined in lib/structures/GuildChannel.ts:143

editThread

editThread(threadID, options): Promise<ForumThread<ForumChannel>>
Edit a thread from this channel.
Parameters
- threadID: number
  
  ID of a thread.
- options: EditForumThreadOptions
  
  Edit options.
Returns Promise<ForumThread<ForumChannel>>
- Defined in lib/structures/ForumChannel.ts:36

lockThread

lockThread(threadID): Promise<void>
Lock a thread.
Parameters
- threadID: number
  
  ID of a thread.
Returns Promise<void>
- Defined in lib/structures/ForumChannel.ts:64

pinThread

pinThread(threadID): Promise<void>
Pin a thread.
Parameters
- threadID: number
  
  ID of a thread.
Returns Promise<void>
- Defined in lib/structures/ForumChannel.ts:50

toJSON

toJSON(): JSONForumChannel
Returns JSONForumChannel
Overrides GuildChannel.toJSON
- Defined in lib/structures/ForumChannel.ts:75

unarchive

unarchive(): Promise<void>
Unarchive the channel

Returns Promise<void>
Inherited from GuildChannel.unarchive
- Defined in lib/structures/GuildChannel.ts:158

unlockThread

unlockThread(threadID): Promise<void>
Unlock a thread.
Parameters
- threadID: number
  
  ID of a thread.
Returns Promise<void>
- Defined in lib/structures/ForumChannel.ts:71

unpinThread

unpinThread(threadID): Promise<void>
Unpin a thread.
Parameters
- threadID: number
  
  ID of a thread.
Returns Promise<void>
- Defined in lib/structures/ForumChannel.ts:57

Class ForumChannel

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: APIGuildChannel

client: Client

Returns ForumChannel

Properties

archivedAt

archivedBy

categoryID

client

createdAt

creatorID

description

editedTimestamp

groupID

guildID

id

isPublic

name

parentID

threads

type

visibility

Methods

archive

Returns Promise<void>

createThread

Parameters

options: CreateForumThreadOptions

Returns Promise<ForumThread<ForumChannel>>

delete

Returns Promise<void>

deleteThread

Parameters

threadID: number

Returns Promise<void>

edit

Parameters

options: EditChannelOptions

Returns Promise<Channel>

editThread

Parameters

threadID: number

options: EditForumThreadOptions

Returns Promise<ForumThread<ForumChannel>>

lockThread

Parameters

threadID: number

Returns Promise<void>

pinThread

Parameters

threadID: number

Returns Promise<void>

toJSON

Returns JSONForumChannel

unarchive

Returns Promise<void>

unlockThread

Parameters

threadID: number

Returns Promise<void>

unpinThread

Parameters

threadID: number

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page