Documentation/detritus-client/Structures

Webhookclass

Webhook Structure

On this page

Overview
Constructor1
Properties14
Accessors10
Methods22

Webhook Structure

import { Structures } from 'detritus-client';

Structures.Webhook;

Hierarchy

StructureBaseStructureWebhook

21 properties10 methods15 inheritedsrc/structures/webhook.ts:41

Constructor

new Webhook

src/structures/webhook.ts:59

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

Properties

applicationId

string | null

Default null

avatar

string | null

Default null

channelId

string

Default ''

client

ShardClient

readonly

Inherited from BaseStructure.client

discriminator

string

Default '0000'

guildId

string

Default ''

string

Default ''

name

string

Default ''

sourceChannel?

Channel

optional

sourceGuild?

BaseGuild

optional

token?

string | null

optional

type

WebhookTypes

Default WebhookTypes.INCOMING

url?

string

optional

user?

User | null

optional

Accessors

avatarUrl

string

get

channel

Channel | null

get

createdAt

Date

get

createdAtUnix

number

get

defaultAvatarUrl

string

get

guild

Guild | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

jumpLink

string

get

mention

string

get

shardId

number

get

Inherited from BaseStructure.shardId

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

avatarUrlFormat()

src/structures/webhook.ts:101

avatarUrlFormat(
  format?: string | number | UrlQuery | null,
  query?: number | UrlQuery,
): string

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

createMessage()

async src/structures/webhook.ts:119

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

delete()

async src/structures/webhook.ts:126

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

deleteMessage()

async src/structures/webhook.ts:133

deleteMessage(messageId: string, options?: DeleteWebhookTokenMessage): Promise<any>

difference()

src/structures/basestructure.ts:146

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

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

edit()

async src/structures/webhook.ts:140

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

editMessage()

async src/structures/webhook.ts:147

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

execute()

async src/structures/webhook.ts:154

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

fetchMessage()

async src/structures/webhook.ts:164

fetchMessage(messageId: string, options?: FetchWebhookTokenMessage): Promise<Message>

hasDifference()

src/structures/basestructure.ts:218

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

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/webhook.ts:172

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON

toString()

src/structures/webhook.ts:235

toString(): string

Returns a string representation of an object.