Class MessageStruct

Represents a message in a channel.

Hierarchy (View Summary)

Base
- MessageStruct

Index

Constructors

constructor

new MessageStruct(
    client: client,
    data: {
        _id: string;
        attachments?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            }[];
        author: string;
        channel: string;
        content?: null
        | string;
        edited?: null | string;
        embeds?:
            | null
            | (
                | {
                    colour?: null
                    | string;
                    description?: null | string;
                    icon_url?: null | string;
                    image?:
                        | null
                        | {
                            height: number;
                            size: "Large"
                            | "Preview";
                            url: string;
                            width: number;
                        };
                    original_url?: null
                    | string;
                    site_name?: null | string;
                    special?:
                        | null
                        | { type: "None" }
                        | { type: "GIF" }
                        | { id: string; timestamp?: null | string; type: "YouTube" }
                        | { content_type: "Channel"; id: string; type: "Lightspeed" }
                        | {
                            content_type: "Video" | "Channel" | "Clip";
                            id: string;
                            type: "Twitch";
                        }
                        | { content_type: string; id: string; type: "Spotify" }
                        | { type: "Soundcloud" }
                        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                        | { id: string; type: "Streamable" };
                    title?: null | string;
                    type: "Website";
                    url?: null | string;
                    video?: null | { height: number; url: string; width: number };
                }
                | {
                    height: number;
                    size: "Large"
                    | "Preview";
                    type: "Image";
                    url: string;
                    width: number;
                }
                | { height: number; type: "Video"; url: string; width: number }
                | {
                    colour?: null | string;
                    description?: null | string;
                    icon_url?: null | string;
                    media?:
                        | null
                        | {
                            _id: string;
                            content_type: string;
                            deleted?: null
                            | boolean;
                            filename: string;
                            message_id?: null | string;
                            metadata:
                                | { type: "File" }
                                | { type: "Text" }
                                | { height: number; type: "Image"; width: number }
                                | { height: number; type: "Video"; width: number }
                                | { type: "Audio" };
                            object_id?: null | string;
                            reported?: null | boolean;
                            server_id?: null | string;
                            size: number;
                            tag: string;
                            user_id?: null | string;
                        };
                    title?: null
                    | string;
                    type: "Text";
                    url?: null | string;
                }
                | { type: "None" }
            )[];
        flags?: number;
        interactions?: {
            reactions?: null | string[];
            restrict_reactions?: boolean;
        };
        masquerade?: | null
        | { avatar?: null
        | string; colour?: null | string; name?: null | string };
        member?:
            | null
            | {
                _id: { server: string; user: string };
                avatar?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                joined_at: string;
                nickname?: null
                | string;
                roles?: string[];
                timeout?: null | string;
            };
        mentions?: null
        | string[];
        nonce?: null | string;
        pinned?: null | boolean;
        reactions?: { [key: string]: string[] };
        replies?: null | string[];
        role_mentions?: null | string[];
        system?:
            | null
            | { content: string; type: "text" }
            | { by: string; id: string; type: "user_added" }
            | { by: string; id: string; type: "user_remove" }
            | { id: string; type: "user_joined" }
            | { id: string; type: "user_left" }
            | { id: string; type: "user_kicked" }
            | { id: string; type: "user_banned" }
            | { by: string; name: string; type: "channel_renamed" }
            | { by: string; type: "channel_description_changed" }
            | { by: string; type: "channel_icon_changed" }
            | { from: string; to: string; type: "channel_ownership_changed" }
            | { by: string; id: string; type: "message_pinned" }
            | { by: string; id: string; type: "message_unpinned" };
        user?:
            | null
            | {
                _id: string;
                avatar?: | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
                badges?: number;
                bot?: null
                | { owner: string };
                discriminator: string;
                display_name?: null | string;
                flags?: number;
                online: boolean;
                privileged?: boolean;
                relations?: {
                    _id: string;
                    status:
                        | "User"
                        | "None"
                        | "Friend"
                        | "Outgoing"
                        | "Incoming"
                        | "Blocked"
                        | "BlockedOther";
                }[];
                relationship: | "User"
                | "None"
                | "Friend"
                | "Outgoing"
                | "Incoming"
                | "Blocked"
                | "BlockedOther";
                status?: | null
                | {
                    presence?: null
                    | "Online"
                    | "Idle"
                    | "Focus"
                    | "Busy"
                    | "Invisible";
                    text?: null | string;
                };
                username: string;
            };
        webhook?: null
        | { avatar?: null | string; name: string };
    },
): MessageStruct
Creates a new Message instance.
Parameters
- client: client
  The client instance.
- data: {
      _id: string;
      attachments?:
          | null
          | {
              _id: string;
              content_type: string;
              deleted?: null
              | boolean;
              filename: string;
              message_id?: null | string;
              metadata:
                  | { type: "File" }
                  | { type: "Text" }
                  | { height: number; type: "Image"; width: number }
                  | { height: number; type: "Video"; width: number }
                  | { type: "Audio" };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          }[];
      author: string;
      channel: string;
      content?: null
      | string;
      edited?: null | string;
      embeds?:
          | null
          | (
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  image?:
                      | null
                      | {
                          height: number;
                          size: "Large"
                          | "Preview";
                          url: string;
                          width: number;
                      };
                  original_url?: null
                  | string;
                  site_name?: null | string;
                  special?:
                      | null
                      | { type: "None" }
                      | { type: "GIF" }
                      | { id: string; timestamp?: null | string; type: "YouTube" }
                      | { content_type: "Channel"; id: string; type: "Lightspeed" }
                      | {
                          content_type: "Video" | "Channel" | "Clip";
                          id: string;
                          type: "Twitch";
                      }
                      | { content_type: string; id: string; type: "Spotify" }
                      | { type: "Soundcloud" }
                      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                      | { id: string; type: "Streamable" };
                  title?: null | string;
                  type: "Website";
                  url?: null | string;
                  video?: null | { height: number; url: string; width: number };
              }
              | {
                  height: number;
                  size: "Large"
                  | "Preview";
                  type: "Image";
                  url: string;
                  width: number;
              }
              | { height: number; type: "Video"; url: string; width: number }
              | {
                  colour?: null | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?:
                      | null
                      | {
                          _id: string;
                          content_type: string;
                          deleted?: null
                          | boolean;
                          filename: string;
                          message_id?: null | string;
                          metadata:
                              | { type: "File" }
                              | { type: "Text" }
                              | { height: number; type: "Image"; width: number }
                              | { height: number; type: "Video"; width: number }
                              | { type: "Audio" };
                          object_id?: null | string;
                          reported?: null | boolean;
                          server_id?: null | string;
                          size: number;
                          tag: string;
                          user_id?: null | string;
                      };
                  title?: null
                  | string;
                  type: "Text";
                  url?: null | string;
              }
              | { type: "None" }
          )[];
      flags?: number;
      interactions?: {
          reactions?: null | string[];
          restrict_reactions?: boolean;
      };
      masquerade?: | null
      | { avatar?: null
      | string; colour?: null | string; name?: null | string };
      member?:
          | null
          | {
              _id: { server: string; user: string };
              avatar?:
                  | null
                  | {
                      _id: string;
                      content_type: string;
                      deleted?: null
                      | boolean;
                      filename: string;
                      message_id?: null | string;
                      metadata:
                          | { type: "File" }
                          | { type: "Text" }
                          | { height: number; type: "Image"; width: number }
                          | { height: number; type: "Video"; width: number }
                          | { type: "Audio" };
                      object_id?: null | string;
                      reported?: null | boolean;
                      server_id?: null | string;
                      size: number;
                      tag: string;
                      user_id?: null | string;
                  };
              joined_at: string;
              nickname?: null
              | string;
              roles?: string[];
              timeout?: null | string;
          };
      mentions?: null
      | string[];
      nonce?: null | string;
      pinned?: null | boolean;
      reactions?: { [key: string]: string[] };
      replies?: null | string[];
      role_mentions?: null | string[];
      system?:
          | null
          | { content: string; type: "text" }
          | { by: string; id: string; type: "user_added" }
          | { by: string; id: string; type: "user_remove" }
          | { id: string; type: "user_joined" }
          | { id: string; type: "user_left" }
          | { id: string; type: "user_kicked" }
          | { id: string; type: "user_banned" }
          | { by: string; name: string; type: "channel_renamed" }
          | { by: string; type: "channel_description_changed" }
          | { by: string; type: "channel_icon_changed" }
          | { from: string; to: string; type: "channel_ownership_changed" }
          | { by: string; id: string; type: "message_pinned" }
          | { by: string; id: string; type: "message_unpinned" };
      user?:
          | null
          | {
              _id: string;
              avatar?: | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | { height: number; type: "Image"; width: number }
                      | { height: number; type: "Video"; width: number }
                      | { type: "Audio" };
                  object_id?: null | string;
                  reported?: null | boolean;
                  server_id?: null | string;
                  size: number;
                  tag: string;
                  user_id?: null | string;
              };
              badges?: number;
              bot?: null
              | { owner: string };
              discriminator: string;
              display_name?: null | string;
              flags?: number;
              online: boolean;
              privileged?: boolean;
              relations?: {
                  _id: string;
                  status:
                      | "User"
                      | "None"
                      | "Friend"
                      | "Outgoing"
                      | "Incoming"
                      | "Blocked"
                      | "BlockedOther";
              }[];
              relationship: | "User"
              | "None"
              | "Friend"
              | "Outgoing"
              | "Incoming"
              | "Blocked"
              | "BlockedOther";
              status?: | null
              | {
                  presence?: null
                  | "Online"
                  | "Idle"
                  | "Focus"
                  | "Busy"
                  | "Invisible";
                  text?: null | string;
              };
              username: string;
          };
      webhook?: null
      | { avatar?: null | string; name: string };
  }
  The raw data for the message from the API.
  - _id: string
    Description
    Unique Id
  - Optionalattachments?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        }[]
    Description
    Array of attachments
  - author: string
    Description
    Id of the user or webhook that sent this message
  - channel: string
    Description
    Id of the channel this message was sent in
  - Optionalcontent?: null | string
    Description
    Message content
  - Optionaledited?: null | string
    Description
    Time at which this message was last edited
  - Optionalembeds?:
        | null
        | (
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                image?:
                    | null
                    | {
                        height: number;
                        size: "Large"
                        | "Preview";
                        url: string;
                        width: number;
                    };
                original_url?: null
                | string;
                site_name?: null | string;
                special?:
                    | null
                    | { type: "None" }
                    | { type: "GIF" }
                    | { id: string; timestamp?: null | string; type: "YouTube" }
                    | { content_type: "Channel"; id: string; type: "Lightspeed" }
                    | {
                        content_type: "Video" | "Channel" | "Clip";
                        id: string;
                        type: "Twitch";
                    }
                    | { content_type: string; id: string; type: "Spotify" }
                    | { type: "Soundcloud" }
                    | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
                    | { album_id: string; track_id?: null | string; type: "AppleMusic" }
                    | { id: string; type: "Streamable" };
                title?: null | string;
                type: "Website";
                url?: null | string;
                video?: null | { height: number; url: string; width: number };
            }
            | {
                height: number;
                size: "Large"
                | "Preview";
                type: "Image";
                url: string;
                width: number;
            }
            | { height: number; type: "Video"; url: string; width: number }
            | {
                colour?: null | string;
                description?: null | string;
                icon_url?: null | string;
                media?:
                    | null
                    | {
                        _id: string;
                        content_type: string;
                        deleted?: null
                        | boolean;
                        filename: string;
                        message_id?: null | string;
                        metadata:
                            | { type: "File" }
                            | { type: "Text" }
                            | { height: number; type: "Image"; width: number }
                            | { height: number; type: "Video"; width: number }
                            | { type: "Audio" };
                        object_id?: null | string;
                        reported?: null | boolean;
                        server_id?: null | string;
                        size: number;
                        tag: string;
                        user_id?: null | string;
                    };
                title?: null
                | string;
                type: "Text";
                url?: null | string;
            }
            | { type: "None" }
        )[]
    Description
    Attached embeds to this message
  - Optionalflags?: number
    Format: uint32
    
    Description
    Bitfield of message flags
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.MessageFlags.html
  - Optionalinteractions?: { reactions?: null | string[]; restrict_reactions?: boolean }
    Description
    Information about how this message should be interacted with
    
    Optionalreactions?: null | string[]
    Description
    Reactions which should always appear and be distinct
    
    Optionalrestrict_reactions?: boolean
    Description
    Whether reactions should be restricted to the given list
    
    Can only be set to true if reactions list is of at least length 1
  - Optionalmasquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }
    Description
    Name and / or avatar overrides for this message
  - Optionalmember?:
        | null
        | {
            _id: { server: string; user: string };
            avatar?:
                | null
                | {
                    _id: string;
                    content_type: string;
                    deleted?: null
                    | boolean;
                    filename: string;
                    message_id?: null | string;
                    metadata:
                        | { type: "File" }
                        | { type: "Text" }
                        | { height: number; type: "Image"; width: number }
                        | { height: number; type: "Video"; width: number }
                        | { type: "Audio" };
                    object_id?: null | string;
                    reported?: null | boolean;
                    server_id?: null | string;
                    size: number;
                    tag: string;
                    user_id?: null | string;
                };
            joined_at: string;
            nickname?: null
            | string;
            roles?: string[];
            timeout?: null | string;
        }
    Description
    The member that sent this message
  - Optionalmentions?: null | string[]
    Description
    Array of user ids mentioned in this message
  - Optionalnonce?: null | string
    Description
    Unique value generated by client sending this message
  - Optionalpinned?: null | boolean
    Description
    Whether or not the message in pinned
  - Optionalreactions?: { [key: string]: string[] }
    Description
    Hashmap of emoji IDs to array of user IDs
  - Optionalreplies?: null | string[]
    Description
    Array of message ids this message is replying to
  - Optionalrole_mentions?: null | string[]
    Description
    Array of role ids mentioned in this message
  - Optionalsystem?:
        | null
        | { content: string; type: "text" }
        | { by: string; id: string; type: "user_added" }
        | { by: string; id: string; type: "user_remove" }
        | { id: string; type: "user_joined" }
        | { id: string; type: "user_left" }
        | { id: string; type: "user_kicked" }
        | { id: string; type: "user_banned" }
        | { by: string; name: string; type: "channel_renamed" }
        | { by: string; type: "channel_description_changed" }
        | { by: string; type: "channel_icon_changed" }
        | { from: string; to: string; type: "channel_ownership_changed" }
        | { by: string; id: string; type: "message_pinned" }
        | { by: string; id: string; type: "message_unpinned" }
    Description
    System message
  - Optionaluser?:
        | null
        | {
            _id: string;
            avatar?: | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
            badges?: number;
            bot?: null
            | { owner: string };
            discriminator: string;
            display_name?: null | string;
            flags?: number;
            online: boolean;
            privileged?: boolean;
            relations?: {
                _id: string;
                status:
                    | "User"
                    | "None"
                    | "Friend"
                    | "Outgoing"
                    | "Incoming"
                    | "Blocked"
                    | "BlockedOther";
            }[];
            relationship: | "User"
            | "None"
            | "Friend"
            | "Outgoing"
            | "Incoming"
            | "Blocked"
            | "BlockedOther";
            status?: | null
            | {
                presence?: null
                | "Online"
                | "Idle"
                | "Focus"
                | "Busy"
                | "Invisible";
                text?: null | string;
            };
            username: string;
        }
    Description
    The user that sent this message
  - Optionalwebhook?: null | { avatar?: null | string; name: string }
    Description
    The webhook that sent this message
Returns MessageStruct
Overrides Base.constructor
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:64

Properties

attachments

attachments: {
    _id: string;
    content_type: string;
    deleted?: null | boolean;
    filename: string;
    message_id?: null | string;
    metadata:
        | { type: "File" }
        | { type: "Text" }
        | { height: number; type: "Image"; width: number }
        | { height: number; type: "Video"; width: number }
        | { type: "Audio" };
    object_id?: null | string;
    reported?: null | boolean;
    server_id?: null | string;
    size: number;
    tag: string;
    user_id?: null | string;
}[] = []

An array of file attachments included in the message.

Type declaration

_id: string
Description
Unique Id
content_type: string
Description
Raw content type of this file
Optionaldeleted?: null | boolean
Description
Whether this file was deleted
filename: string
Description
Original filename
Optionalmessage_id?: null | string
metadata:
    | { type: "File" }
    | { type: "Text" }
    | { height: number; type: "Image"; width: number }
    | { height: number; type: "Video"; width: number }
    | { type: "Audio" }
Description
Parsed metadata of this file
Optionalobject_id?: null | string
Description
Id of the object this file is associated with
Optionalreported?: null | boolean
Description
Whether this file was reported
Optionalserver_id?: null | string
size: number
Format: int

Description
Size of this file (in bytes)
tag: string
Description
Tag / bucket this file was uploaded to
Optionaluser_id?: null | string

authorId

authorId: string = ""

The ID of the user who authored the message.

channelId

channelId: string = ""

The ID of the channel where the message was sent.

`Readonly`client

client: client

The client instance.

content

content: string = ""

The content of the message.

editedTimestamp

editedTimestamp: null | number = null

The timestamp of when the message was last edited, or null if not edited.

embeds

embeds: (
    | {
        colour?: null
        | string;
        description?: null | string;
        icon_url?: null | string;
        image?:
            | null
            | {
                height: number;
                size: "Large"
                | "Preview";
                url: string;
                width: number;
            };
        original_url?: null
        | string;
        site_name?: null | string;
        special?:
            | null
            | { type: "None" }
            | { type: "GIF" }
            | { id: string; timestamp?: null | string; type: "YouTube" }
            | { content_type: "Channel"; id: string; type: "Lightspeed" }
            | {
                content_type: "Video" | "Channel" | "Clip";
                id: string;
                type: "Twitch";
            }
            | { content_type: string; id: string; type: "Spotify" }
            | { type: "Soundcloud" }
            | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
            | { album_id: string; track_id?: null | string; type: "AppleMusic" }
            | { id: string; type: "Streamable" };
        title?: null | string;
        type: "Website";
        url?: null | string;
        video?: null | { height: number; url: string; width: number };
    }
    | {
        height: number;
        size: "Large"
        | "Preview";
        type: "Image";
        url: string;
        width: number;
    }
    | { height: number; type: "Video"; url: string; width: number }
    | {
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        media?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        title?: null
        | string;
        type: "Text";
        url?: null | string;
    }
    | { type: "None" }
)[] = []

An array of embeds included in the message.

Type declaration

{
    colour?: null | string;
    description?: null | string;
    icon_url?: null | string;
    image?:
        | null
        | {
            height: number;
            size: "Large"
            | "Preview";
            url: string;
            width: number;
        };
    original_url?: null
    | string;
    site_name?: null | string;
    special?:
        | null
        | { type: "None" }
        | { type: "GIF" }
        | { id: string; timestamp?: null | string; type: "YouTube" }
        | { content_type: "Channel"; id: string; type: "Lightspeed" }
        | {
            content_type: "Video" | "Channel" | "Clip";
            id: string;
            type: "Twitch";
        }
        | { content_type: string; id: string; type: "Spotify" }
        | { type: "Soundcloud" }
        | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
        | { album_id: string; track_id?: null | string; type: "AppleMusic" }
        | { id: string; type: "Streamable" };
    title?: null | string;
    type: "Website";
    url?: null | string;
    video?: null | { height: number; url: string; width: number };
}
- Optionalcolour?: null | string
  Description
  CSS Colour
- Optionaldescription?: null | string
  Description
  Description of website
- Optionalicon_url?: null | string
  Description
  URL to site icon
- Optionalimage?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }
  Description
  Embedded image
- Optionaloriginal_url?: null | string
  Description
  Original direct URL
- Optionalsite_name?: null | string
  Description
  Site name
- Optionalspecial?:
      | null
      | { type: "None" }
      | { type: "GIF" }
      | { id: string; timestamp?: null | string; type: "YouTube" }
      | { content_type: "Channel"; id: string; type: "Lightspeed" }
      | {
          content_type: "Video" | "Channel" | "Clip";
          id: string;
          type: "Twitch";
      }
      | { content_type: string; id: string; type: "Spotify" }
      | { type: "Soundcloud" }
      | { content_type: "Album" | "Track"; id: string; type: "Bandcamp" }
      | { album_id: string; track_id?: null | string; type: "AppleMusic" }
      | { id: string; type: "Streamable" }
  Description
  Remote content
- Optionaltitle?: null | string
  Description
  Title of website
- type: "Website"
- Optionalurl?: null | string
  Description
  Direct URL to web page
- Optionalvideo?: null | { height: number; url: string; width: number }
  Description
  Embedded video
{
    height: number;
    size: "Large" | "Preview";
    type: "Image";
    url: string;
    width: number;
}
- height: number
  Format: uint
  
  Description
  Height of the image
- size: "Large" | "Preview"
  Description
  Positioning and size
- type: "Image"
- url: string
  Description
  URL to the original image
- width: number
  Format: uint
  
  Description
  Width of the image
{ height: number; type: "Video"; url: string; width: number }
- height: number
  Format: uint
  
  Description
  Height of the video
- type: "Video"
- url: string
  Description
  URL to the original video
- width: number
  Format: uint
  
  Description
  Width of the video
{
    colour?: null | string;
    description?: null | string;
    icon_url?: null | string;
    media?:
        | null
        | {
            _id: string;
            content_type: string;
            deleted?: null
            | boolean;
            filename: string;
            message_id?: null | string;
            metadata:
                | { type: "File" }
                | { type: "Text" }
                | { height: number; type: "Image"; width: number }
                | { height: number; type: "Video"; width: number }
                | { type: "Audio" };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        };
    title?: null
    | string;
    type: "Text";
    url?: null | string;
}
- Optionalcolour?: null | string
  Description
  CSS Colour
- Optionaldescription?: null | string
  Description
  Description of text embed
- Optionalicon_url?: null | string
  Description
  URL to icon
- Optionalmedia?:
      | null
      | {
          _id: string;
          content_type: string;
          deleted?: null
          | boolean;
          filename: string;
          message_id?: null | string;
          metadata:
              | { type: "File" }
              | { type: "Text" }
              | { height: number; type: "Image"; width: number }
              | { height: number; type: "Video"; width: number }
              | { type: "Audio" };
          object_id?: null | string;
          reported?: null | boolean;
          server_id?: null | string;
          size: number;
          tag: string;
          user_id?: null | string;
      }
  Description
  ID of uploaded autumn file
- Optionaltitle?: null | string
  Description
  Title of text embed
- type: "Text"
- Optionalurl?: null | string
  Description
  URL for title
{ type: "None" }

id

id: string

The unique identifier for the object.

`Optional`masquerade

masquerade?: {
    avatar?: null | string;
    colour?: null | string;
    name?: null | string;
}

Masquerade information for the message, Name and / or avatar override information

Type declaration

Optionalavatar?: null | string
Description
Replace the avatar shown on this message (URL to image file)
Optionalcolour?: null | string
Description
Replace the display role colour shown on this message

Must have ManageRole permission to use
Optionalname?: null | string
Description
Replace the display name shown on this message

mentions

mentions: Mentions = ...

Mentions included in the message.

reactions

reactions: Map<string, string[]> = ...

the reactions and count on a message

type

The type of the message (e.g., TEXT, SYSTEM).

Accessors

author

get author(): null | User
Retrieves the author of the message.

Returns null | User
The user who authored the message, or null if not found.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:157

channel

get channel(): DMChannel | TextChannel | GroupChannel
Retrieves the channel where the message was sent.

Returns DMChannel | TextChannel | GroupChannel
The channel instance.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:166

createdAt

get createdAt(): Date
Gets the creation date of the message.

Returns Date
The date when the message was created.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:121

createdTimestamp

get createdTimestamp(): number
Gets the creation timestamp of the message in milliseconds.

Returns number
The timestamp of when the message was created.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:130

editedAt

get editedAt(): null | Date
Gets the date when the message was last edited.

Returns null | Date
The date of the last edit, or null if not edited.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:139

member

get member(): null | ServerMember
Retrieves the server member who authored the message, if any.

Returns null | ServerMember
The server member instance, or null if not found.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:194

server

get server(): null | Server
Retrieves the server associated with the message, if any.

Returns null | Server
The server instance, or null if not found.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:185

serverId

get serverId(): null | string
Retrieves the server ID associated with the message, if any.

Returns null | string
The server ID, or null if the message is not in a server.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:175

system

get system(): boolean
Checks if the message is a system message.

Returns boolean
true if the message is a system message, otherwise false.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:148

url

get url(): string
Gets the URL of the message.

Returns string
The URL of the message.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:203

Methods

_clone

_clone(): this
Creates a deep clone of the object.

Returns this
A clone of the object.
Inherited from Base._clone
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:84

_update

_update(data: PartialObject, clear?: string[]): this
Updates the object with new data and returns a clone of the object.
Parameters
- data: PartialObject
  The data to update the object with.
- Optionalclear: string[]
  Fields to clear in the object.
Returns this
A clone of the updated object.
Inherited from Base._update
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:56

ack

ack(): Promise<void>
Acknowledges the message.

Returns Promise<void>
A promise that resolves when the message is acknowledged.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:214

addReaction

addReaction(emoji: string): Promise<void>
Adds a reaction to the message.
Parameters
- emoji: string
  The emoji to react with.
Returns Promise<void>
A promise that resolves when the reaction is added.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:269

delete

delete(): Promise<void>
Deletes the message.

Returns Promise<void>
A promise that resolves when the message is deleted.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:223

edit

edit(options: string | MessageEditOptions): Promise<void>
Edits the message.
Parameters
- options: string | MessageEditOptions
  The new content or edit options.
Returns Promise<void>
A promise that resolves when the message is edited.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:250

equals

equals(obj?: null | MessageStruct): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: null | MessageStruct
  The object to compare with.
Returns boolean
true if the objects are equal, otherwise false.
Inherited from Base.equals
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:29

fetch

fetch(): Promise<MessageStruct>
Fetches the latest data for the message.

Returns Promise<MessageStruct>
A promise that resolves with the updated message instance.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:259

inServer

inServer(): this is MessageStruct & {
    channel: TextChannel;
    server: Server;
    serverId: string;
}
Checks if the message is in a server.

Returns this is MessageStruct & {
    channel: TextChannel;
    server: Server;
    serverId: string;
}
true if the message is in a server, otherwise false.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:308

removeAllReactions

removeAllReactions(): Promise<void>
Removes all reactions from the message.

Returns Promise<void>
A promise that resolves when all reactions are removed.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:299

removeReaction

removeReaction(
emoji: string,
options?: { remove_all?: boolean; user_id?: string },
): Promise<void>
Removes a reaction from the message.
Parameters
- emoji: string
  The emoji to remove the reaction for.
- Optionaloptions: { remove_all?: boolean; user_id?: string }
  Options for removing the reaction.
  - Optionalremove_all?: boolean
    Whether to remove all of the specified reaction for the message.
  - Optionaluser_id?: string
    The user ID to remove the reaction for. If not provided, removes the reaction for the current user.
Returns Promise<void>
A promise that resolves when the reaction is removed.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:282

reply

reply(
content: string | MessageOptions,
mention?: boolean,
): Promise<MessageStruct>
Replies to the message.
Parameters
- content: string | MessageOptions
  The content of the reply.
- Optionalmention: boolean = true
  Whether to mention the original message author.
Returns Promise<MessageStruct>
A promise that resolves with the sent reply message.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:234

toString

toString(): string
Converts the message to a string representation.

Returns string
The content of the message.
- Defined in work/revbot.js/revbot.js/src/struct/message.ts:321

Class MessageStruct

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: string

Description

Description

author: string

Description

channel: string

Description

Optionalcontent?: null | string

Description

Optionaledited?: null | string

Description

Description

Optionalflags?: number

Description

Optionalinteractions?: { reactions?: null | string[]; restrict_reactions?: boolean }

Description

Optionalreactions?: null | string[]

Description

Optionalrestrict_reactions?: boolean

Description

Optionalmasquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }

Description

Description

Optionalmentions?: null | string[]

Description

Optionalnonce?: null | string

Description

Optionalpinned?: null | boolean

Description

Optionalreactions?: { [key: string]: string[] }

Description

Optionalreplies?: null | string[]

Description

Optionalrole_mentions?: null | string[]

Description

Description

Description

Optionalwebhook?: null | { avatar?: null | string; name: string }

Description

Returns MessageStruct

Properties

attachments

Type declaration

_id: string

Description

content_type: string

Description

Optionaldeleted?: null | boolean

Description

filename: string

Description

Optionalmessage_id?: null | string

metadata: | { type: "File" } | { type: "Text" } | { height: number; type: "Image"; width: number } | { height: number; type: "Video"; width: number } | { type: "Audio" }

Description

Optionalobject_id?: null | string

Description

Optionalreported?: null | boolean

Description

Optionalserver_id?: null | string

size: number

Description

tag: string

Description

Optionaluser_id?: null | string

authorId

channelId

Readonlyclient

content

editedTimestamp

embeds

`Optional`content?: null | string

`Optional`edited?: null | string

`Optional`flags?: number

`Optional`interactions?: { reactions?: null | string[]; restrict_reactions?: boolean }

`Optional`reactions?: null | string[]

`Optional`restrict_reactions?: boolean

`Optional`masquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }

`Optional`mentions?: null | string[]

`Optional`nonce?: null | string

`Optional`pinned?: null | boolean

`Optional`reactions?: { [key: string]: string[] }

`Optional`replies?: null | string[]

`Optional`role_mentions?: null | string[]

`Optional`webhook?: null | { avatar?: null | string; name: string }

`Optional`deleted?: null | boolean

`Optional`message_id?: null | string

metadata:
| { type: "File" }
| { type: "Text" }
| { height: number; type: "Image"; width: number }
| { height: number; type: "Video"; width: number }
| { type: "Audio" }

`Optional`object_id?: null | string

`Optional`reported?: null | boolean

`Optional`server_id?: null | string

`Optional`user_id?: null | string

`Readonly`client

`Optional`colour?: null | string

`Optional`description?: null | string

`Optional`icon_url?: null | string

`Optional`image?: null | { height: number; size: "Large" | "Preview"; url: string; width: number }

`Optional`original_url?: null | string

`Optional`site_name?: null | string

`Optional`title?: null | string

`Optional`url?: null | string

`Optional`video?: null | { height: number; url: string; width: number }

`Optional`colour?: null | string

`Optional`description?: null | string

`Optional`icon_url?: null | string

`Optional`title?: null | string

`Optional`url?: null | string

`Optional`masquerade

`Optional`avatar?: null | string

`Optional`colour?: null | string

`Optional`name?: null | string