gluon
    Preparing search index...

    Class Message

    A message belonging to a channel within a guild.

    Implements

    • Message
    Index

    Constructors

    constructor

    Accessors

    attachments author authorId channel channelId content editedTimestamp embeds flags guild guildId hashName id member mentionEveryone mentionRoles mentions messageSnapshots mirrored pinned poll reactions reference stickerItems timestamp type url webhookId

    Methods

    [custom] delete edit encrypt reply toJSON toString decrypt delete edit getHashName getUrl send sendValidation shouldCache

    Constructors

    • Creates the structure for a message.

      Parameters

      • client: Client

        The client instance.

      • data:
            | MessageStorageJSON
            | MessageCacheJSON
            | MessageDiscordJSON
            | APIMessage
            | APIMessageSnapshotFields & { id: string }

        Message data returned from Discord.

      • options: {
            channelId: string;
            guildId: string;
            ignoreExisting?: boolean;
            nocache?: boolean;
        }

        Additional options for this structure.

        • channelId: string

          The id of the channel that the message belongs to.

        • guildId: string

          The id of the guild that the channel belongs to.

        • OptionalignoreExisting?: boolean

          Whether to ignore existing messages in the cache.

        • Optionalnocache?: boolean

          Whether this message should be cached or not.

      Returns Message

      https://discord.com/developers/docs/resources/channel#message-object

    Accessors

    • get attachments(): Attachment[]

      The message attachments.

      Returns Attachment[]

    • get authorId(): string

      The id of the user who sent the message.

      Returns string

    • get channel(): TextChannel | VoiceChannel | Thread

      The channel that this message belongs to.

      Returns TextChannel | VoiceChannel | Thread

    • get channelId(): string

      The channel that this message belongs to.

      Returns string

    content

    • get content(): null | string

      The message content.

      Returns null | string

    • get editedTimestamp(): null | number

      The timestamp for when this message was last edited.

      Returns null | number

    • get guild(): Guild

      The guild that this message belongs to.

      Returns Guild

    • get guildId(): string

      The guild that this message belongs to.

      Returns string

    • get hashName(): string

      The hash name for the message.

      Returns string

    • get member(): null | Member

      The member who sent the message.

      Returns null | Member

    • get mentionEveryone(): boolean

      Whether this message mentions everyone.

      Returns boolean

    • get mentionRoles(): boolean

      Whether this message includes role mentions.

      Returns boolean

    • get mentions(): boolean

      Whether this message includes user mentions.

      Returns boolean

    • get messageSnapshots(): null | MessageSnapshot[]

      The snapshot data about the message.

      Returns null | MessageSnapshot[]

    • get mirrored(): boolean

      Whether another message has replaced this original message.

      Returns boolean

    • get pinned(): boolean

      Whether this message has been pinned.

      Returns boolean

    • get reactions(): MessageReactionManager

      The message reactions.

      Returns MessageReactionManager

    • get reference(): { messageId: null | string }

      The message that this message references.

      Returns { messageId: null | string }

    • get stickerItems(): Sticker[]

      Stickers sent with this message.

      Returns Sticker[]

    • get timestamp(): number

      The UNIX (seconds) timestamp for when this message was created.

      Returns number

    • get webhookId(): null | string

      The id of the webhook this message is from.

      Returns null | string

    Methods

    • Deletes the message.

      Parameters

      • Optionaloptions: { reason?: string } = {}

        The options for deleting the message.

        • Optionalreason?: string

          The reason for deleting the message

      Returns Promise<void>

    • Edits the message, assuming it is sent by the client user.

      Parameters

      • Optionaloptions: {
            attachments?: Attachment[];
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
        }

        Content, embeds and components to attach to the message.

        • Optionalattachments?: Attachment[]

          Array of attachment objects for files to send with the message.

        • Optionalcomponents?: MessageComponents

          Message components to send with the message.

        • Optionalcontent?: string

          The message content.

        • Optionalembeds?: Embed[]
        • Optionalfiles?: FileUpload[]

          Array of file objects for files to send with the message.

      Returns Promise<Message>

      https://discord.com/developers/docs/resources/channel#edit-message

    • Replies to the message.

      Parameters

      • Optionaloptions: {
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
            suppressMentions?: boolean;
        }

        Embeds, components and files to attach to the message.

        • Optionalcomponents?: MessageComponents

          Message components to send with the message.

        • Optionalcontent?: string

          The message content.

        • Optionalembeds?: Embed[]
        • Optionalfiles?: FileUpload[]

          Array of file objects for files to send with the message.

        • OptionalsuppressMentions?: boolean

      Returns Promise<Message>

      https://discord.com/developers/docs/resources/channel#create-message

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns MessageStorageJSON | MessageCacheJSON | MessageDiscordJSON

    • Decrypts a message.

      Parameters

      • client: Client

        The client instance.

      • data: string

        The encrypted message data.

      • guildId: string

        The id of the guild that the message belongs to.

      • channelId: string

        The id of the channel that the message belongs to.

      • messageId: string

        The id of the message.

      Returns Message

    • Deletes one message.

      Parameters

      • client: Client

        The client instance.

      • guildId: string
      • channelId: string

        The id of the channel that the message belongs to.

      • messageId: string

        The id of the message to delete.

      • Optional__namedParameters: { reason?: string } = {}

      Returns Promise<void>

    • Edits a message.

      Parameters

      • client: Client

        The client instance.

      • channelId: string

        The id of the channel the message belongs to.

      • messageId: string

        The id of the message.

      • guildId: string

        The id of the guild the message belongs to.

      • Optionaloptions: {
            attachments?: Attachment[];
            components?: MessageComponents;
            content?: null | string;
            embeds?: Embed[];
            files?: FileUpload[];
        }

        The message options.

        • Optionalattachments?: Attachment[]

          Array of attachment objects for existing attachments sent with the message.

        • Optionalcomponents?: MessageComponents

          Message components to send with the message.

        • Optionalcontent?: null | string

          The message content.

        • Optionalembeds?: Embed[]

          Array of embeds to send with the message.

        • Optionalfiles?: FileUpload[]

          Array of file objects for files to send with the message.

      Returns Promise<Message>

    • Returns the hash name for the message.

      Parameters

      • guildId: string

        The id of the guild that the message belongs to.

      • channelId: string

        The id of the channel that the message belongs to.

      • messageId: string

        The id of the message.

      Returns string

    • The URL of the message.

      Parameters

      • guildId: string

        The id of the guild that the message belongs to.

      • channelId: string

        The id of the channel that the message belongs to.

      • messageId: string

        The id of the message.

      Returns string

    • Posts a message to the specified channel.

      Parameters

      • client: Client

        The client instance.

      • channelId: string

        The id of the channel to send the message to.

      • guildId: string

        The id of the guild which the channel belongs to.

      • Optionaloptions: {
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
            reference?: { channel_id: string; guild_id: string; message_id: string };
            suppressMentions?: boolean;
        }

        Content, embeds, components and files to attach to the message.

        • Optionalcomponents?: MessageComponents

          Message components to send with the message.

        • Optionalcontent?: string

          The message content.

        • Optionalembeds?: Embed[]

          Array of embeds to send with the message.

        • Optionalfiles?: FileUpload[]

          Array of file objects for files to send with the message.

        • Optionalreference?: { channel_id: string; guild_id: string; message_id: string }
        • OptionalsuppressMentions?: boolean

          Whether to suppress mentions in the message.

      Returns Promise<Message>

    • Validates the message content, embeds, components and files.

      Parameters

      • Optionaloptions: {
            attachments?: Attachment[];
            components?: MessageComponents;
            content?: null | string;
            embeds?: Embed[];
            files?: FileUpload[];
            flags?: number;
            reference?: { channel_id: string; guild_id: string; message_id: string };
        } = {}

        The message options.

        • Optionalattachments?: Attachment[]

          Array of attachment objects for existing attachments sent with the message.

        • Optionalcomponents?: MessageComponents

          Message components to send with the message.

        • Optionalcontent?: null | string

          The message content.

        • Optionalembeds?: Embed[]

          Array of embeds to send with the message.

        • Optionalfiles?: FileUpload[]

          Array of file objects for files to send with the message.

        • Optionalflags?: number

          The message flags.

        • Optionalreference?: { channel_id: string; guild_id: string; message_id: string }

          The message reference.

          • channel_id: string

            The id of the channel to reference.

          • guild_id: string

            The id of the guild to reference.

          • message_id: string

            The id of the message to reference.

      Returns void

    • Determines whether the message should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      • guildCacheOptions: GuildCacheOptions

        The cache options for the guild.

      • channelCacheOptions: ChannelCacheOptions

        The cache options for the channel.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods