Class Webhook

Index

Constructors

Properties

avatar_url? client content? embeds? file? tts? username?

Methods

addEmbed delete get isValid modify send setAvatarUrl setContent setFile setTTS setUsername toObject getWebhook

Constructors

constructor

new Webhook(hookUrl): Webhook
Parameters
- hookUrl: string
Returns Webhook
- Defined in Classes/Webhook.ts:21

Properties

`Protected` `Optional` avatar_url

avatar_url?: string

`Protected` client

client: Request

`Protected` `Optional` content

content?: string

`Protected` `Optional` embeds

embeds?: IEmbed[]

`Protected` `Optional` file

file?: string | IAttachment

`Protected` `Optional` tts

tts?: boolean

`Protected` `Optional` username

username?: string

Methods

addEmbed

addEmbed(embed): Webhook
Parameters
- embed: Embed
Returns Webhook
- Defined in Classes/Webhook.ts:44

delete

delete(): AxiosPromise<IWebhookResponse>
Returns AxiosPromise<IWebhookResponse>
- Defined in Classes/Webhook.ts:82

get

get(): AxiosPromise<IWebhookResponse>
Returns AxiosPromise<IWebhookResponse>
- Defined in Classes/Webhook.ts:68

isValid

isValid(): Promise<boolean>
Returns Promise<boolean>
- Defined in Classes/Webhook.ts:105

modify

modify(options): AxiosPromise<IWebhookResponse>
Parameters
- options: IWebhookParameter
Returns AxiosPromise<IWebhookResponse>
- Defined in Classes/Webhook.ts:75

send

send(): Promise<unknown>
Returns Promise<unknown>
- Defined in Classes/Webhook.ts:61

setAvatarUrl

setAvatarUrl(url): Webhook
Parameters
- url: string
Returns Webhook
- Defined in Classes/Webhook.ts:29

setContent

setContent(content): Webhook
Parameters
- content: string
Returns Webhook
- Defined in Classes/Webhook.ts:39

setFile

setFile(file): Webhook
Parameters
- file: string | IAttachment
Returns Webhook
- Defined in Classes/Webhook.ts:56

setTTS

setTTS(tts): Webhook
Parameters
- tts: boolean
Returns Webhook
- Defined in Classes/Webhook.ts:51

setUsername

setUsername(username): Webhook
Parameters
- username: string
Returns Webhook
- Defined in Classes/Webhook.ts:34

`Private` toObject

toObject(): IWebhook
Returns IWebhook
- Defined in Classes/Webhook.ts:89

`Static` getWebhook

getWebhook(id, token): AxiosPromise<IWebhookResponse>
Parameters
- id: string
- token: string
Returns AxiosPromise<IWebhookResponse>
- Defined in Classes/Webhook.ts:101

Generated using TypeDoc