Class GlobalForumTopicManager

Manager for interacting with forum topics at a global level.

Hierarchy

CacheableStructManager<number, ForumTopic>
- GlobalForumTopicManager

Index

Constructors

constructor

new GlobalForumTopicManager(client): GlobalForumTopicManager
Parameters
- client: Client
Returns GlobalForumTopicManager
Inherited from CacheableStructManager.constructor
- Defined in guilded.js/lib/managers/global/GlobalManager.ts:7

Properties

cache

cache: Collection<number, ForumTopic> = ...

`Readonly` client

client: Client

Accessors

shouldCacheForumTopic

get shouldCacheForumTopic(): boolean
Returns boolean
- Defined in guilded.js/lib/managers/global/ForumManager.ts:11

Methods

create

create(channelId, options): Promise<ForumTopic>
Create a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- options: {}
  
  The options for creating the forum topic.
Returns Promise<ForumTopic>
A Promise that resolves with the payload of the created forum topic.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:22

delete

delete(channelId, forumTopicId): Promise<void>
Delete a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- forumTopicId: number
  
  The ID of the forum topic.
Returns Promise<void>
A Promise that resolves to nothing.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:97

fetch

fetch(channelId, forumTopicId): Promise<ForumTopic>
Get a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- forumTopicId: number
  
  The ID of the forum topic.
Returns Promise<ForumTopic>
a Promise that resolves to a ForumTopic.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:59

fetchMany

fetchMany(channelId, options): Promise<Collection<number, PartialForumTopic>>
Get all topics in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- options: Omit<{}, "channelId">
  
  The options for filtering the forum topics.
Returns Promise<Collection<number, PartialForumTopic>>
A Promise that resolves to a Collection of ForumTopics.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:37

lock

lock(channelId, forumTopicId): Promise<void>
Lock a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- forumTopicId: number
  
  The ID of the forum topic.
Returns Promise<void>
A Promise that resolves to nothing.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:139

pin(channelId, forumTopicId): Promise<void>
Pin a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- forumTopicId: number
  
  The ID of the forum topic.
Returns Promise<void>
A Promise that resolves to nothing.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:111

unlock

unlock(channelId, forumTopicId): Promise<void>
Unlock a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- forumTopicId: number
  
  The ID
Returns Promise<void>
A Promise that resolves to nothing.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:153

unpin

unpin(channelId, forumTopicId): Promise<void>
Unpin a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- forumTopicId: number
  
  The ID of the forum topic.
Returns Promise<void>
A Promise that resolves to nothing.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:125

update

update(channelId, forumTopicId, options): Promise<ForumTopic>
Update a topic in a forum.
Parameters
- channelId: string
  
  The ID of the channel containing the forum.
- forumTopicId: number
  
  The ID of the forum topic.
- options: {}
  
  The options for updating the forum topic.
Returns Promise<ForumTopic>
A Promise that resolves to the updated ForumTopic. If cached locally, it will modify that object.
- Defined in guilded.js/lib/managers/global/ForumManager.ts:75

Class GlobalForumTopicManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns GlobalForumTopicManager

Properties

cache

Readonly client

Accessors

shouldCacheForumTopic

Returns boolean

Methods

create

Parameters

channelId: string

options: {}

Returns Promise<ForumTopic>

delete

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

fetch

Parameters

channelId: string

forumTopicId: number

Returns Promise<ForumTopic>

fetchMany

Parameters

channelId: string

options: Omit<{}, "channelId">

Returns Promise<Collection<number, PartialForumTopic>>

lock

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

pin

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

unlock

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

unpin

Parameters

channelId: string

forumTopicId: number

Returns Promise<void>

update

Parameters

channelId: string

forumTopicId: number

options: {}

Returns Promise<ForumTopic>

Settings

Member Visibility

Theme

On This Page

`Readonly` client