Class GlobalChannelManager

Manages channels on the global scope. This can hold channels of any type, with all of them extending Channel. You will likely need to cast the returned values from cache or fetches

Hierarchy

CacheableStructManager<string, Channel>
- GlobalChannelManager

Index

Constructors

Properties

Accessors

shouldCacheChannel

Methods

archive create delete fetch unarchive update

Constructors

constructor

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

Properties

cache

cache: Collection<string, Channel> = ...

`Readonly` client

client: Client

Accessors

shouldCacheChannel

get shouldCacheChannel(): boolean
Determine whether a channel should be cached or not

Returns boolean
- Defined in guilded.js/lib/managers/global/ChannelManager.ts:15

Methods

archive

archive(channelId): Promise<null | Channel>
Archive a channel by ID
Parameters
- channelId: string
  
  ID of the channel to archive
Returns Promise<null | Channel>
Promise that resolves with the archived channel or null if not cached
- Defined in guilded.js/lib/managers/global/ChannelManager.ts:99

create

create(options): Promise<Channel>
Create a new channel
Parameters
- options: {}
  
  Channel creation options
Returns Promise<Channel>
Promise that resolves with the newly created channel
- Defined in guilded.js/lib/managers/global/ChannelManager.ts:25

delete

delete(channelId): Promise<null | Channel>
Delete a channel by ID
Parameters
- channelId: string
  
  ID of the channel to delete
Returns Promise<null | Channel>
Promise that resolves with the deleted channel, or null if not cached.
- Defined in guilded.js/lib/managers/global/ChannelManager.ts:85

fetch

fetch(channelId, force?): Promise<Channel>
Fetch a channel by ID Notice: if you're using TypeScript, you will need to upcast to your desired channel type.
Parameters
- channelId: string
  
  ID of the channel to fetch
- Optional force: boolean
  
  Whether to force a fetch from the API
Returns Promise<Channel>
Promise that resolves with the fetched channel
- Defined in guilded.js/lib/managers/global/ChannelManager.ts:44

unarchive

unarchive(channelId): Promise<null | Channel>
Unarchive a channel by ID
Parameters
- channelId: string
  
  ID of the channel to unarchive
Returns Promise<null | Channel>
Promise that resolves with the unarchived channel or null if not cached
- Defined in guilded.js/lib/managers/global/ChannelManager.ts:113

update

update(channelId, options): Promise<Channel>
Update a channel by ID
Parameters
- channelId: string
  
  ID of the channel to update
- options: {}
  
  Channel update options
Returns Promise<Channel>
Promise that resolves with the updated channel
- Defined in guilded.js/lib/managers/global/ChannelManager.ts:65

Generated using TypeDoc