Class Webhook

Webhook Structure

Hierarchy

BaseStructure
- Webhook

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Webhook(client: ShardClient, data?: BaseStructureData, isClone?: boolean): Webhook

Overrides BaseStructure.constructor
- Defined in src/structures/webhook.ts:52
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Webhook

Properties

Readonly _keys

_keys: BaseSet<string> = ...

applicationId

applicationId: null | string = null

avatar

avatar: null | string = null

channelId

channelId: string = ''

Readonly client

client: ShardClient

discriminator

discriminator: string = '0000'

guildId

guildId: string = ''

id

id: string = ''

name

name: string = ''

Optional sourceChannel

sourceChannel: Channel

Optional sourceGuild

sourceGuild: BaseGuild

Optional token

token: null | string

type

type: WebhookTypes = ...

Optional user

user: null | User

Accessors

avatarUrl

get avatarUrl(): string

- Defined in src/structures/webhook.ts:63
Returns string

channel

get channel(): null | Channel

- Defined in src/structures/webhook.ts:67
Returns null | Channel

createdAt

get createdAt(): Date

- Defined in src/structures/webhook.ts:71
Returns Date

createdAtUnix

get createdAtUnix(): number

- Defined in src/structures/webhook.ts:75
Returns number

defaultAvatarUrl

get defaultAvatarUrl(): string

- Defined in src/structures/webhook.ts:79
Returns string

guild

get guild(): null | Guild

- Defined in src/structures/webhook.ts:83
Returns null | Guild

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

jumpLink

get jumpLink(): string

- Defined in src/structures/webhook.ts:87
Returns string

mention

get mention(): string

- Defined in src/structures/webhook.ts:91
Returns string

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

avatarUrlFormat

avatarUrlFormat(format?: string, query?: UrlQuery): string

- Defined in src/structures/webhook.ts:95
Parameters
- Optional format: string
- Optional query: UrlQuery
Returns string

clone

clone(): Webhook

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Webhook

createMessage

createMessage(options: ExecuteWebhook, compatibleType?: string): Promise<null | Message>

- Defined in src/structures/webhook.ts:114
Parameters
- options: ExecuteWebhook
- Optional compatibleType: string
Returns Promise<null | Message>

delete

delete(options?: DeleteWebhook): Promise<any>

- Defined in src/structures/webhook.ts:121
Parameters
- options: DeleteWebhook = {}
Returns Promise<any>

deleteMessage

deleteMessage(messageId: string): Promise<any>

- Defined in src/structures/webhook.ts:128
Parameters
- messageId: string
Returns Promise<any>

difference

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

edit

edit(options?: EditWebhook): Promise<Webhook>

- Defined in src/structures/webhook.ts:135
Parameters
- options: EditWebhook = {}
Returns Promise<Webhook>

editMessage

editMessage(messageId: string, options?: EditWebhookTokenMessage): Promise<Message>

- Defined in src/structures/webhook.ts:142
Parameters
- messageId: string
- options: EditWebhookTokenMessage = {}
Returns Promise<Message>

execute

execute(options: ExecuteWebhook, compatibleType?: string): Promise<null | Message>

- Defined in src/structures/webhook.ts:149
Parameters
- options: ExecuteWebhook
- Optional compatibleType: string
Returns Promise<null | Message>

fetchMessage

fetchMessage(messageId: string): Promise<Message>

- Defined in src/structures/webhook.ts:159
Parameters
- messageId: string
Returns Promise<Message>

hasDifference

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

mergeValue(key: string, value: any): void

Overrides BaseStructure.mergeValue
- Defined in src/structures/webhook.ts:167
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

toString

toString(): string

- Defined in src/structures/webhook.ts:197
Returns string

Generated using TypeDoc