hoshii / Exports / ForumChannel

ForumChannel

Represents a forum channel

Hierarchy

• ServerChannel

  ↳ ForumChannel

Table of contents

Constructors

• constructor

Properties

• archivedAt
• archivedBy
• categoryID
• client
• createdAt
• createdBy
• groupID
• id
• isPublic
• name
• parentID
• serverID
• topic
• topics
• type
• updatedAt

Methods

• createTopic
• createTopicComment
• delete
• deleteTopic
• deleteTopicComment
• edit
• editTopic
• editTopicComment
• toJSON
• update

Constructors

constructor

• new ForumChannel(data, client)

Create a new ForumChannel

Parameters

Name	Type	Description
data	RawServerChannel	The raw data of the channel
client	Client	The client

Overrides

ServerChannel.constructor

Defined in

lib/structures/ForumChannel.ts:38

Properties

archivedAt

• archivedAt: Date

The date the server channel was archived at

Inherited from

ServerChannel.archivedAt

Defined in

lib/structures/ServerChannel.ts:48

---

archivedBy

• archivedBy: string

The ID of the user that archived the server channel

Inherited from

ServerChannel.archivedBy

Defined in

lib/structures/ServerChannel.ts:53

---

categoryID

• categoryID: string

The ID of the category the server channel is in

Inherited from

ServerChannel.categoryID

Defined in

lib/structures/ServerChannel.ts:58

---

client

• client: Client

The bot client

Inherited from

ServerChannel.client

Defined in

lib/structures/Base.ts:13

---

createdAt

• createdAt: Date

The date the server channel was created at

Inherited from

ServerChannel.createdAt

Defined in

lib/structures/ServerChannel.ts:63

---

createdBy

• createdBy: string

The ID of the user that created the server channel

Inherited from

ServerChannel.createdBy

Defined in

lib/structures/ServerChannel.ts:68

---

groupID

• groupID: string

The ID of the group the server channel is in

Inherited from

ServerChannel.groupID

Defined in

lib/structures/ServerChannel.ts:73

---

id

• id: string

The ID of the item

Inherited from

ServerChannel.id

Defined in

lib/structures/Base.ts:16

---

isPublic

• isPublic: boolean

Whether the server channel is public

Inherited from

ServerChannel.isPublic

Defined in

lib/structures/ServerChannel.ts:78

---

name

• name: string

The name of the server channel

Inherited from

ServerChannel.name

Defined in

lib/structures/ServerChannel.ts:83

---

parentID

• parentID: string

The ID of the parent the server channel is in

Inherited from

ServerChannel.parentID

Defined in

lib/structures/ServerChannel.ts:88

---

serverID

• serverID: string

The ID of the server the server channel is in

Inherited from

ServerChannel.serverID

Defined in

lib/structures/ServerChannel.ts:93

---

topic

• topic: string

The topic of the server channel

Inherited from

ServerChannel.topic

Defined in

lib/structures/ServerChannel.ts:98

---

topics

• topics: TypedCollection<number, RawForumTopic, ForumTopic<ForumChannel>, []>

A collection of cached topics

Defined in

lib/structures/ForumChannel.ts:27

---

type

• type: ServerChannelCategories

The type of the server channel

Inherited from

ServerChannel.type

Defined in

lib/structures/ServerChannel.ts:103

---

updatedAt

• updatedAt: Date

The date the server channel was updated at

Inherited from

ServerChannel.updatedAt

Defined in

lib/structures/ServerChannel.ts:108

Methods

createTopic

▸ createTopic(options): Promise<ForumTopic<ForumChannel>>

Create a topic

Parameters

Name	Type	Description
options	ForumTopicOptions	The options for the topic

Returns

Promise<ForumTopic<ForumChannel>>

Defined in

lib/structures/ForumChannel.ts:55

---

createTopicComment

▸ createTopicComment(topicID, options): Promise<ForumTopicComment>

Create a topic comment

Parameters

Name	Type	Description
topicID	number	The ID of the topic
options	ForumTopicCommentOptions	The options for the topic comment

Returns

Promise<ForumTopicComment>

Defined in

lib/structures/ForumChannel.ts:67

---

delete

▸ delete(): Promise<void>

Deletes the server channel

Returns

Promise<void>

Inherited from

ServerChannel.delete

Defined in

lib/structures/ServerChannel.ts:139

---

deleteTopic

▸ deleteTopic(topicID): Promise<void>

Delete a topic

Parameters

Name	Type	Description
topicID	number	The ID of the topic

Returns

Promise<void>

Defined in

lib/structures/ForumChannel.ts:79

---

deleteTopicComment

▸ deleteTopicComment(topicID, commentID): Promise<void>

Delete a topic comment

Parameters

Name	Type	Description
topicID	number	The ID of the topic
commentID	number	The ID of the topic comment

Returns

Promise<void>

Defined in

lib/structures/ForumChannel.ts:89

---

edit

▸ edit(options): Promise<ServerChannel>

Edits the server channel

Parameters

Name	Type	Description
options	ServerChannelEditOptions	The options to edit the server channel with

Returns

Promise<ServerChannel>

Inherited from

ServerChannel.edit

Defined in

lib/structures/ServerChannel.ts:149

---

editTopic

▸ editTopic(topicID, options): Promise<ForumTopic<ForumChannel>>

Edit a topic

Parameters

Name	Type	Description
topicID	number	The ID of the topic
options	ForumTopicOptions	The options for the topic

Returns

Promise<ForumTopic<ForumChannel>>

Defined in

lib/structures/ForumChannel.ts:102

---

editTopicComment

▸ editTopicComment(topicID, commentID, options): Promise<ForumTopicComment>

Edit a topic comment

Parameters

Name	Type	Description
topicID	number	The ID of the topic
commentID	number	The ID of the topic comment
options	ForumTopicCommentOptions	The options for the topic comment

Returns

Promise<ForumTopicComment>

Defined in

lib/structures/ForumChannel.ts:116

---

toJSON

▸ toJSON(): ForumChannelData

Returns the JSON representation of the item

Returns

ForumChannelData

Overrides

ServerChannel.toJSON

Defined in

lib/structures/ForumChannel.ts:129

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawServerChannel

Returns

void

Inherited from

ServerChannel.update

Defined in

lib/structures/ServerChannel.ts:172