Class Webhook

Hierarchy

Webhook

Index

Constructors

Properties

defaultPayload? options

Methods

delete execute get modify request setAvatar setUsername

Constructors

constructor

new Webhook(options: WebhookOptions): Webhook
Create a new Webhook instance
Parameters
- options: WebhookOptions
Returns Webhook
- Defined in Webhook.ts:13

Properties

`Optional` defaultPayload

defaultPayload?: {}

Type declaration

`Private` options

options: WebhookOptions

Methods

delete

delete(): Promise<any>
Delete the webhook

Returns Promise<any>
- Defined in Webhook.ts:57

execute

execute(data: ExecuteWebhookData): Promise<any>
Send a message to the webhook
Parameters
- data: ExecuteWebhookData
Returns Promise<any>
- Defined in Webhook.ts:65

get

get(): Promise<APIWebhook>
Get webhook information

Returns

Returns Promise<APIWebhook>
- Defined in Webhook.ts:19

modify

modify(options: WebhookOptions): Promise<any>
Modify the webhook
Parameters
- options: WebhookOptions
Returns Promise<any>
- Defined in Webhook.ts:50

`Private` request

request<T>(url: string, method?: string, postData?: any, file?: DiscordFile | DiscordFile[]): Promise<T>
Private
Make a request to the webhook

Returns
Type Parameters
- T = any
Parameters
- url: string
- Optional method: string
- Optional postData: any
- Optional file: DiscordFile | DiscordFile[]
Returns Promise<T>
- Defined in Webhook.ts:88

setAvatar

setAvatar(avatar: string): void
Set the default avatar for the webhook
Parameters
- avatar: string
Returns void
- Defined in Webhook.ts:39

setUsername

setUsername(username: string): void
Set the default username for the webhook
Parameters
- username: string
Returns void
- Defined in Webhook.ts:28

Generated using TypeDoc