Class Message

Message Class

Hierarchy

Message

Index

Constructors

constructor

new Message(collection: MessageCollection, id: string): Message
Construct Message
Parameters
- collection: MessageCollection
  
  Collection
- id: string
  
  Message Id
Returns Message
- Defined in src/classes/Message.ts:23

Properties

`Private` `Readonly` #collection

#collection: MessageCollection

`Readonly` id

id: string

Accessors

$exists

get $exists(): boolean
Whether this object exists

Returns boolean
- Defined in src/classes/Message.ts:31

animatedAvatarURL

get animatedAvatarURL(): undefined | string
Get the animated avatar URL for this message

Returns undefined | string
- Defined in src/classes/Message.ts:232

attachments

get attachments(): undefined | File[]
Attachments

Returns undefined | File[]
- Defined in src/classes/Message.ts:136

author

get author(): undefined | User
User this message was sent by

Returns undefined | User
- Defined in src/classes/Message.ts:106

authorId

get authorId(): undefined | string
Id of user or webhook this message was sent by

Returns undefined | string
- Defined in src/classes/Message.ts:99

avatarURL

get avatarURL(): undefined | string
Get the avatar URL for this message

Returns undefined | string
- Defined in src/classes/Message.ts:218

channel

get channel(): undefined | Channel
Channel this message was sent in

Returns undefined | Channel
- Defined in src/classes/Message.ts:73

channelId

get channelId(): string
Id of channel this message was sent in

Returns string
- Defined in src/classes/Message.ts:66

content

get content(): string
Content

Returns string
- Defined in src/classes/Message.ts:122

createdAt

get createdAt(): Date
Time when this message was posted

Returns Date
- Defined in src/classes/Message.ts:38

editedAt

get editedAt(): undefined | Date
Time at which this message was edited

Returns undefined | Date
- Defined in src/classes/Message.ts:143

embeds

get embeds(): undefined | MessageEmbed[]
Embeds

Returns undefined | MessageEmbed[]
- Defined in src/classes/Message.ts:150

interactions

get interactions(): undefined | {
reactions?: null | string[];
restrict_reactions?: boolean;
}
Interactions

Returns undefined | {
reactions?: null | string[];
restrict_reactions?: boolean;
}
- Defined in src/classes/Message.ts:185

masquerade

get masquerade(): undefined | {
    avatar?: null | string;
    colour?: null | string;
    name?: null | string;
}
Masquerade

Returns undefined | {
    avatar?: null | string;
    colour?: null | string;
    name?: null | string;
}
- Defined in src/classes/Message.ts:192

masqueradeAvatarURL

get masqueradeAvatarURL(): undefined | string
Avatar URL from the masquerade

Returns undefined | string
- Defined in src/classes/Message.ts:248

member

get member(): undefined | ServerMember
Member this message was sent by

Returns undefined | ServerMember
- Defined in src/classes/Message.ts:89

mentionIds

get mentionIds(): undefined | string[]
IDs of users this message mentions

Returns undefined | string[]
- Defined in src/classes/Message.ts:157

mentioned

get mentioned(): undefined | boolean
Whether this message mentions us

Returns undefined | boolean
- Defined in src/classes/Message.ts:164

nonce

get nonce(): undefined | string
Nonce value

Returns undefined | string
- Defined in src/classes/Message.ts:59

path

get path(): string
Absolute pathname to this message in the client

Returns string
- Defined in src/classes/Message.ts:45

reactions

get reactions(): ReactiveMap<string, ReactiveSet<string>>
Reactions

Returns ReactiveMap<string, ReactiveSet<string>>
- Defined in src/classes/Message.ts:178

replyIds

get replyIds(): undefined | string[]
IDs of messages this message replies to

Returns undefined | string[]
- Defined in src/classes/Message.ts:171

roleColour

get roleColour(): undefined | null | string
Get the role colour for this message

Returns undefined | null | string
- Defined in src/classes/Message.ts:211

server

get server(): undefined | Server
Server this message was sent in

Returns undefined | Server
- Defined in src/classes/Message.ts:82

systemMessage

get systemMessage(): undefined | SystemMessage
System message content

Returns undefined | SystemMessage
- Defined in src/classes/Message.ts:129

url

get url(): string
URL to this message

Returns string
- Defined in src/classes/Message.ts:52

username

get username(): undefined | string
Get the username for this message

Returns undefined | string
- Defined in src/classes/Message.ts:199

webhook

get webhook(): MessageWebhook
Webhook information for this message

Returns MessageWebhook
- Defined in src/classes/Message.ts:115

Methods

ack

ack(): void
Acknowledge this message as read

Returns void
- Defined in src/classes/Message.ts:276

clearReactions

clearReactions(): Promise<undefined>
Clear all reactions from this message

Returns Promise<undefined>
- Defined in src/classes/Message.ts:301

delete

delete(): Promise<undefined>
Delete a message

Returns Promise<undefined>
- Defined in src/classes/Message.ts:267

edit

edit(data: {
    content?: null | string;
    embeds?: null | {
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        media?: null | string;
        title?: null | string;
        url?: null | string;
    }[];
}): Promise<{
    _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: "Channel" | "Video" | "Clip";
            id: string;
            type: "Twitch";
        } | {
            content_type: string;
            id: string;
            type: "Spotify";
        } | {
            type: "Soundcloud";
        } | {
            content_type: "Album" | "Track";
            id: string;
            type: "Bandcamp";
        } | {
            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";
    })[];
    interactions?: {
        reactions?: null | string[];
        restrict_reactions?: boolean;
    };
    masquerade?: null | {
        avatar?: null | string;
        colour?: null | string;
        name?: null | string;
    };
    mentions?: null | string[];
    nonce?: null | string;
    reactions?: {
        [key: string]: string[];
    };
    replies?: 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";
    };
    webhook?: null | {
        avatar?: null | string;
        name: string;
    };
}>
Edit a message
Parameters
- data: {
      content?: null | string;
      embeds?: null | {
          colour?: null | string;
          description?: null | string;
          icon_url?: null | string;
          media?: null | string;
          title?: null | string;
          url?: null | string;
      }[];
  }
  
  Message edit route data
  - Optional content?: null | string
    
    Description
    New message content
  - Optional embeds?: null | {
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        media?: null | string;
        title?: null | string;
        url?: null | string;
    }[]
    
    Description
    Embeds to include in the message
Returns Promise<{
    _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: "Channel" | "Video" | "Clip";
            id: string;
            type: "Twitch";
        } | {
            content_type: string;
            id: string;
            type: "Spotify";
        } | {
            type: "Soundcloud";
        } | {
            content_type: "Album" | "Track";
            id: string;
            type: "Bandcamp";
        } | {
            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";
    })[];
    interactions?: {
        reactions?: null | string[];
        restrict_reactions?: boolean;
    };
    masquerade?: null | {
        avatar?: null | string;
        colour?: null | string;
        name?: null | string;
    };
    mentions?: null | string[];
    nonce?: null | string;
    reactions?: {
        [key: string]: string[];
    };
    replies?: 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";
    };
    webhook?: null | {
        avatar?: null | string;
        name: string;
    };
}>
- Defined in src/classes/Message.ts:257

react

react(emoji: string): Promise<undefined>
React to a message
Parameters
- emoji: string
  
  Unicode or emoji ID
Returns Promise<undefined>
- Defined in src/classes/Message.ts:311

reply

reply(data: string | Omit<{
    attachments?: null | string[];
    content?: null | string;
    embeds?: null | {
        colour?: null | string;
        description?: null | string;
        icon_url?: null | string;
        media?: null | string;
        title?: null | string;
        url?: null | string;
    }[];
    interactions?: null | {
        reactions?: null | string[];
        restrict_reactions?: boolean;
    };
    masquerade?: null | {
        avatar?: null | string;
        colour?: null | string;
        name?: null | string;
    };
    nonce?: null | string;
    replies?: null | {
        id: string;
        mention: boolean;
    }[];
}, "nonce"> & {
    nonce?: string;
}, mention?: boolean): undefined | Promise<Message>
Reply to Message
Parameters
- data: string | Omit<{
      attachments?: null | string[];
      content?: null | string;
      embeds?: null | {
          colour?: null | string;
          description?: null | string;
          icon_url?: null | string;
          media?: null | string;
          title?: null | string;
          url?: null | string;
      }[];
      interactions?: null | {
          reactions?: null | string[];
          restrict_reactions?: boolean;
      };
      masquerade?: null | {
          avatar?: null | string;
          colour?: null | string;
          name?: null | string;
      };
      nonce?: null | string;
      replies?: null | {
          id: string;
          mention: boolean;
      }[];
  }, "nonce"> & {
      nonce?: string;
  }
- mention: boolean = true
Returns undefined | Promise<Message>
- Defined in src/classes/Message.ts:283

unreact

unreact(emoji: string): Promise<undefined>
Un-react from a message
Parameters
- emoji: string
  
  Unicode or emoji ID
Returns Promise<undefined>
- Defined in src/classes/Message.ts:323

Class Message

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

collection: MessageCollection

id: string

Returns Message

Properties

Private Readonly #collection

Readonly id

Accessors

$exists

Returns boolean

animatedAvatarURL

Returns undefined | string

attachments

Returns undefined | File[]

author

Returns undefined | User

authorId

Returns undefined | string

avatarURL

Returns undefined | string

channel

Returns undefined | Channel

channelId

Returns string

content

Returns string

createdAt

Returns Date

editedAt

Returns undefined | Date

embeds

Returns undefined | MessageEmbed[]

interactions

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

masquerade

Returns undefined | { avatar?: null | string; colour?: null | string; name?: null | string; }

masqueradeAvatarURL

Returns undefined | string

member

Returns undefined | ServerMember

mentionIds

Returns undefined | string[]

mentioned

Returns undefined | boolean

nonce

Returns undefined | string

path

Returns string

reactions

Returns ReactiveMap<string, ReactiveSet<string>>

replyIds

Returns undefined | string[]

roleColour

Returns undefined | null | string

server

Returns undefined | Server

systemMessage

Returns undefined | SystemMessage

url

Returns string

username

Returns undefined | string

webhook

Returns MessageWebhook

Methods

ack

Returns void

clearReactions

Returns Promise<undefined>

delete

Returns Promise<undefined>

`Private` `Readonly` #collection

`Readonly` id

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

Returns undefined | {
avatar?: null | string;
colour?: null | string;
name?: null | string;
}

data: {
content?: null | string;
embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[];
}

`Optional` content?: null | string

`Optional` embeds?: null | {
colour?: null | string;
description?: null | string;
icon_url?: null | string;
media?: null | string;
title?: null | string;
url?: null | string;
}[]