Class ForumTopicRouter

The forum topic router for the Guilded REST API.

Example

new ForumTopicRouter(rest);

Hierarchy

BaseRouter
- ForumTopicRouter

Index

Constructors

constructor

new ForumTopicRouter(rest: RESTManager): ForumTopicRouter
Parameters
- rest: RESTManager
  
  The REST API manager the router belongs to.
Returns ForumTopicRouter
Inherited from BaseRouter.constructor
- Defined in rest/src/routers/BaseRouter.ts:9

Properties

`Readonly` rest

rest: RESTManager

The REST API manager the router belongs to.

Methods

create

create(channelId: string, payload: APIForumTopicPayload): Promise<APIForumTopic>
Create a forum topic on Guilded.

Returns
The created forum topic.

Example
```
topics.create('abc', { title: 'My Topic!' });
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- payload: APIForumTopicPayload
  
  The payload of the forum topic.
Returns Promise<APIForumTopic>
- Defined in rest/src/routers/ForumTopicRouter.ts:65

delete

delete(channelId: string, forumTopicId: number): Promise<void>
Delete a forum topic from Guilded.

Example
```
topics.delete('abc', 123);
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: number
  
  The ID of the forum topic to delete.
Returns Promise<void>
- Defined in rest/src/routers/ForumTopicRouter.ts:95

edit

edit(channelId: string, forumTopicId: number, payload: Partial<APIForumTopicPayload>): Promise<APIForumTopic>
Edit a forum topic on Guilded.

Returns
The edited forum topic.

Example
```
topics.edit('abc', 123, { title: 'New Title', content: 'New Content' });
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: number
  
  The ID of the forum topic to edit.
- payload: Partial<APIForumTopicPayload>
  
  The payload of the forum topic.
Returns Promise<APIForumTopic>
- Defined in rest/src/routers/ForumTopicRouter.ts:81

fetch

fetch(channelId: string, forumTopicId: number): Promise<APIForumTopic>
Fetch a forum topic from Guilded.

Returns
The fetched forum topic.

Example
```
docs.fetch('abc', 123);
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: number
  
  The ID of the forum topic to fetch.
Returns Promise<APIForumTopic>
- Defined in rest/src/routers/ForumTopicRouter.ts:23
fetch(channelId: string, options?: APIForumTopicFetchManyOptions): Promise<APIForumTopicSummary[]>
Fetch forum topics from Guilded.

Returns
The fetched forum topics.

Example
```
docs.fetchMany('abc');
```
Parameters
- channelId: string
  
  The ID of the channel the forum topics belong to.
- Optional options: APIForumTopicFetchManyOptions
  
  The options to fetch forum topics with.
Returns Promise<APIForumTopicSummary[]>
- Defined in rest/src/routers/ForumTopicRouter.ts:31

lock

lock(channelId: string, forumTopicId: number): Promise<void>
Lock a forum topic on Guilded.

Example
```
topics.lock('abc', 123);
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: number
  
  The ID of the forum topic to lock.
Returns Promise<void>
- Defined in rest/src/routers/ForumTopicRouter.ts:125

pin(channelId: string, forumTopicId: number): Promise<void>
Pin a forum topic on Guilded.

Example
```
topics.pin('abc', 123);
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: number
  
  The ID of the forum topic to pin.
Returns Promise<void>
- Defined in rest/src/routers/ForumTopicRouter.ts:105

unlock

unlock(channelId: string, forumTopicId: number): Promise<void>
Unlock a forum topic on Guilded.

Example
```
topics.unlock('abc', 123);
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: number
  
  The ID of the forum topic to unlock.
Returns Promise<void>
- Defined in rest/src/routers/ForumTopicRouter.ts:135

unpin

unpin(channelId: string, forumTopicId: number): Promise<void>
Unpin a forum topic on Guilded.

Example
```
topics.unpin('abc', 123);
```
Parameters
- channelId: string
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: number
  
  The ID of the forum topic to unpin.
Returns Promise<void>
- Defined in rest/src/routers/ForumTopicRouter.ts:115

Class ForumTopicRouter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rest: RESTManager

Returns ForumTopicRouter

Properties

Readonly rest

Methods

create

Returns

Example

Parameters

channelId: string

payload: APIForumTopicPayload

Returns Promise<APIForumTopic>

delete

Example

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

edit

Returns

Example

Parameters

channelId: string

forumTopicId: number

payload: Partial<APIForumTopicPayload>

Returns Promise<APIForumTopic>

fetch

Returns

Example

Parameters

channelId: string

forumTopicId: number

Returns Promise<APIForumTopic>

Returns

Example

Parameters

channelId: string

Optional options: APIForumTopicFetchManyOptions

Returns Promise<APIForumTopicSummary[]>

lock

Example

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

pin

Example

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

unlock

Example

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

unpin

Example

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` rest

`Optional` options: APIForumTopicFetchManyOptions