Class Message

Represents a message on Guilded.

Example

new Message(channel, rawMessage);

Hierarchy

Base
- Message

Constructors

constructor

new Message(channel: ChatChannel, raw: APIMessage, cache?: boolean): Message
Parameters
- channel: ChatChannel
  
  The chat channel the message belongs to.
- raw: APIMessage
  
  The raw data of the message.
- cache: boolean = ...
  
  Whether to cache the message.
Returns Message
Overrides Base.constructor
- Defined in guilded.ts/src/structures/message/Message.ts:57

Properties

`Readonly` channel

channel: ChatChannel

The chat channel the message belongs to.

`Readonly` channelId

channelId: string

The ID of the channel the message belongs to.

`Readonly` client

client: Client

The client the data model belongs to.

`Optional` `Readonly` content

content?: string

The content of the message.

`Readonly` createdAt

createdAt: Date

The date the message was created.

`Readonly` createdBy

createdBy: string

The ID of the user that created the message.

`Optional` `Readonly` createdByWebhookId

createdByWebhookId?: string

The ID of the webhook that created the message.

`Optional` deletedAt

deletedAt?: Date

The date the message was deleted.

`Optional` `Readonly` editedAt

editedAt?: Date

The date the message was edited.

`Readonly` embeds

embeds: APIEmbed[]

The embeds in the message.

`Readonly` id

id: string

The ID of the structure.

`Optional` `Readonly` isPrivate

isPrivate?: boolean

Whether the message is private.

`Optional` `Readonly` isSilent

isSilent?: boolean

Whether the message is silent.

`Optional` `Readonly` mentions

mentions?: APIMentions

The mentions of the message.

`Readonly` raw

raw: APIMessage

The raw data of the message.

`Readonly` reactions

reactions: MessageReactionManager

A manager of reactions that belong to the message.

`Readonly` replyMessageIds

replyMessageIds: string[]

The IDs of messages that were replied to.

`Optional` `Readonly` serverId

serverId?: string

The ID of the server the message belongs to.

`Readonly` type

type: MessageType

The type of the message.

Accessors

author

get author(): undefined | ServerMember
The server member that created the message.

Returns undefined | ServerMember
- Defined in guilded.ts/src/structures/message/Message.ts:121

authorId

get authorId(): string
The ID of the user that created the message.

Returns string
- Defined in guilded.ts/src/structures/message/Message.ts:133

createdTimestamp

get createdTimestamp(): number
The timestamp the message was created.

Returns number
- Defined in guilded.ts/src/structures/message/Message.ts:106

deletedTimestamp

get deletedTimestamp(): undefined | number
The timestamp the message was deleted.

Returns undefined | number
- Defined in guilded.ts/src/structures/message/Message.ts:148

editedTimestamp

get editedTimestamp(): undefined | number
The timestamp the message was edited.

Returns undefined | number
- Defined in guilded.ts/src/structures/message/Message.ts:111

group

get group(): undefined | Group
The group the message belongs to.

Returns undefined | Group
- Defined in guilded.ts/src/structures/message/Message.ts:101

isCached

get isCached(): boolean
Whether the message is cached.

Returns boolean
- Defined in guilded.ts/src/structures/message/Message.ts:81

isDefault

get isDefault(): boolean
Whether the message is a default message.

Returns boolean
- Defined in guilded.ts/src/structures/message/Message.ts:86

isDeleted

get isDeleted(): boolean
Whether the message is deleted.

Returns boolean
- Defined in guilded.ts/src/structures/message/Message.ts:116

isEditable

get isEditable(): boolean
Whether the message is editable.

Returns boolean
- Defined in guilded.ts/src/structures/message/Message.ts:153

isSystem

get isSystem(): boolean
Whether the message is a system message.

Returns boolean
- Defined in guilded.ts/src/structures/message/Message.ts:91

replies

get replies(): Collection<string, Message>
The messages that were replied to.

Returns Collection<string, Message>
- Defined in guilded.ts/src/structures/message/Message.ts:138

server

get server(): undefined | Server
The server the message belongs to.

Returns undefined | Server
- Defined in guilded.ts/src/structures/message/Message.ts:96

webhook

get webhook(): undefined | Webhook
The webhook that created the message.

Returns undefined | Webhook
- Defined in guilded.ts/src/structures/message/Message.ts:126

Methods

awaitReactions

awaitReactions(options?: CollectorOptions<MessageReaction>): Promise<Collection<number, MessageReaction>>
Similar to createReactionCollector but in promise form.

Returns
The collected reactions.

Example
```
message.awaitReactions();
```
Parameters
- Optional options: CollectorOptions<MessageReaction>
  
  The options of the reaction collector.
Returns Promise<Collection<number, MessageReaction>>
- Defined in guilded.ts/src/structures/message/Message.ts:293

createReactionCollector

createReactionCollector(options?: CollectorOptions<MessageReaction>): MessageReactionCollector
Create a reaction collector for the message.

Params
options The options of the reaction collector.

Returns
The created reaction collector.

Example
```
message.createReactionCollector();
```
Parameters
- Optional options: CollectorOptions<MessageReaction>
Returns MessageReactionCollector
- Defined in guilded.ts/src/structures/message/Message.ts:283

delete

delete(): Promise<Message>
Delete the message.

Returns
The deleted message.

Example
```
message.delete();
```
Returns Promise<Message>
- Defined in guilded.ts/src/structures/message/Message.ts:239

edit

edit(payload: MessageEditPayloadResolvable): Promise<Message>
Edit the message.

Returns
The edited message.

Example
```
message.edit('Hello World!');
```
Parameters
- payload: MessageEditPayloadResolvable
  
  The payload of the message.
Returns Promise<Message>
- Defined in guilded.ts/src/structures/message/Message.ts:230

fetch

fetch(options?: FetchOptions): Promise<Message>
Fetch the message.

Returns
The fetched message.

Example
```
message.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the message with.
Returns Promise<Message>
- Defined in guilded.ts/src/structures/message/Message.ts:163

fetchAuthor

fetchAuthor(options?: FetchOptions): Promise<ServerMember>
Fetch the server member that created the message.

Returns
The fetched server member.

Example
```
message.fetchAuthor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<ServerMember>
- Defined in guilded.ts/src/structures/message/Message.ts:193

fetchGroup

fetchGroup(options?: FetchOptions): Group
Fetch the group the message belongs to.

Returns
The fetched group.

Example
```
message.fetchGroup();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the group with.
Returns Group
- Defined in guilded.ts/src/structures/message/Message.ts:183

fetchReplies

fetchReplies(options?: FetchManyOptions): Promise<Collection<string, Message>>
Fetch the messages that were replied to.

Returns
The fetched messages.
Parameters
- Optional options: FetchManyOptions
  
  The options to fetch the messages with.
Returns Promise<Collection<string, Message>>
- Defined in guilded.ts/src/structures/message/Message.ts:215

fetchServer

fetchServer(options?: FetchOptions): Promise<Server>
Fetch the server the message belongs to.

Returns
The fetched server.

Example
```
message.fetchServer();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server with.
Returns Promise<Server>
- Defined in guilded.ts/src/structures/message/Message.ts:173

fetchWebhook

fetchWebhook(options?: FetchOptions): undefined | Promise<Webhook>
Fetch the webhook that created the message.

Returns
The fetched webhook.

Example
```
message.fetchWebhook();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the webhook with.
Returns undefined | Promise<Webhook>
- Defined in guilded.ts/src/structures/message/Message.ts:204

react

react(emojiId: number): Promise<Message>
React to the message.

Returns
The message.

Example
```
message.react(123);
```
Parameters
- emojiId: number
  
  The ID of the emoji to react with.
Returns Promise<Message>
- Defined in guilded.ts/src/structures/message/Message.ts:272

reply

reply(payload: MessagePayloadResolvable): Promise<Message>
Reply to the message.

Returns
The created message.

Example
```
message.reply('Hello World!');
```
Parameters
- payload: MessagePayloadResolvable
  
  The payload of the message.
Returns Promise<Message>
- Defined in guilded.ts/src/structures/message/Message.ts:250

Class Message

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

channel: ChatChannel

raw: APIMessage

cache: boolean = ...

Returns Message

Properties

Readonly channel

Readonly channelId

Readonly client

Optional Readonly content

Readonly createdAt

Readonly createdBy

Optional Readonly createdByWebhookId

Optional deletedAt

Optional Readonly editedAt

Readonly embeds

Readonly id

Optional Readonly isPrivate

Optional Readonly isSilent

Optional Readonly mentions

Readonly raw

Readonly reactions

Readonly replyMessageIds

Optional Readonly serverId

Readonly type

Accessors

author

Returns undefined | ServerMember

authorId

Returns string

createdTimestamp

Returns number

deletedTimestamp

Returns undefined | number

editedTimestamp

Returns undefined | number

group

Returns undefined | Group

isCached

Returns boolean

isDefault

Returns boolean

isDeleted

Returns boolean

isEditable

Returns boolean

isSystem

Returns boolean

replies

Returns Collection<string, Message>

server

Returns undefined | Server

webhook

Returns undefined | Webhook

Methods

awaitReactions

Returns

Example

Parameters

Optional options: CollectorOptions<MessageReaction>

Returns Promise<Collection<number, MessageReaction>>

createReactionCollector

Params

Returns

Example

Parameters

Optional options: CollectorOptions<MessageReaction>

Returns MessageReactionCollector

delete

Returns

`Readonly` channel

`Readonly` channelId

`Readonly` client

`Optional` `Readonly` content

`Readonly` createdAt

`Readonly` createdBy

`Optional` `Readonly` createdByWebhookId

`Optional` deletedAt

`Optional` `Readonly` editedAt

`Readonly` embeds

`Readonly` id

`Optional` `Readonly` isPrivate

`Optional` `Readonly` isSilent

`Optional` `Readonly` mentions

`Readonly` raw

`Readonly` reactions

`Readonly` replyMessageIds

`Optional` `Readonly` serverId

`Readonly` type

`Optional` options: CollectorOptions<MessageReaction>

`Optional` options: CollectorOptions<MessageReaction>

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchManyOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions