Class ForumTopicManager

The manager of topics that belong to a forum channel.

Example

new ForumTopicManager(channel);

Hierarchy

BaseManager<number, ForumTopic>
- ForumTopicManager

Index

Constructors

constructor

new ForumTopicManager(channel: ForumChannel): ForumTopicManager
Parameters
- channel: ForumChannel
  
  The forum channel the topics belong to.
Returns ForumTopicManager
Overrides BaseManager.constructor
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:13

Properties

`Readonly` cache

cache: CacheCollection<number, ForumTopic>

This cache of the manager.

`Readonly` channel

channel: ForumChannel

`Readonly` client

client: Client

Methods

create

create(payload: APIForumTopicPayload): Promise<ForumTopic>
Create a topic in the forum channel.

Returns
The created forum topic.

Example
```
topics.create({ title: 'My Topic' });
```
Parameters
- payload: APIForumTopicPayload
  
  The payload of the forum topic.
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:39

delete

delete(forumTopic: number | ForumTopic): Promise<void>
Delete a forum topic from the channel.

Example
```
topics.delete(forumTopic);
```
Parameters
- forumTopic: number | ForumTopic
  
  The forum topic to delete.
Returns Promise<void>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:53

edit

edit(forumTopic: number | ForumTopic, payload: Partial<APIForumTopicPayload>): Promise<ForumTopic>
Edit a forum topic in the channel.

Returns
The edited forum topic.

Example
```
topics.edit(forumTopic, { title: 'My Topic' });
```
Parameters
- forumTopic: number | ForumTopic
  
  The forum topic to edit.
- payload: Partial<APIForumTopicPayload>
  
  The payload of the forum topic.
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:47

fetch

fetch(forumTopic: number | ForumTopic, options?: FetchOptions): Promise<ForumTopic>
Fetch a forum topic from the channel, or cache.

Returns
The fetched forum topic.

Example
```
topics.fetch(forumTopic);
```
Parameters
- forumTopic: number | ForumTopic
  
  The forum topic to fetch.
- Optional options: FetchOptions
  
  The options to fetch the forum topic with.
Returns Promise<ForumTopic>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:21
fetch(options?: ForumTopicFetchManyOptions): Promise<Collection<number, ForumTopic>>
Fetch forum topics from the channel.

Returns
The fetched forum topics.

Example
```
topics.fetch();
```
Parameters
- Optional options: ForumTopicFetchManyOptions
  
  The options to fetch the forum topics with.
Returns Promise<Collection<number, ForumTopic>>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:28

lock

lock(forumTopic: number | ForumTopic): Promise<void>
Lock a forum topic in the channel.

Example
```
topics.lock(forumTopic);
```
Parameters
- forumTopic: number | ForumTopic
  
  The forum topic to lock.
Returns Promise<void>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:71

pin(forumTopic: number | ForumTopic): Promise<void>
Pin a forum topic in the channel.

Example
```
topics.pin(forumTopic);
```
Parameters
- forumTopic: number | ForumTopic
  
  The forum topic to pin.
Returns Promise<void>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:59

setMaxCache

setMaxCache(maxSize: number): ForumTopicManager
Set the maximum cache size of the manager.

Returns
The manager.

Example
```
manager.setMaxCache(100);
```
Parameters
- maxSize: number
  
  The maximum size of the cache.
Returns ForumTopicManager
Inherited from BaseManager.setMaxCache
- Defined in guilded.ts/dist/managers/BaseManager.d.ts:22

unlock

unlock(forumTopic: number | ForumTopic): Promise<void>
Unlock a forum topic in the channel.

Example
```
topics.unlock(forumTopic);
```
Parameters
- forumTopic: number | ForumTopic
  
  The forum topic to unlock.
Returns Promise<void>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:77

unpin

unpin(forumTopic: number | ForumTopic): Promise<void>
Unpin a forum topic from the channel.

Example
```
topics.unpin(forumTopic);
```
Parameters
- forumTopic: number | ForumTopic
  
  The forum topic to unpin.
Returns Promise<void>
- Defined in guilded.ts/dist/managers/ForumTopicManager.d.ts:65

Class ForumTopicManager

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

channel: ForumChannel

Returns ForumTopicManager

Properties

Readonly cache

Readonly channel

Readonly client

Methods

create

Returns

Example

Parameters

payload: APIForumTopicPayload

Returns Promise<ForumTopic>

delete

Example

Parameters

forumTopic: number | ForumTopic

Returns Promise<void>

edit

Returns

Example

Parameters

forumTopic: number | ForumTopic

payload: Partial<APIForumTopicPayload>

Returns Promise<ForumTopic>

fetch

Returns

Example

Parameters

forumTopic: number | ForumTopic

Optional options: FetchOptions

Returns Promise<ForumTopic>

Returns

Example

Parameters

Optional options: ForumTopicFetchManyOptions

Returns Promise<Collection<number, ForumTopic>>

lock

Example

Parameters

forumTopic: number | ForumTopic

Returns Promise<void>

pin

Example

Parameters

forumTopic: number | ForumTopic

Returns Promise<void>

setMaxCache

Returns

Example

Parameters

maxSize: number

Returns ForumTopicManager

unlock

Example

Parameters

forumTopic: number | ForumTopic

Returns Promise<void>

unpin

Example

Parameters

forumTopic: number | ForumTopic

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` cache

`Readonly` channel

`Readonly` client

`Optional` options: FetchOptions

`Optional` options: ForumTopicFetchManyOptions