Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Webhook

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

client

client: Client

The client that instantiated this structure

data

data: APIWebhook

Raw Webhook data

Accessors

avatar

  • get avatar(): undefined | null | string

  • The webhook avatar's hash

    Returns undefined | null | string

channel

  • get channel(): undefined | Guild

  • The Channel this webhook belongs to

    Returns undefined | Guild

channelId

  • get channelId(): undefined | string

  • The Id of the channel the webhook is in

    Returns undefined | string

createdAt

  • get createdAt(): Date

  • The time the webhook was created at

    Returns Date

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the webhook was created at

    Returns number

guild

  • get guild(): undefined | Guild

  • The Guild this webhook belongs to

    Returns undefined | Guild

guildId

  • get guildId(): undefined | string

  • The Id of the guild the webhook is in

    Returns undefined | string

id

  • get id(): string

  • The Id of this webhook

    Returns string

name

  • get name(): undefined | string

  • The name of this webhook

    Returns undefined | string

sourceChannel

  • get sourceChannel(): undefined | Channel

  • The source channel of the webhook

    Returns undefined | Channel

sourceGuild

  • get sourceGuild(): undefined | Guild

  • The source guild of the webhook

    Returns undefined | Guild

token

  • get token(): undefined | string

  • The token of this webhook

    Returns undefined | string

type

  • The type of the webhook

    Returns undefined | WebhookType

url

  • get url(): string

  • The URL of this webhook

    Returns string

user

  • get user(): undefined | User

  • The owner of the webhook

    Returns undefined | User

Methods

avatarURL

  • A link to the webhook's avatar

    Parameters

    Returns null | string

clone

  • clone(): any

  • Returns any

delete

  • delete(): Promise<undefined>

  • Deletes this webhook

    Returns Promise<undefined>

deleteMessage

  • deleteMessage(id: string): Promise<undefined>

  • Deletes a message that was sent by this webhook

    Parameters

    • id: string

    Returns Promise<undefined>

editMessage

  • Edits a message that was sent by this webhook

    example
    const { EmbedBuilder } = require('helly');
    const embed = new EmbedBuilder().setTitle('...world!')
    webhook.editMessage('123456789123456', { content: 'Hello...', embeds: [embed] })
    example
    webhook.editMessage('123456789123456', 'I\'m watching you!')

    Parameters

    • id: string

      The Id of the message to edit

    • content: MessageOptions

      The new content of the message

    Returns Promise<Message>

fetchMessage

  • fetchMessage(id: string): Promise<Message>

  • Gets a message that was sent by this webhook

    Parameters

    • id: string

    Returns Promise<Message>

Private parseData

  • Parameters

    Returns Webhook

send

  • Sends a message with this webhook

    example
    const { EmbedBuilder } = require('helly');
    const embed = new EmbedBuilder().setTitle('...world!')
    webhook.send({ content: 'Hello...', embeds: [embed] })
    example
    webhook.send('I\'m watching you!')

    Parameters

    Returns Promise<Message>

sendSlackMessage

  • sendSlackMessage(message: Record<string, unknown>): Promise<boolean>

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:16 AM