Class Message<T>

constructor

• new Message<T>(data, client, params?): 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
      Copy

    • 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
      Copy

    • 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>

_lastMessageID

acknowledged

channelID

components

content

createdAt

deletedAt

editedTimestamp

Optionalembeds

guildID

OptionalhiddenLinkPreviewURLs

isPrivate

isSilent

memberID

mentions

originals

replyMessageIDs

type

OptionalwebhookID

attachmentURLs

• get attachmentURLs(): string[]

• Get attachment URLs from this Message (works for embedded content such as images).

  Returns string[]

channel

• get channel(): T extends TextChannel
      ? T<T>
      : undefined

• The channel this message was created in.

  Returns T extends TextChannel
      ? T<T>
      : undefined

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

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"

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.

createFollowup

• createFollowup(options): 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>>

createMessage

• createMessage(options): 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>>

createReaction

• createReaction(reaction): Promise<void>

• Add a reaction to this message.

  Parameters

  • reaction: number

    ID of a reaction/emote.

  Returns Promise<void>

delete

• delete(): Promise<void>

• This method is used to delete the current message.

  Returns Promise<void>

deleteFollowup

• deleteFollowup(): Promise<void>

• Delete followup message.

  Returns Promise<void>

deleteLast

• deleteLast(): Promise<void>

• Delete the last message sent with the message itself.

  Returns Promise<void>

deleteOriginal

• deleteOriginal(target?): 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>

deleteReaction

• deleteReaction(reaction, targetUserID?): 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>

edit

• edit(newMessage): Promise<Message<T>>

• This method is used to edit the current message.

  Parameters

  • newMessage: EditMessageOptions

    New message's options

  Returns Promise<Message<T>>

editFollowup

• editFollowup(newMessage): Promise<Message<T>>

• Edit followup message.

  Parameters

  • newMessage: EditMessageOptions

    Edit options.

  Returns Promise<Message<T>>

editLast

• editLast(newMessage): Promise<Message<T>>

• Edit the last message sent with the message itself.

  Parameters

  • newMessage: EditMessageOptions

    New message's options.

  Returns Promise<Message<T>>

editOriginal

• editOriginal(newMessage): Promise<Message<T>>

• Edit the message's original response message.

  Parameters

  • newMessage: {
        content?: string;
        embeds?: Embed[];
    }

    New message's options.

    • Optionalcontent?: string

    • Optionalembeds?: Embed[]

  Returns Promise<Message<T>>

getAttachments

• getAttachments(): Promise<MessageAttachment[]>

• Get attachments from this Message (using REST) (works for embedded content such as images).

  Returns Promise<MessageAttachment[]>

getFollowup

• getFollowup(): Promise<Message<T>>

• Get followup message.

  Returns Promise<Message<T>>

getLast

• getLast(): Promise<Message<T>>

• Get the latest message sent with this Message.

  Returns Promise<Message<T>>

getOriginal

• getOriginal(target?): 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>>

getOriginals

• getOriginals(): Promise<MessageOriginals>

• Get original messages (the one triggering the response, and the original response message)

  Returns Promise<MessageOriginals>

pin

• pin(): Promise<void>

• Pin this message

  Returns Promise<void>

toJSON

• toJSON(): JSONMessage

• Returns JSONMessage

unpin

• unpin(): Promise<void>

• Unpin this message

  Returns Promise<void>