Class Webhook<Type>`Internal`

Type Parameters

Type extends WebhookType = WebhookType

Hierarchy

WebhookFields
- Webhook

Index

Constructors

`Private` constructor

new Webhook<Type>(client, data?): Webhook<Type>
Type Parameters
- Type extends WebhookType = WebhookType
Parameters
- client: Client<true>
- Optional data: RawWebhookData
Returns Webhook<Type>
Inherited from WebhookFields.constructor
- Defined in node_modules/discord.js/typings/index.d.ts:3663

Properties

applicationId

applicationId: Type extends Application
? string
: null

avatar

avatar: null | string

channelId

channelId: string

`Readonly` client

client: Client<boolean>

guildId

guildId: string

id

id: string

name

name: string

owner

owner: Type extends Incoming
? null | User | APIUser
: User | APIUser

sourceChannel

sourceChannel: Type extends ChannelFollower
? NewsChannel | APIPartialChannel
: null

sourceGuild

sourceGuild: Type extends ChannelFollower
? Guild | APIPartialGuild
: null

token

token: Type extends Incoming
    ? string
    : Type extends ChannelFollower
        ? null
        : null | string

type

type: Type

Accessors

channel

get channel(): null | NewsChannel | StageChannel | TextChannel | VoiceChannel | ForumChannel | MediaChannel
Returns null | NewsChannel | StageChannel | TextChannel | VoiceChannel | ForumChannel | MediaChannel
- Defined in node_modules/discord.js/typings/index.d.ts:3680

createdAt

get createdAt(): Date
Returns Date
Inherited from WebhookFields.createdAt
- Defined in node_modules/discord.js/typings/index.d.ts:4729

createdTimestamp

get createdTimestamp(): number
Returns number
Inherited from WebhookFields.createdTimestamp
- Defined in node_modules/discord.js/typings/index.d.ts:4730

url

get url(): string
Returns string
Inherited from WebhookFields.url
- Defined in node_modules/discord.js/typings/index.d.ts:4715

Methods

avatarURL

avatarURL(options?): null | string
Parameters
- Optional options: ImageURLOptions
Returns null | string
- Defined in node_modules/discord.js/typings/index.d.ts:3665

delete

delete(reason?): Promise<void>
Parameters
- Optional reason: string
Returns Promise<void>
Inherited from WebhookFields.delete
- Defined in node_modules/discord.js/typings/index.d.ts:4731

deleteMessage

deleteMessage(message, threadId?): Promise<void>
Parameters
- message: APIMessage | MessageResolvable
- Optional threadId: string
Returns Promise<void>
Inherited from WebhookFields.deleteMessage
- Defined in node_modules/discord.js/typings/index.d.ts:4716

edit

edit(options): Promise<Webhook<Type>>
Parameters
- options: WebhookEditOptions
Returns Promise<Webhook<Type>>
Inherited from WebhookFields.edit
- Defined in node_modules/discord.js/typings/index.d.ts:4732

editMessage

editMessage(message, options): Promise<Message<boolean>>
Parameters
- message: MessageResolvable
- options: string | MessagePayload | WebhookMessageEditOptions
Returns Promise<Message<boolean>>
Inherited from WebhookFields.editMessage
- Defined in node_modules/discord.js/typings/index.d.ts:3688

fetchMessage

fetchMessage(message, options?): Promise<Message<boolean>>
Parameters
- message: string
- Optional options: WebhookFetchMessageOptions
Returns Promise<Message<boolean>>
Inherited from WebhookFields.fetchMessage
- Defined in node_modules/discord.js/typings/index.d.ts:3692

isApplicationCreated

isApplicationCreated(): this is Webhook<Application>
Returns this is Webhook<Application>
- Defined in node_modules/discord.js/typings/index.d.ts:3684

isChannelFollower

isChannelFollower(): this is Webhook<ChannelFollower>
Returns this is Webhook<ChannelFollower>
- Defined in node_modules/discord.js/typings/index.d.ts:3686

isIncoming

isIncoming(): this is Webhook<Incoming>
Returns this is Webhook<Incoming>
- Defined in node_modules/discord.js/typings/index.d.ts:3685

isUserCreated

isUserCreated(): this is Webhook<Incoming> & {
owner: User | APIUser;
}
Returns this is Webhook<Incoming> & {
owner: User | APIUser;
}
- Defined in node_modules/discord.js/typings/index.d.ts:3681

send

send(options): Promise<Message<boolean>>
Parameters
- options: string | MessagePayload | WebhookMessageCreateOptions
Returns Promise<Message<boolean>>
Inherited from WebhookFields.send
- Defined in node_modules/discord.js/typings/index.d.ts:3693

sendSlackMessage

sendSlackMessage(body): Promise<boolean>
Parameters
- body: unknown
Returns Promise<boolean>
Inherited from WebhookFields.sendSlackMessage
- Defined in node_modules/discord.js/typings/index.d.ts:4733

Class Webhook<Type>Internal

Type Parameters

Type extends WebhookType = WebhookType

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Type Parameters

Type extends WebhookType = WebhookType

Parameters

client: Client<true>

Optional data: RawWebhookData

Returns Webhook<Type>

Properties

applicationId

avatar

channelId

Readonly client

guildId

id

name

owner

sourceChannel

sourceGuild

token

type

Accessors

channel

Returns null | NewsChannel | StageChannel | TextChannel | VoiceChannel | ForumChannel | MediaChannel

createdAt

Returns Date

createdTimestamp

Returns number

url

Returns string

Methods

avatarURL

Parameters

Optional options: ImageURLOptions

Returns null | string

delete

Parameters

Optional reason: string

Returns Promise<void>

deleteMessage

Parameters

message: APIMessage | MessageResolvable

Optional threadId: string

Returns Promise<void>

edit

Parameters

options: WebhookEditOptions

Returns Promise<Webhook<Type>>

editMessage

Parameters

message: MessageResolvable

options: string | MessagePayload | WebhookMessageEditOptions

Returns Promise<Message<boolean>>

fetchMessage

Parameters

message: string

Optional options: WebhookFetchMessageOptions

Returns Promise<Message<boolean>>

isApplicationCreated

Returns this is Webhook<Application>

isChannelFollower

Returns this is Webhook<ChannelFollower>

isIncoming

Returns this is Webhook<Incoming>

isUserCreated

Returns this is Webhook<Incoming> & { owner: User | APIUser; }

send

Parameters

options: string | MessagePayload | WebhookMessageCreateOptions

Returns Promise<Message<boolean>>

sendSlackMessage

Class Webhook<Type>`Internal`

`Private` constructor

`Optional` data: RawWebhookData

`Readonly` client

`Optional` options: ImageURLOptions

`Optional` reason: string

`Optional` threadId: string

`Optional` options: WebhookFetchMessageOptions

Returns this is Webhook<Incoming> & {
owner: User | APIUser;
}