Class SystemMessageAbstract

constructor

• new SystemMessage(
      client: Client,
      type:
          | "text"
          | "user_added"
          | "user_remove"
          | "user_joined"
          | "user_left"
          | "user_kicked"
          | "user_banned"
          | "channel_renamed"
          | "channel_description_changed"
          | "channel_icon_changed"
          | "channel_ownership_changed"
          | "message_pinned"
          | "message_unpinned"
          | "call_started",
  ): SystemMessage

  Construct System Message

  Parameters

  • client: Client

    Client
  • type:
        | "text"
        | "user_added"
        | "user_remove"
        | "user_joined"
        | "user_left"
        | "user_kicked"
        | "user_banned"
        | "channel_renamed"
        | "channel_description_changed"
        | "channel_icon_changed"
        | "channel_ownership_changed"
        | "message_pinned"
        | "message_unpinned"
        | "call_started"

    Type

  Returns SystemMessage

Readonlytype

Staticfrom

• from(
      client: Client,
      parent: {
          _id: string;
          attachments?:
              | null
              | {
                  _id: string;
                  content_type: string;
                  deleted?: null
                  | boolean;
                  filename: string;
                  message_id?: null | string;
                  metadata:
                      | { type: "File" }
                      | { type: "Text" }
                      | {
                          animated?: null | boolean;
                          height: number;
                          thumbhash?: null | 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" }
                                  | {
                                      animated?: null | boolean;
                                      height: number;
                                      thumbhash?: null | (...)[];
                                      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" }
                              | {
                                  animated?: null | boolean;
                                  height: number;
                                  thumbhash?: null | 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;
                      };
                  can_publish?: boolean;
                  can_receive?: boolean;
                  joined_at: string;
                  nickname?: null
                  | string;
                  pronouns?: 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" }
              | { by: string; finished_at?: null | string; type: "call_started" };
          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" }
                          | {
                              animated?: null | boolean;
                              height: number;
                              thumbhash?: null | 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;
                  pronouns?: null | string;
                  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 };
      },
      message:
          | { 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" }
          | { by: string; finished_at?: null | string; type: "call_started" },
  ): SystemMessage

  Create an System Message from an API System Message

  Parameters

  • client: Client

    Client
  • parent: {
        _id: string;
        attachments?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | {
                        animated?: null | boolean;
                        height: number;
                        thumbhash?: null | 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" }
                                | {
                                    animated?: null | boolean;
                                    height: number;
                                    thumbhash?: null | (...)[];
                                    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" }
                            | {
                                animated?: null | boolean;
                                height: number;
                                thumbhash?: null | 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;
                    };
                can_publish?: boolean;
                can_receive?: boolean;
                joined_at: string;
                nickname?: null
                | string;
                pronouns?: 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" }
            | { by: string; finished_at?: null | string; type: "call_started" };
        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" }
                        | {
                            animated?: null | boolean;
                            height: number;
                            thumbhash?: null | 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;
                pronouns?: null | string;
                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 };
    }

    • _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" }
                  | {
                      animated?: null | boolean;
                      height: number;
                      thumbhash?: null | 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" }
                              | {
                                  animated?: null | boolean;
                                  height: number;
                                  thumbhash?: null | (...)[];
                                  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" }
                          | {
                              animated?: null | boolean;
                              height: number;
                              thumbhash?: null | 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;
                  };
              can_publish?: boolean;
              can_receive?: boolean;
              joined_at: string;
              nickname?: null
              | string;
              pronouns?: 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" }
          | { by: string; finished_at?: null | string; type: "call_started" }

      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" }
                      | {
                          animated?: null | boolean;
                          height: number;
                          thumbhash?: null | 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;
              pronouns?: null | string;
              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

  • message:
        | { 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" }
        | { by: string; finished_at?: null | string; type: "call_started" }

  Returns SystemMessage

  System Message