Class Webhook

Object representing received webhook data. This object is NOT to be used to send data to webhooks. That would be WebhookClient

Hierarchy

Base<WebhookPayload>
- Webhook

Index

Constructors

constructor

new Webhook(client, data): Webhook
Parameters
- client: Client
- data: WebhookPayload
Returns Webhook
Overrides Base.constructor
- Defined in guilded.js/lib/structures/Webhook.ts:47

Properties

_createdAt

_createdAt: number

The date in which this webhook was created

_deletedAt

_deletedAt: null | number = null

The date this webhook was deleted if it was deleted

`Readonly` authorID

authorID: string

The user who created this webhook

channelID

channelID: string

The ID of the channel this webhook belongs to

`Readonly` client

client: Client

id

id: string

Identifier of this structrure

name

name: string

The username belonging to this webhook

raw

raw: WebhookPayload

Bare data of this structure

`Readonly` serverId

serverId: string

The ID of the server this webhook belongs to

token

token: null | string

The token of this webhook

Accessors

createdAt

get createdAt(): Date
Returns the creation date of this webhook

Returns Date
The creation date of this webhook
- Defined in guilded.js/lib/structures/Webhook.ts:60

deletedAt

get deletedAt(): null | Date
Returns the deletion date of this webhook if it was deleted

Returns null | Date
The deletion date of this webhook if it was deleted, otherwise null
- Defined in guilded.js/lib/structures/Webhook.ts:69

user

get user(): null | User
Returns the author of this webhook

Returns null | User
The author of this webhook, or null if the author is not cached
- Defined in guilded.js/lib/structures/Webhook.ts:78

Methods

_clone

_clone(): Webhook
Taken from https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/src/structures/Base.js#L20 Licensed under the Apache License 2.0 https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/LICENSE

Returns Webhook
Inherited from Base._clone
- Defined in guilded.js/lib/structures/Base.ts:28

_update

_update(data): Webhook
Parameters
- data: Partial<WebhookPayload>
Returns Webhook
- Defined in guilded.js/lib/structures/Webhook.ts:102

delete

delete(): Promise<Webhook>
Deletes this webhook

Returns Promise<Webhook>
A promise that resolves with this webhook after it has been deleted
- Defined in guilded.js/lib/structures/Webhook.ts:97

update

update(options): Promise<Webhook>
Updates this webhook with new options
Parameters
- options: {}
  
  The new options for this webhook
Returns Promise<Webhook>
A promise that resolves with the updated webhook
- Defined in guilded.js/lib/structures/Webhook.ts:88

Class Webhook

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

data: WebhookPayload

Returns Webhook

Properties

_createdAt

_deletedAt

Readonly authorID

channelID

Readonly client

id

name

raw

Readonly serverId

token

Accessors

createdAt

Returns Date

deletedAt

Returns null | Date

user

Returns null | User

Methods

_clone

Returns Webhook

_update

Parameters

data: Partial<WebhookPayload>

Returns Webhook

delete

Returns Promise<Webhook>

update

Parameters

options: {}

Returns Promise<Webhook>

Settings

Member Visibility

Theme

On This Page

`Readonly` authorID

`Readonly` client

`Readonly` serverId