Class MessagePayload

Represents the payload for creating or updating a message. This class encapsulates all the parameters needed to send a message in Discord.

Index

Constructors

constructor

new MessagePayload(data?): MessagePayload
Creates a new MessagePayload instance.
Parameters
- Optionaldata: {
      allowed_mentions?: {
          everyone?: boolean;
          repliedUser?: boolean;
          roles?: boolean | string[];
          users?: boolean | string[];
      };
      attachments?: {
          description?: string;
          filename: string;
          id: number;
      }[];
      components?: any[];
      content?: string;
      embeds?: any[];
      enforce_nonce?: boolean;
      flags?: number;
      message_reference?: {
          channelID?: string;
          failIfNotExists?: boolean;
          guildID?: string;
          messageID: string;
      };
      nonce?: string | number;
      poll?: any;
      sticker_ids?: string[];
      tts?: boolean;
  }
  Optional initial data to set in the payload.
  - Optionalallowed_mentions?: {
        everyone?: boolean;
        repliedUser?: boolean;
        roles?: boolean | string[];
        users?: boolean | string[];
    }
    - Optionaleveryone?: boolean
    - OptionalrepliedUser?: boolean
    - Optionalroles?: boolean | string[]
    - Optionalusers?: boolean | string[]
  - Optionalattachments?: {
        description?: string;
        filename: string;
        id: number;
    }[]
  - Optionalcomponents?: any[]
  - Optionalcontent?: string
  - Optionalembeds?: any[]
  - Optionalenforce_nonce?: boolean
  - Optionalflags?: number
  - Optionalmessage_reference?: {
        channelID?: string;
        failIfNotExists?: boolean;
        guildID?: string;
        messageID: string;
    }
    - OptionalchannelID?: string
    - OptionalfailIfNotExists?: boolean
    - OptionalguildID?: string
    - messageID: string
  - Optionalnonce?: string | number
  - Optionalpoll?: any
  - Optionalsticker_ids?: string[]
  - Optionaltts?: boolean
Returns MessagePayload
- Defined in structures/messagePayload.ts:37

Accessors

allowedMentions

get allowedMentions(): {
    everyone?: boolean;
    repliedUser?: boolean;
    roles?: boolean | string[];
    users?: boolean | string[];
}
Gets the allowed mentions for the message.

Returns {
    everyone?: boolean;
    repliedUser?: boolean;
    roles?: boolean | string[];
    users?: boolean | string[];
}
The allowed mentions object.
- Optionaleveryone?: boolean
- OptionalrepliedUser?: boolean
- Optionalroles?: boolean | string[]
- Optionalusers?: boolean | string[]
- Defined in structures/messagePayload.ts:161
set allowedMentions(value): void
Sets the allowed mentions for the message.
Parameters
- value: {
      everyone?: boolean;
      repliedUser?: boolean;
      roles?: boolean | string[];
      users?: boolean | string[];
  }
  The allowed mentions object.
  - Optionaleveryone?: boolean
  - OptionalrepliedUser?: boolean
  - Optionalroles?: boolean | string[]
  - Optionalusers?: boolean | string[]
Returns void
- Defined in structures/messagePayload.ts:169

attachments

get attachments(): {
    description?: string;
    filename: string;
    id: number;
}[]
Gets the attachments for the message.

Returns {
    description?: string;
    filename: string;
    id: number;
}[]
An array of attachment objects.
- Defined in structures/messagePayload.ts:243
set attachments(value): void
Sets the attachments for the message.
Parameters
- value: {
      description?: string;
      filename: string;
      id: number;
  }[]
  An array of attachment objects.
Returns void
- Defined in structures/messagePayload.ts:251

components

get components(): any[]
Gets the components for the message.

Returns any[]
An array of message component objects.
- Defined in structures/messagePayload.ts:207
set components(value): void
Sets the components for the message.
Parameters
- value: any[]
  An array of message component objects.
Returns void
- Defined in structures/messagePayload.ts:215

content

get content(): string
Gets the content of the message.

Returns string
The message content.
- Defined in structures/messagePayload.ts:85
set content(value): void
Sets the content of the message.
Parameters
- value: string
  The message content. Should be up to 2000 characters.
Returns void
Throws
Error if the content exceeds 2000 characters.
- Defined in structures/messagePayload.ts:94

embeds

get embeds(): any[]
Gets the embeds for the message.

Returns any[]
An array of embed objects.
- Defined in structures/messagePayload.ts:141
set embeds(value): void
Sets the embeds for the message.
Parameters
- value: any[]
  An array of embed objects. Up to 10 embeds allowed.
Returns void
Throws
Error if the array exceeds 10 embeds.
- Defined in structures/messagePayload.ts:150

enforceNonce

get enforceNonce(): boolean
Gets the enforce nonce flag.

Returns boolean
True if nonce uniqueness should be enforced.
- Defined in structures/messagePayload.ts:279
set enforceNonce(value): void
Sets the enforce nonce flag.
Parameters
- value: boolean
  True if nonce uniqueness should be enforced.
Returns void
- Defined in structures/messagePayload.ts:287

flags

get flags(): number
Gets the flags for the message.

Returns number
The message flags.
- Defined in structures/messagePayload.ts:263
set flags(value): void
Sets the flags for the message.
Parameters
- value: number
  The message flags as a bitfield.
Returns void
- Defined in structures/messagePayload.ts:271

messageReference

get messageReference(): {
    channelID?: string;
    failIfNotExists?: boolean;
    guildID?: string;
    messageID: string;
}
Gets the message reference object.

Returns {
    channelID?: string;
    failIfNotExists?: boolean;
    guildID?: string;
    messageID: string;
}
The message reference object.
- OptionalchannelID?: string
- OptionalfailIfNotExists?: boolean
- OptionalguildID?: string
- messageID: string
- Defined in structures/messagePayload.ts:182
set messageReference(value): void
Sets the message reference object for replies or forwards.
Parameters
- value: {
      channelID?: string;
      failIfNotExists?: boolean;
      guildID?: string;
      messageID: string;
  }
  The message reference object. Must include messageID.
  - OptionalchannelID?: string
  - OptionalfailIfNotExists?: boolean
  - OptionalguildID?: string
  - messageID: string
Returns void
Throws
Error if messageID is not provided.
- Defined in structures/messagePayload.ts:191

nonce

get nonce(): string | number
Gets the nonce for the message.

Returns string | number
The nonce value.
- Defined in structures/messagePayload.ts:105
set nonce(value): void
Sets the nonce for the message.
Parameters
- value: string | number
  The nonce value. Should be up to 25 characters if string.
Returns void
Throws
Error if the nonce exceeds 25 characters.
- Defined in structures/messagePayload.ts:114

poll

get poll(): any
Gets the poll object for the message.

Returns any
The poll object.
- Defined in structures/messagePayload.ts:295
set poll(value): void
Sets the poll object for the message.
Parameters
- value: any
  The poll object.
Returns void
- Defined in structures/messagePayload.ts:303

stickerIDs

get stickerIDs(): string[]
Gets the sticker IDs for the message.

Returns string[]
An array of sticker IDs.
- Defined in structures/messagePayload.ts:223
set stickerIDs(value): void
Sets the sticker IDs for the message.
Parameters
- value: string[]
  An array of sticker IDs. Up to 3 stickers allowed.
Returns void
Throws
Error if the array exceeds 3 stickers.
- Defined in structures/messagePayload.ts:232

tts

get tts(): boolean
Gets the TTS flag for the message.

Returns boolean
True if the message is a TTS message.
- Defined in structures/messagePayload.ts:125
set tts(value): void
Sets the TTS flag for the message.
Parameters
- value: boolean
  True if the message should be sent as TTS.
Returns void
- Defined in structures/messagePayload.ts:133

Methods

resolveFiles

resolveFiles(): Promise<{
    allowed_mentions?: any;
    attachments?: any[];
    components?: any[];
    content?: string;
    embeds?: any[];
    enforce_nonce?: boolean;
    files: any[];
    flags?: number;
    message_reference?: any;
    nonce?: string | number;
    poll?: any;
    sticker_ids?: string[];
    tts?: boolean;
}>
Returns Promise<{
    allowed_mentions?: any;
    attachments?: any[];
    components?: any[];
    content?: string;
    embeds?: any[];
    enforce_nonce?: boolean;
    files: any[];
    flags?: number;
    message_reference?: any;
    nonce?: string | number;
    poll?: any;
    sticker_ids?: string[];
    tts?: boolean;
}>
- Defined in structures/messagePayload.ts:307

toJSON

toJSON(): any
Converts the payload to a JSON-serializable object.

Returns any
A JSON-serializable representation of the payload.
- Defined in structures/messagePayload.ts:349

Class MessagePayload

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optionalallowed_mentions?: { everyone?: boolean; repliedUser?: boolean; roles?: boolean | string[]; users?: boolean | string[]; }

Optionaleveryone?: boolean

OptionalrepliedUser?: boolean

Optionalroles?: boolean | string[]

Optionalusers?: boolean | string[]

Optionalattachments?: { description?: string; filename: string; id: number; }[]

Optionalcomponents?: any[]

Optionalcontent?: string

Optionalembeds?: any[]

Optionalenforce_nonce?: boolean

Optionalflags?: number

Optionalmessage_reference?: { channelID?: string; failIfNotExists?: boolean; guildID?: string; messageID: string; }

OptionalchannelID?: string

OptionalfailIfNotExists?: boolean

OptionalguildID?: string

messageID: string

Optionalnonce?: string | number

Optionalpoll?: any

Optionalsticker_ids?: string[]

Optionaltts?: boolean

Returns MessagePayload

Accessors

allowedMentions

Returns { everyone?: boolean; repliedUser?: boolean; roles?: boolean | string[]; users?: boolean | string[]; }

Optionaleveryone?: boolean

OptionalrepliedUser?: boolean

Optionalroles?: boolean | string[]

Optionalusers?: boolean | string[]

Parameters

Optionaleveryone?: boolean

OptionalrepliedUser?: boolean

Optionalroles?: boolean | string[]

Optionalusers?: boolean | string[]

Returns void

attachments

Returns { description?: string; filename: string; id: number; }[]

Parameters

Returns void

components

Returns any[]

Parameters

Returns void

content

Returns string

Parameters

Returns void

Throws

embeds

Returns any[]

Parameters

Returns void

Throws

enforceNonce

Returns boolean

Parameters

Returns void

flags

Returns number

Parameters

Returns void

messageReference

Returns { channelID?: string; failIfNotExists?: boolean; guildID?: string; messageID: string; }

OptionalchannelID?: string

OptionalfailIfNotExists?: boolean

OptionalguildID?: string

messageID: string

Parameters

OptionalchannelID?: string

OptionalfailIfNotExists?: boolean

OptionalguildID?: string

messageID: string

Returns void

`Optional`allowed_mentions?: {
everyone?: boolean;
repliedUser?: boolean;
roles?: boolean | string[];
users?: boolean | string[];
}

`Optional`everyone?: boolean

`Optional`repliedUser?: boolean

`Optional`roles?: boolean | string[]

`Optional`users?: boolean | string[]

`Optional`attachments?: {
description?: string;
filename: string;
id: number;
}[]

`Optional`components?: any[]

`Optional`content?: string

`Optional`embeds?: any[]

`Optional`enforce_nonce?: boolean

`Optional`flags?: number

`Optional`message_reference?: {
channelID?: string;
failIfNotExists?: boolean;
guildID?: string;
messageID: string;
}

`Optional`channelID?: string

`Optional`failIfNotExists?: boolean

`Optional`guildID?: string

`Optional`nonce?: string | number

`Optional`poll?: any

`Optional`sticker_ids?: string[]

`Optional`tts?: boolean

Returns {
everyone?: boolean;
repliedUser?: boolean;
roles?: boolean | string[];
users?: boolean | string[];
}

`Optional`everyone?: boolean

`Optional`repliedUser?: boolean

`Optional`roles?: boolean | string[]

`Optional`users?: boolean | string[]

`Optional`everyone?: boolean

`Optional`repliedUser?: boolean

`Optional`roles?: boolean | string[]

`Optional`users?: boolean | string[]

Returns {
description?: string;
filename: string;
id: number;
}[]

Returns {
channelID?: string;
failIfNotExists?: boolean;
guildID?: string;
messageID: string;
}

`Optional`channelID?: string

`Optional`failIfNotExists?: boolean

`Optional`guildID?: string

`Optional`channelID?: string

`Optional`failIfNotExists?: boolean

`Optional`guildID?: string

Returns Promise<{
allowed_mentions?: any;
attachments?: any[];
components?: any[];
content?: string;
embeds?: any[];
enforce_nonce?: boolean;
files: any[];
flags?: number;
message_reference?: any;
nonce?: string | number;
poll?: any;
sticker_ids?: string[];
tts?: boolean;
}>