Class ChannelWebhookManager

The manager of webhooks that belong to a channel.

Example

new ChannelWebhookManager(channel);

Hierarchy

BaseManager<string, Webhook>
- ChannelWebhookManager

Index

Constructors

constructor

new ChannelWebhookManager(channel: Channel): ChannelWebhookManager
Parameters
- channel: Channel
  
  The channel the webhooks belong to.
Returns ChannelWebhookManager
Overrides BaseManager.constructor
- Defined in guilded.ts/src/managers/channel/ChannelWebhookManager.ts:14

Properties

`Readonly` cache

cache: CacheCollection<string, Webhook>

This cache of the manager.

`Readonly` channel

channel: Channel

The channel the webhooks belong to.

`Readonly` client

client: Client

The client the manager belongs to.

Methods

create

create(name: string): Promise<Webhook>
Create a webhook in the channel.

Returns
The created webhook.

Example
```
webhooks.create('My Webhook');
```
Parameters
- name: string
  
  The name of the webhook.
Returns Promise<Webhook>
- Defined in guilded.ts/src/managers/channel/ChannelWebhookManager.ts:68

delete

delete(webhook: string | Webhook): Promise<void>
Delete a webhook in the channel.

Example
```
webhooks.delete(webhook);
```
Parameters
- webhook: string | Webhook
  
  The webhook to delete.
Returns Promise<void>
- Defined in guilded.ts/src/managers/channel/ChannelWebhookManager.ts:101

edit

edit(webhook: string | Webhook, name: string, channelId?: string): Promise<Webhook>
Edit a webhook in the channel.

Returns
The edited webhook.

Example
```
webhooks.edit(webhook, 'My Webhook');
```
Parameters
- webhook: string | Webhook
  
  The webhook to edit.
- name: string
  
  The name of the webhook.
- Optional channelId: string
  
  The ID of the channel to move the webhook to.
Returns Promise<Webhook>
- Defined in guilded.ts/src/managers/channel/ChannelWebhookManager.ts:85

fetch

fetch(webhook: string | Webhook, options?: FetchOptions): Promise<Webhook>
Fetch a webhook from the channel, or cache.

Returns
The fetched webhook.

Example
```
webhooks.fetch(webhook);
```
Parameters
- webhook: string | Webhook
  
  The webhoook to fetch.
- Optional options: FetchOptions
  
  The options to fetch the webhook with.
Returns Promise<Webhook>
- Defined in guilded.ts/src/managers/channel/ChannelWebhookManager.ts:25
fetch(options?: FetchManyOptions): Promise<Collection<string, Webhook>>
Fetch multiple webhooks from the channel.

Returns
The fetched webhooks.

Example
```
webhooks.fetch();
```
Parameters
- Optional options: FetchManyOptions
  
  The options to fetch webhooks with.
Returns Promise<Collection<string, Webhook>>
- Defined in guilded.ts/src/managers/channel/ChannelWebhookManager.ts:32

setMaxCache

setMaxCache(maxSize: number): ChannelWebhookManager
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 ChannelWebhookManager
Inherited from BaseManager.setMaxCache
- Defined in guilded.ts/src/managers/BaseManager.ts:26

Class ChannelWebhookManager

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

channel: Channel

Returns ChannelWebhookManager

Properties

Readonly cache

Readonly channel

Readonly client

Methods

create

Returns

Example

Parameters

name: string

Returns Promise<Webhook>

delete

Example

Parameters

webhook: string | Webhook

Returns Promise<void>

edit

Returns

Example

Parameters

webhook: string | Webhook

name: string

Optional channelId: string

Returns Promise<Webhook>

fetch

Returns

Example

Parameters

webhook: string | Webhook

Optional options: FetchOptions

Returns Promise<Webhook>

Returns

Example

Parameters

Optional options: FetchManyOptions

Returns Promise<Collection<string, Webhook>>

setMaxCache

Returns

Example

Parameters

maxSize: number

Returns ChannelWebhookManager

Settings

Member Visibility

Theme

`Readonly` cache

`Readonly` channel

`Readonly` client

`Optional` channelId: string

`Optional` options: FetchOptions

`Optional` options: FetchManyOptions