Class ForumTopic

Represents a topic on Guilded.

Example

new ForumTopic(channel, rawForumTopic);

Hierarchy

Base<number>
- ForumTopic

Index

Constructors

constructor

new ForumTopic(channel: ForumChannel, raw: APIForumTopic | APIForumTopicSummary, cache?: boolean): ForumTopic
Parameters
- channel: ForumChannel
  
  The forum channel the topic belongs to.
- raw: APIForumTopic | APIForumTopicSummary
  
  The raw data of the forum topic.
- Optional cache: boolean
  
  Whether to cache the forum topic.
Returns ForumTopic
Overrides Base.constructor
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:37

Properties

`Optional` `Readonly` bumpedAt

bumpedAt?: Date

The date the forum topic was bumped.

`Readonly` channel

channel: ForumChannel

`Readonly` channelId

channelId: string

The ID of the channel the forum topic belongs to.

`Readonly` client

client: Client

`Optional` `Readonly` content

content?: string

The content of the forum topic.

`Readonly` createdAt

createdAt: Date

The date the forum topic was created.

`Readonly` createdBy

createdBy: string

The ID of the user that created the forum topic.

`Optional` `Readonly` createdByWebhookId

createdByWebhookId?: string

The ID of the webhook that created the forum topic.

`Optional` `Readonly` editedAt

editedAt?: Date

The date the forum topic was edited.

`Readonly` id

id: number

`Optional` `Readonly` mentions

mentions?: APIMentions

The mentions of the forum topic.

`Readonly` raw

raw: APIForumTopic | APIForumTopicSummary

`Readonly` serverId

serverId: string

The ID of the server the forum topic belongs to.

`Readonly` title

title: string

The title of the forum topic.

Accessors

author

get author(): undefined | ServerMember
The server member that created the forum topic.

Returns undefined | ServerMember
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:45

authorId

get authorId(): string
The ID of the user that created the forum topic.

Returns string
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:49

bumpedTimestamp

get bumpedTimestamp(): undefined | number
The timestamp the forum topic was bumped.

Returns undefined | number
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:53

createdTimestamp

get createdTimestamp(): number
The timestamp the forum topic was created.

Returns number
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:43

editedTimestamp

get editedTimestamp(): undefined | number
The timestamp the forum topic was edited.

Returns undefined | number
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:51

isCached

get isCached(): boolean
Whether the forum topic is cached.

Returns boolean
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:39

server

get server(): undefined | Server
The server the forum topic belongs to.

Returns undefined | Server
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:41

webhook

get webhook(): undefined | Webhook
The webhook that created the forun topic.

Returns undefined | Webhook
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:47

Methods

delete

delete(): Promise<ForumTopic>
Delete the forum topic.

Returns
The deleted forum topic.

Example
```
forumTopic.delete();
```
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:94

edit

edit(payload: Partial<APIForumTopicPayload>): Promise<ForumTopic>
Edit the forum topic.

Returns
The edited forum topic.

Example
```
forumTopic.edit({ title: 'New title' });
```
Parameters
- payload: Partial<APIForumTopicPayload>
  
  The payload of the forum topic.
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:88

fetch

fetch(options?: FetchOptions): Promise<ForumTopic>
Fetch the forum topic.

Returns
The fetched forum topic.

Example
```
forumTopic.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the forum topic with.
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:60

fetchAuthor

fetchAuthor(options?: FetchOptions): Promise<ServerMember>
Fetch the server member that created the forum topic.

Returns
The fetched server member.

Example
```
forumTopic.fetchAuthor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<ServerMember>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:74

fetchServer

fetchServer(options?: FetchOptions): Promise<Server>
Fetch the server the forum topic belongs to.

Returns
The fetched server.

Example
```
forumTopic.fetchServer();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server with.
Returns Promise<Server>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:67

fetchWebhook

fetchWebhook(options?: FetchOptions): undefined | Promise<Webhook>
Fetch the webhook that created the forum topic.

Returns
The fetched webhook.

Example
```
forumTopic.fetchWebhook();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the webhook with.
Returns undefined | Promise<Webhook>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:81

lock

lock(): Promise<ForumTopic>
Lock the forum topic.

Returns
The locked forum topic.

Example
```
forumTopic.lock();
```
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:112

pin(): Promise<ForumTopic>
Pin the forum topic.

Returns
The pinned forum topic.

Example
```
forumTopic.pin();
```
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:100

unlock

unlock(): Promise<ForumTopic>
Unlock the forum topic.

Returns
The unlocked forum topic.

Example
```
forumTopic.unlock();
```
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:118

unpin

unpin(): Promise<ForumTopic>
Unpin the forum topic.

Returns
The unpinned forum topic.

Example
```
forumTopic.unpin();
```
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/structures/ForumTopic.d.ts:106

Class ForumTopic

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

channel: ForumChannel

raw: APIForumTopic | APIForumTopicSummary

Optional cache: boolean

Returns ForumTopic

Properties

Optional Readonly bumpedAt

Readonly channel

Readonly channelId

Readonly client

Optional Readonly content

Readonly createdAt

Readonly createdBy

Optional Readonly createdByWebhookId

Optional Readonly editedAt

Readonly id

Optional Readonly mentions

Readonly raw

Readonly serverId

Readonly title

Accessors

author

Returns undefined | ServerMember

authorId

Returns string

bumpedTimestamp

Returns undefined | number

createdTimestamp

Returns number

editedTimestamp

Returns undefined | number

isCached

Returns boolean

server

Returns undefined | Server

webhook

Returns undefined | Webhook

Methods

delete

Returns

Example

Returns Promise<ForumTopic>

edit

Returns

Example

Parameters

payload: Partial<APIForumTopicPayload>

Returns Promise<ForumTopic>

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ForumTopic>

fetchAuthor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

fetchServer

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<Server>

fetchWebhook

Returns

Example

Parameters

`Optional` cache: boolean

`Optional` `Readonly` bumpedAt

`Readonly` channel

`Readonly` channelId

`Readonly` client

`Optional` `Readonly` content

`Readonly` createdAt

`Readonly` createdBy

`Optional` `Readonly` createdByWebhookId

`Optional` `Readonly` editedAt

`Readonly` id

`Optional` `Readonly` mentions

`Readonly` raw

`Readonly` serverId

`Readonly` title

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions