Class ForumThread

Represents a thread/topic coming from a "Forums" channel.

Hierarchy

Base
- ForumThread

Index

Constructors

constructor

new ForumThread(data: APIForumTopic, client: Client): ForumThread
Parameters
- data: APIForumTopic
  
  raw data
- client: Client
  
  client
Returns ForumThread
Overrides Base.constructor
- Defined in lib/structures/ForumThread.ts:40

Properties

bumpedAt

bumpedAt: null | string

Timestamp (unix epoch time) that the forum thread was bumped at.

channelID

channelID: string

Forum channel id

client

client: Client

Bot's client.

content

content: string

Content of the thread

createdAt

createdAt: Date

When this forum thread was created.

editedTimestamp

editedTimestamp: null | Date

Timestamp at which this channel was last edited.

guildID

guildID: string

Guild/server id

id

id: string | number

Item ID

mentions

mentions: null | APIMentions

Thread mentions

name

name: string

Name of the thread

ownerID

ownerID: string

The ID of the owner of this thread.

webhookID

webhookID: null | string

ID of the webhook that created the thread (if created by webhook)

Accessors

channel

get channel(): Promise<Channel>
The forum channel, where the thread is in. This will send a request to Guilded, a promise will be returned.

Returns Promise<Channel>
- Defined in lib/structures/ForumThread.ts:78

createdByWebhook

get createdByWebhook(): boolean
If true, this forum thread was created by a webhook.

Returns boolean
- Defined in lib/structures/ForumThread.ts:83

guild

get guild(): Guild | Promise<Guild>
Guild where this thread's owner comes from, returns Guild or a promise. If guild isn't cached & the request failed, this will return you undefined.

Returns Guild | Promise<Guild>
- Defined in lib/structures/ForumThread.ts:57

owner

get owner(): undefined | User | Member | Promise<Member>
Retrieve thread's owner, if cached. If there is no cached member or user, this will make a request which returns a Promise. If the request fails, this will throw an error or return you undefined as a value.

Returns undefined | User | Member | Promise<Member>
- Defined in lib/structures/ForumThread.ts:65

Methods

createForumComment

createForumComment(options: CreateForumCommentOptions): Promise<ForumThreadComment>
Add a comment to this forum thread.
Parameters
- options: CreateForumCommentOptions
  
  Options of the comment.
Returns Promise<ForumThreadComment>
- Defined in lib/structures/ForumThread.ts:90

createReaction

createReaction(emoteID: number): Promise<void>
Add a reaction to this forum thread.
Parameters
- emoteID: number
  
  ID of the emote to be added.
Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:129

delete

delete(): Promise<void>
Delete this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:102

deleteReaction

deleteReaction(emoteID: number): Promise<void>
Remove a reaction from this forum thread.
Parameters
- emoteID: number
  
  ID of the emote to be added.
Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:136

edit

edit(options: EditForumThreadOptions): Promise<ForumThread>
Edit the forum thread.
Parameters
- options: EditForumThreadOptions
  
  Edit options.
Returns Promise<ForumThread>
- Defined in lib/structures/ForumThread.ts:97

lock

lock(): Promise<void>
Lock this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:117

pin(): Promise<void>
Pin this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:107

unlock

unlock(): Promise<void>
Unlock this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:122

unpin

unpin(): Promise<void>
Unpin this forum thread.

Returns Promise<void>
- Defined in lib/structures/ForumThread.ts:112

Class ForumThread

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: APIForumTopic

client: Client

Returns ForumThread

Properties

bumpedAt

channelID

client

content

createdAt

editedTimestamp

guildID

id

mentions

name

ownerID

webhookID

Accessors

channel

Returns Promise<Channel>

createdByWebhook

Returns boolean

guild

Returns Guild | Promise<Guild>

owner

Returns undefined | User | Member | Promise<Member>

Methods

createForumComment

Parameters

options: CreateForumCommentOptions

Returns Promise<ForumThreadComment>

createReaction

Parameters

emoteID: number

Returns Promise<void>

delete

Returns Promise<void>

deleteReaction

Parameters

emoteID: number

Returns Promise<void>

edit

Parameters

options: EditForumThreadOptions

Returns Promise<ForumThread>

lock

Returns Promise<void>

pin

Returns Promise<void>

unlock

Returns Promise<void>

unpin

Returns Promise<void>

Settings

Member Visibility

Theme