Class GuildChannelWebhooksController

Provides an interface for a guild channel's webhooks cache. The webhooks are mapped by their IDs

Hierarchy

BaseFetchController<Webhook>
- GuildChannelWebhooksController

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GuildChannelWebhooksController(channel: GuildChannel): GuildChannelWebhooksController

Overrides BaseController.constructor
- Defined in src/controllers/guild/GuildChannelWebhooksController.ts:23
Parameters
- channel: GuildChannel
Returns GuildChannelWebhooksController

Properties

cache

cache: ControllerCache<Webhook>

The cached data this controller contains

Readonly channel

channel: GuildChannel

The guild channel associated to this controller

Methods

create

create(options: CreateWebhookOptions): Promise<Webhook>

- Defined in src/controllers/guild/GuildChannelWebhooksController.ts:37
Creates a new webhook for this guild channel. Requires the Permission.ManageWebhooks permission

Parameters
- options: CreateWebhookOptions
  
  The options for the new webhook
Returns Promise<Webhook>

delete

delete(id: Snowflake): Promise<void>

- Defined in src/controllers/guild/GuildChannelWebhooksController.ts:77
Deletes a webhook permanently. Requires the Permission.ManageWebhooks permission

Parameters
- id: Snowflake
  
  The ID of the webhook
Returns Promise<void>

fetch

fetch(id: Snowflake): Promise<Webhook>

Overrides BaseFetchController.fetch
- Defined in src/controllers/guild/GuildChannelWebhooksController.ts:63
Fetches a webhook by its ID

Parameters
- id: Snowflake
  
  The ID of the webhook
Returns Promise<Webhook>

fetchAll

fetchAll(): Promise<Collection<Snowflake, Webhook>>

- Defined in src/controllers/guild/GuildChannelWebhooksController.ts:50
Fetches all webhooks in this guild channel. Requires the Permission.ManageWebhooks permission

Returns Promise<Collection<Snowflake, Webhook>>

get

get(id: Snowflake | string): Promise<Webhook>

Inherited from BaseFetchController.get
- Defined in src/controllers/base/BaseFetchController.ts:22
Returns an already cached item or fetches it

Parameters
- id: Snowflake | string
  
  The ID of the item you wish to get or fetch
Returns Promise<Webhook>

Generated using TypeDoc