Class ChannelManager

Hierarchy (View Summary, Expand)

BaseManager<string, Channel>
- ChannelManager

Index

Constructors

Properties

Methods

archive create delete fetch restore update

Constructors

constructor

new ChannelManager(client: Client): ChannelManager
Parameters
- client: Client
Returns ChannelManager
Inherited from BaseManager.constructor
- Defined in src/managers/BaseManager.ts:7

Properties

cache

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

client

client: Client

Methods

archive

archive(channelId: string): Promise<void>
Archive a Guilded channel.
Parameters
- channelId: string
  The ID of the Guilded channel..
Returns Promise<void>
- Defined in src/managers/ChannelManager.ts:51

create

create(data: CreateChannelBody): Promise<Channel>
Create a Guilded channel.
Parameters
- data: CreateChannelBody
  Channel data.
Returns Promise<Channel>
The channel.
- Defined in src/managers/ChannelManager.ts:11

delete

delete(channelId: string): Promise<void>
Delete a Guilded channel.
Parameters
- channelId: string
  The ID of the Guilded channel..
Returns Promise<void>
- Defined in src/managers/ChannelManager.ts:43

fetch

fetch(channelId: string, forced?: boolean): Promise<Channel>
Get a Guilded channel.
Parameters
- channelId: string
  The ID of the Guilded channel.
- forced: boolean = false
  Whether to forcefully fetch the channel from the API, or first attempt to find it in the cache.
Returns Promise<Channel>
The channel.
- Defined in src/managers/ChannelManager.ts:22

restore

restore(channelId: string): Promise<void>
Restore an archived Guilded channel.
Parameters
- channelId: string
  The ID of the Guilded channel..
Returns Promise<void>
- Defined in src/managers/ChannelManager.ts:59

update

update(channelId: string, data: UpdateChannelBody): Promise<Channel>
Update a Guilded channel.
Parameters
- channelId: string
- data: UpdateChannelBody
  Channel data.
Returns Promise<Channel>
The channel.
- Defined in src/managers/ChannelManager.ts:34