Class Webhooks

Webhook routes.

Index

Constructors

Methods

create delete edit execute get getWebhooks

Constructors

constructor

new Webhooks(manager: RESTManager): Webhooks
Parameters
- manager: RESTManager
  REST Manager needed to execute request.
Returns Webhooks
- Defined in lib/routes/Webhooks.ts:20

Methods

create

create(guildID: string, channelID: string, name: string): Promise<Webhook>
Create a webhook
Parameters
- guildID: string
  ID of a guild.
- channelID: string
  ID of a channel.
- name: string
  Name of the new webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Webhooks.ts:29

delete

delete(guildID: string, webhookID: string): Promise<void>
Delete a webhook
Parameters
- guildID: string
  ID of a guild.
- webhookID: string
  ID of an existent webhook.
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:44

edit

edit(
    guildID: string,
    webhookID: string,
    options: EditWebhookOptions,
): Promise<Webhook>
Update a webhook
Parameters
- guildID: string
  ID of a guild.
- webhookID: string
  ID of an existent webhook.
- options: EditWebhookOptions
  Edit options.
Returns Promise<Webhook>
- Defined in lib/routes/Webhooks.ts:55

execute

execute(
    webhookID: string,
    token: string,
    options: WebhookExecuteOptions,
): Promise<WebhookMessageDetails>
Execute a webhook.
Parameters
- webhookID: string
  ID of the webhook to execute.
- token: string
  Token of the webhook, needed to execute it.
- options: WebhookExecuteOptions
  Execute Options.
Returns Promise<WebhookMessageDetails>
- Defined in lib/routes/Webhooks.ts:74

get

get(guildID: string, webhookID: string): Promise<Webhook>
This method is used to get a specific webhook.
Parameters
- guildID: string
  ID of a guild.
- webhookID: string
  ID of a webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Webhooks.ts:104

getWebhooks

getWebhooks(guildID: string, channelID: string): Promise<Webhook[]>
This method is used to get a list of Webhook.
Parameters
- guildID: string
  ID of a guild.
- channelID: string
  ID of a channel.
Returns Promise<Webhook[]>
- Defined in lib/routes/Webhooks.ts:115