Class Message<T>

Represents a guild message.

Type Parameters

T extends AnyTextableChannel

Hierarchy (View Summary)

Base<string>
- Message

Constructors

constructor

new Message<T extends TextChannel>(
    data: {
        channelId: string;
        content?: string;
        createdAt: string;
        createdBy: string;
        createdByWebhookId?: string;
        embeds?: {
            author?: { icon_url?: string; name?: string; url?: string };
            color?: number;
            description?: string;
            fields?: { inline: boolean; name: string; value: string }[];
            footer?: { icon_url?: string; text: string };
            image?: { url?: string };
            thumbnail?: { url?: string };
            timestamp?: string;
            title?: string;
            url?: string;
        }[];
        groupId?: string;
        hiddenLinkPreviewUrls?: string[];
        id: string;
        isPinned: boolean;
        isPrivate?: boolean;
        isSilent: boolean;
        mentions?: {
            channels?: { id: string }[];
            everyone?: boolean;
            here?: boolean;
            roles?: { id: number }[];
            users?: { id: string }[];
        };
        replyMessageIds?: string[];
        serverId?: string;
        type: ChatMessageType;
        updatedAt?: string;
    },
    client: Client,
    params?: MessageConstructorParams,
): Message<T>
Type Parameters
- T extends TextChannel
Parameters
- data: {
      channelId: string;
      content?: string;
      createdAt: string;
      createdBy: string;
      createdByWebhookId?: string;
      embeds?: {
          author?: { icon_url?: string; name?: string; url?: string };
          color?: number;
          description?: string;
          fields?: { inline: boolean; name: string; value: string }[];
          footer?: { icon_url?: string; text: string };
          image?: { url?: string };
          thumbnail?: { url?: string };
          timestamp?: string;
          title?: string;
          url?: string;
      }[];
      groupId?: string;
      hiddenLinkPreviewUrls?: string[];
      id: string;
      isPinned: boolean;
      isPrivate?: boolean;
      isSilent: boolean;
      mentions?: {
          channels?: { id: string }[];
          everyone?: boolean;
          here?: boolean;
          roles?: { id: number }[];
          users?: { id: string }[];
      };
      replyMessageIds?: string[];
      serverId?: string;
      type: ChatMessageType;
      updatedAt?: string;
  }
  - channelId: string
    Channel ID Format: uuid
    
    Description
    The ID of the channel
  - Optionalcontent?: string
    Content Format: chat markdown
    
    Description
    The content of the message
  - createdAt: string
    Created at Format: date-time
    
    Description
    The ISO 8601 timestamp that the message was created at
  - createdBy: string
    Created by
    
    Description
    The ID of the user who created this message (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
  - OptionalcreatedByWebhookId?: string
    Created by Webhook ID
    
    Description
    The ID of the webhook who created this message, if it was created by a webhook
  - Optionalembeds?: {
        author?: { icon_url?: string; name?: string; url?: string };
        color?: number;
        description?: string;
        fields?: { inline: boolean; name: string; value: string }[];
        footer?: { icon_url?: string; text: string };
        image?: { url?: string };
        thumbnail?: { url?: string };
        timestamp?: string;
        title?: string;
        url?: string;
    }[]
  - OptionalgroupId?: string
    Group ID
    
    Description
    The ID of the group
  - OptionalhiddenLinkPreviewUrls?: string[]
    Hidden content link preview URLs
    
    Description
    Links in content to prevent unfurling as a link preview when displaying in Guilded
  - id: string
    Message ID Format: uuid
    
    Description
    The ID of the message
  - isPinned: boolean
    Is pinned
    
    Default
    false
  - OptionalisPrivate?: boolean
    Is private
    
    Description
    If set, this message will only be seen by those mentioned or replied to
  - isSilent: boolean
    Is silent
    
    Description
    If set, this message did not notify mention or reply recipients
    
    Default
    false
  - Optionalmentions?: {
        channels?: { id: string }[];
        everyone?: boolean;
        here?: boolean;
        roles?: { id: number }[];
        users?: { id: string }[];
    }
    Optionalchannels?: { id: string }[]
    Channels
    
    Description
    Info on mentioned channels
    
    Optionaleveryone?: boolean
    Everyone
    
    Description
    If
    
    Everyone
    was mentioned
    
    Optionalhere?: boolean
    Here
    
    Description
    If
    
    Here
    was mentioned
    
    Optionalroles?: { id: number }[]
    Roles
    
    Description
    Info on mentioned roles
    
    Optionalusers?: { id: string }[]
    Users
    
    Description
    Info on mentioned users
  - OptionalreplyMessageIds?: string[]
    Description
    Message IDs that were replied to
  - OptionalserverId?: string
    Server ID
    
    Description
    The ID of the server
  - type: ChatMessageType
    Type
    
    Description
    The type of chat message. "system" messages are generated by Guilded, while "default" messages are user or bot-generated.
  - OptionalupdatedAt?: string
    Updated at Format: date-time
    
    Description
    The ISO 8601 timestamp that the message was updated at, if relevant
- client: Client
- Optionalparams: MessageConstructorParams
Returns Message<T>
Overrides Base.constructor
- Defined in lib/structures/Message.ts:79

Properties

_lastMessageID

_lastMessageID: null | string

ID of the last message created with the message itself.

acknowledged

acknowledged: boolean

Message acknowledgement.

channelID

channelID: string

ID of the channel on which the message was sent.

client

client: Client

App's client.

components

components: InteractionButtonComponent[]

Message components

content

content: null | string

Content of the message.

createdAt

createdAt: Date

When the message was created.

deletedAt

deletedAt: null | Date

When the message was deleted.

editedTimestamp

editedTimestamp: null | Date

Timestamp at which this message was last edited.

`Optional`embeds

embeds?:
    | []
    | {
        author?: { icon_url?: string; name?: string; url?: string };
        color?: number;
        description?: string;
        fields?: { inline: boolean; name: string; value: string }[];
        footer?: { icon_url?: string; text: string };
        image?: { url?: string };
        thumbnail?: { url?: string };
        timestamp?: string;
        title?: string;
        url?: string;
    }[]

Array of message embed.

Type declaration

[]
{
    author?: { icon_url?: string; name?: string; url?: string };
    color?: number;
    description?: string;
    fields?: { inline: boolean; name: string; value: string }[];
    footer?: { icon_url?: string; text: string };
    image?: { url?: string };
    thumbnail?: { url?: string };
    timestamp?: string;
    title?: string;
    url?: string;
}[]
- Optionalauthor?: { icon_url?: string; name?: string; url?: string }
  Description
  A small section above the title of the embed
  - Optionalicon_url?: string
    Format: media-uri
    
    Description
    URL of a small image to display to the left of the author's name
  - Optionalname?: string
    Description
    Name of the author
  - Optionalurl?: string
    Format: uri
    
    Description
    URL to linkify the author's name field
- Optionalcolor?: number
  Description
  The integer value corresponds to the decimal RGB representation for the color. The color that the left border should be
- Optionaldescription?: string
  Format: webhook-markdown
  
  Description
  Subtext of the embed
- Optionalfields?: { inline: boolean; name: string; value: string }[]
  Description
  Table-like cells to add to the embed
- Optionalfooter?: { icon_url?: string; text: string }
  Description
  A small section at the bottom of the embed
  - Optionalicon_url?: string
    Format: media-uri
    
    Description
    URL of a small image to put in the footer
  - text: string
    Description
    Text of the footer
- Optionalimage?: { url?: string }
  Description
  The main picture to associate with the embed
  - Optionalurl?: string
    Format: media-uri
    
    Description
    URL of the image
- Optionalthumbnail?: { url?: string }
  Description
  An image to the right of the embed's content
  - Optionalurl?: string
    Format: media-uri
    
    Description
    URL of the image
- Optionaltimestamp?: string
  Format: date-time
  
  Description
  A timestamp to put in the footer
- Optionaltitle?: string
  Format: webhook-markdown
  
  Description
  Main header of the embed
- Optionalurl?: string
  Format: uri
  
  Description
  URL to linkify the title field with

guildID

guildID: null | string

ID of the server on which the message was sent.

`Optional`hiddenLinkPreviewURLs

hiddenLinkPreviewURLs?: string[]

Links in content to prevent unfurling as a link preview when displaying in Guilded (min items 1; must have unique items true)

id

id: string

Item ID

isPrivate

isPrivate: boolean

If true, the message appears as private.

isSilent

isSilent: boolean

If true, the message didn't mention anyone.

memberID

memberID: string

ID of the message author.

mentions

mentions: {
    channels?: { id: string }[];
    everyone?: boolean;
    here?: boolean;
    roles?: { id: number }[];
    users?: { id: string }[];
}

object containing all mentioned users.

Type declaration

Optionalchannels?: { id: string }[]
Channels

Description
Info on mentioned channels
Optionaleveryone?: boolean
Everyone

Description
If

Everyone
was mentioned
Optionalhere?: boolean
Here

Description
If

Here
was mentioned
Optionalroles?: { id: number }[]
Roles

Description
Info on mentioned roles
Optionalusers?: { id: string }[]
Users

Description
Info on mentioned users

originals

originals: { responseID: null | string; triggerID: null | string }

Message Originals

Type declaration

responseID: null | string
ID of the message's original message.
triggerID: null | string
ID of the message sent by a user, triggering the original response.

replyMessageIDs

replyMessageIDs: string[]

The IDs of the message replied by the message.

type

type: string

Message type.

`Optional`webhookID

webhookID?: null | string

ID of the webhook used to send this message. (if sent by a webhook)

Accessors

attachmentURLs

get attachmentURLs(): string[]
Get attachment URLs from this Message (works for embedded content such as images).

Returns string[]
- Defined in lib/structures/Message.ts:174

channel

get channel(): T extends TextChannel ? T<T> : undefined
The channel this message was created in.

Returns T extends TextChannel ? T<T> : undefined
- Defined in lib/structures/Message.ts:185

guild

get guild(): T extends Guild ? Guild : null | Guild
The guild the message is in. This will throw an error if the guild isn't cached.

Returns T extends Guild ? Guild : null | Guild
- Defined in lib/structures/Message.ts:198

isOriginal

get isOriginal(): false | "trigger" | "response"
Get to know if this Message is original.

It is Original when:
- it is a user message that is the original trigger of a response (returns: "trigger")
- it is a response to a trigger message (returns: "response")
If not, this getter returns the boolean state: false.
Returns false | "trigger" | "response"
- Defined in lib/structures/Message.ts:218

member

get member(): T extends Guild ? Member : undefined | Member | Promise<Member>
Retrieve message's member.

Make sure to await this property (getter) to still get results even if the member is not cached.

Returns T extends Guild ? Member : undefined | Member | Promise<Member>
Note
The API does not provide member information, that's why you might need to await this property.
- Defined in lib/structures/Message.ts:233

Methods

createFollowup

createFollowup(options: CreateMessageOptions): Promise<Message<T>>
Create a follow-up message that replies to the trigger message and original response. (use Message#createMessage if the message has not been acknowledged).

Note: The trigger message and original response are automatically replied, use Client.rest.channels#createMessage to create an independent message.
Parameters
- options: CreateMessageOptions
  Message options.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:265

createMessage

createMessage(options: CreateMessageOptions): Promise<Message<T>>
This method is used to create a message following this message (use Message#createFollowup on already acknowledged messages).

Note: The trigger message is automatically replied and acknowledged, use Client.rest.channels#createMessage to create an independent message.
Parameters
- options: CreateMessageOptions
  Message options.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:309

createReaction

createReaction(reaction: number): Promise<void>
Add a reaction to this message.
Parameters
- reaction: number
  ID of a reaction/emote.
Returns Promise<void>
- Defined in lib/structures/Message.ts:347

delete

delete(): Promise<void>
This method is used to delete the current message.

Returns Promise<void>
- Defined in lib/structures/Message.ts:357

deleteFollowup

deleteFollowup(): Promise<void>
Delete followup message.

Returns Promise<void>
- Defined in lib/structures/Message.ts:364

deleteLast

deleteLast(): Promise<void>
Delete the last message sent with the message itself.

Returns Promise<void>
- Defined in lib/structures/Message.ts:374

deleteOriginal

deleteOriginal(target?: "trigger" | "response"): Promise<void>
Delete the message's original response message (prioritizes parent).
Parameters
- Optionaltarget: "trigger" | "response"
  (optional) Delete specifically the trigger or the response.
Returns Promise<void>
- Defined in lib/structures/Message.ts:382

deleteReaction

deleteReaction(reaction: number, targetUserID?: string): Promise<void>
Remove a reaction from this message.
Parameters
- reaction: number
  ID of a reaction/emote.
- OptionaltargetUserID: string
  ID of the user to remove reaction from. (works only on Channel Messages | default: @me)
Returns Promise<void>
- Defined in lib/structures/Message.ts:409

edit

edit(newMessage: EditMessageOptions): Promise<Message<T>>
This method is used to edit the current message.
Parameters
- newMessage: EditMessageOptions
  New message's options
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:422

editFollowup

editFollowup(newMessage: EditMessageOptions): Promise<Message<T>>
Edit followup message.
Parameters
- newMessage: EditMessageOptions
  Edit options.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:440

editLast

editLast(newMessage: EditMessageOptions): Promise<Message<T>>
Edit the last message sent with the message itself.
Parameters
- newMessage: EditMessageOptions
  New message's options.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:459

editOriginal

editOriginal(
newMessage: { content?: string; embeds?: Embed[] },
): Promise<Message<T>>
Edit the message's original response message.
Parameters
- newMessage: { content?: string; embeds?: Embed[] }
  New message's options.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:471

getAttachments

getAttachments(): Promise<MessageAttachment[]>
Get attachments from this Message (using REST) (works for embedded content such as images).

Returns Promise<MessageAttachment[]>
- Defined in lib/structures/Message.ts:500

getFollowup

getFollowup(): Promise<Message<T>>
Get followup message.

Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:507

getLast

getLast(): Promise<Message<T>>
Get the latest message sent with this Message.

Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:519

getOriginal

getOriginal(target?: "trigger" | "response"): Promise<Message<T>>
Get original message response or trigger (prioritizes parent, the original response).
Parameters
- Optionaltarget: "trigger" | "response"
  (optional) Get either the trigger or the response.
Returns Promise<Message<T>>
- Defined in lib/structures/Message.ts:533

getOriginals

getOriginals(): Promise<MessageOriginals>
Get original messages (the one triggering the response, and the original response message)

Returns Promise<MessageOriginals>
- Defined in lib/structures/Message.ts:564

pin(): Promise<void>
Pin this message

Returns Promise<void>
- Defined in lib/structures/Message.ts:598

toJSON

toJSON(): JSONMessage
Returns JSONMessage
Overrides Base.toJSON
- Defined in lib/structures/Message.ts:602

unpin

unpin(): Promise<void>
Unpin this message

Returns Promise<void>
- Defined in lib/structures/Message.ts:624

Class Message<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

channelId: string

Description

Optionalcontent?: string

Description

createdAt: string

Description

createdBy: string

Description

OptionalcreatedByWebhookId?: string

Description

OptionalgroupId?: string

Description

OptionalhiddenLinkPreviewUrls?: string[]

Description

id: string

Description

isPinned: boolean

Default

OptionalisPrivate?: boolean

Description

isSilent: boolean

Description

Default

Optionalmentions?: { channels?: { id: string }[]; everyone?: boolean; here?: boolean; roles?: { id: number }[]; users?: { id: string }[];}

Optionalchannels?: { id: string }[]

Description

Optionaleveryone?: boolean

Description

Everyone

Optionalhere?: boolean

Description

Here

Optionalroles?: { id: number }[]

Description

Optionalusers?: { id: string }[]

Description

OptionalreplyMessageIds?: string[]

Description

OptionalserverId?: string

Description

type: ChatMessageType

Description

OptionalupdatedAt?: string

Description

Returns Message<T>

Properties

_lastMessageID

acknowledged

channelID

client

components

content

createdAt

deletedAt

editedTimestamp

Optionalembeds

Type declaration

Optionalauthor?: { icon_url?: string; name?: string; url?: string }

Description

Optionalicon_url?: string

Description

Optionalname?: string

Description

Optionalurl?: string

Description

Optionalcolor?: number

Description

Optionaldescription?: string

`Optional`content?: string

`Optional`createdByWebhookId?: string

`Optional`groupId?: string

`Optional`hiddenLinkPreviewUrls?: string[]

`Optional`isPrivate?: boolean

`Optional`mentions?: {
channels?: { id: string }[];
everyone?: boolean;
here?: boolean;
roles?: { id: number }[];
users?: { id: string }[];
}

`Optional`channels?: { id: string }[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: { id: number }[]

`Optional`users?: { id: string }[]

`Optional`replyMessageIds?: string[]

`Optional`serverId?: string

`Optional`updatedAt?: string

`Optional`embeds

`Optional`author?: { icon_url?: string; name?: string; url?: string }

`Optional`icon_url?: string

`Optional`name?: string

`Optional`url?: string

`Optional`color?: number

`Optional`description?: string

`Optional`fields?: { inline: boolean; name: string; value: string }[]

`Optional`footer?: { icon_url?: string; text: string }

`Optional`icon_url?: string

`Optional`image?: { url?: string }

`Optional`url?: string

`Optional`thumbnail?: { url?: string }

`Optional`url?: string

`Optional`timestamp?: string

`Optional`title?: string

`Optional`url?: string

`Optional`hiddenLinkPreviewURLs

`Optional`channels?: { id: string }[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: { id: number }[]

`Optional`users?: { id: string }[]

`Optional`webhookID