hoshii / Exports / ForumTopicComment

ForumTopicComment

Represents a forum topic comment

Hierarchy

• Base<number>

  ↳ ForumTopicComment

Table of contents

Constructors

• constructor

Properties

• channelID
• client
• content
• createdAt
• createdBy
• forumTopicID
• id
• mentions
• updatedAt

Methods

• addReactionEmote
• delete
• deleteReactionEmote
• edit
• toJSON
• update

Constructors

constructor

• new ForumTopicComment(data, client)

Create a new ForumTopicComment

Parameters

Name	Type	Description
data	RawForumTopicComment	The raw data of the forum topic comment
client	Client	The client

Overrides

Base.constructor

Defined in

lib/structures/ForumTopicComment.ts:74

Properties

channelID

• channelID: string

The ID of the channel the forum topic comment is in

Defined in

lib/structures/ForumTopicComment.ts:37

---

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

content

• content: string

The content of the forum topic comment

Defined in

lib/structures/ForumTopicComment.ts:42

---

createdAt

• createdAt: Date

The date the forum topic comment was created at

Defined in

lib/structures/ForumTopicComment.ts:47

---

createdBy

• createdBy: string

The ID of the user who created the forum topic comment

Defined in

lib/structures/ForumTopicComment.ts:52

---

forumTopicID

• forumTopicID: number

The ID of the forum topic the forum topic comment is in

Defined in

lib/structures/ForumTopicComment.ts:57

---

id

• id: number

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

mentions

• Optional mentions: Mentions

The mentions in the forum topic comment

Defined in

lib/structures/ForumTopicComment.ts:62

---

updatedAt

• Optional updatedAt: Date

The date the forum topic comment was updated at

Defined in

lib/structures/ForumTopicComment.ts:67

Methods

addReactionEmote

▸ addReactionEmote(emoteID): Promise<void>

Add a reaction emote to the forum topic comment

Parameters

Name	Type	Description
emoteID	number	The ID of the emote

Returns

Promise<void>

Defined in

lib/structures/ForumTopicComment.ts:93

---

delete

▸ delete(): Promise<void>

Delete the forum topic comment

Returns

Promise<void>

Defined in

lib/structures/ForumTopicComment.ts:106

---

deleteReactionEmote

▸ deleteReactionEmote(emoteID): Promise<void>

Delete a reaction emote from the forum topic comment

Parameters

Name	Type	Description
emoteID	number	The ID of the emote

Returns

Promise<void>

Defined in

lib/structures/ForumTopicComment.ts:119

---

edit

▸ edit(options): Promise<ForumTopicComment>

Edit the forum topic comment

Parameters

Name	Type	Description
options	ForumTopicCommentOptions	The options to edit the forum topic comment with

Returns

Promise<ForumTopicComment>

Defined in

lib/structures/ForumTopicComment.ts:133

---

toJSON

▸ toJSON(): ForumTopicCommentData

Returns the JSON representation of the item

Returns

ForumTopicCommentData

Overrides

Base.toJSON

Defined in

lib/structures/ForumTopicComment.ts:142

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawForumTopicComment

Returns

void

Overrides

Base.update

Defined in

lib/structures/ForumTopicComment.ts:155