Class Webhook

Hierarchy

Webhook

Index

Constructors

Methods

addEmbed get isValid modify send setAvatarUrl setContent setFile setTTS setUsername toObject

Constructors

constructor

new Webhook(webhookUrl: string): Webhook
Parameters
- webhookUrl: string
Returns Webhook
- Defined in Classes/Webhook.ts:50

Methods

addEmbed

addEmbed(embed: Embed): Webhook
Add Embedded "rich" content. Max 10 embeds

Returns
Embed
Parameters
- embed: Embed
  
  string
Returns Webhook
- Defined in Classes/Webhook.ts:110

get

get(): AxiosPromise<IWebhookResponse>
Get the current webhook.

Returns
AxiosPromise

Returns AxiosPromise<IWebhookResponse>
- Defined in Classes/Webhook.ts:164

isValid

isValid(): Promise<boolean>
Check whether or not the current webhook is valid.

Returns
Promise

Returns Promise<boolean>
- Defined in Classes/Webhook.ts:178

modify

modify(options: IWebhookParameter): AxiosPromise<IWebhookResponse>
Modify the current webhook.

Returns
AxiosPromise
Parameters
- options: IWebhookParameter
  
  IWebHookParameter
Returns AxiosPromise<IWebhookResponse>
- Defined in Classes/Webhook.ts:148

send

send(): Promise<unknown>
Send webhook

Returns
AxiosPromise

Returns Promise<unknown>
- Defined in Classes/Webhook.ts:133

setAvatarUrl

setAvatarUrl(url: string): Webhook
Set Webhook avatar override.

Returns
Embed
Parameters
- url: string
  
  string
Returns Webhook
- Defined in Classes/Webhook.ts:75

setContent

setContent(content: string): Webhook
Set Message contents. Max 2000 characters

Returns
Embed
Parameters
- content: string
  
  string
Returns Webhook
- Defined in Classes/Webhook.ts:98

setFile

setFile(file: string | IAttachment): Webhook
Set Contents of a file being sent.

Returns
Embed
Parameters
- file: string | IAttachment
  
  Attachment | string
Returns Webhook
- Defined in Classes/Webhook.ts:123

setTTS

setTTS(flag: boolean): Webhook
Set Whether or not this notification should be read as text to speech.

Returns
Embed
Parameters
- flag: boolean
  
  boolean
Returns Webhook
- Defined in Classes/Webhook.ts:86

setUsername

setUsername(username: string): Webhook
Set Webhook username override.

Returns
Embed
Parameters
- username: string
  
  string
Returns Webhook
- Defined in Classes/Webhook.ts:64

toObject

toObject(): IWebhook
Generate parameter ready object

Returns
IWebhook

Returns IWebhook
- Defined in Classes/Webhook.ts:189

Generated using TypeDoc