Class Message

The base of all structures in this library. All structures that have an ID will extend this class.

Hierarchy

Base<ChatMessagePayload>
- Message

Index

Constructors

Constructors

constructor

new Message(client, data): Message
Parameters
- client: Client
- data: ChatMessagePayload
Returns Message
Overrides Base.constructor
- Defined in guilded.js/lib/structures/Message.ts:71

Properties

`Readonly` _createdAt

_createdAt: number

The timestamp that the message was created at.

_deletedAt

_deletedAt: null | number = null

When the message was deleted, if it was

_updatedAt

_updatedAt: null | number

The timestamp that the message was updated at, if relevant

`Readonly` channelId

channelId: string

The ID of the channel

`Readonly` client

client: Client

content

content: string

The content of the message

`Readonly` createdById

createdById: string

The ID of the user who created this message (Note: If this event has createdByBotId or createdByWebhookId present, this field will still be populated, but can be ignored. In these cases, the value of this field will always be Ann6LewA)

`Readonly` createdByWebhookId

createdByWebhookId: null | string

The ID of the webhook who created this message, if it was created by a webhook

deleted

deleted: boolean = false

Whether the message has been deleted

embeds

embeds: Embed[] = []

Embeds contained within this message

`Readonly` groupId

groupId: null | string

The ID of the group this message was posted in

id

id: string

Identifier of this structrure

`Readonly` isPrivate

isPrivate: boolean

If set, this message will only be seen by those mentioned or replied to.

`Readonly` isReply

isReply: boolean

Bool value to wether message is a reply or not

`Readonly` isSilent

isSilent: boolean

If set, this message did not notify, mention or reply recipients.

`Optional` mentions

mentions?: MentionsPayload

The mentions within this message

raw

raw: ChatMessagePayload

Bare data of this structure

`Readonly` replyMessageIds

replyMessageIds: string[] = []

The ID of the messages that this is replying to.

`Readonly` serverId

serverId: null | string

The ID of the server this message belongs to

`Readonly` type

type: MessageType

The type of chat message. "system" messages are generated by Guilded, while "default" messages are user or bot-generated.

Accessors

author

get author(): null | User
Returns the author of this message, or null if the author is not cached.

Returns null | User
- Defined in guilded.js/lib/structures/Message.ts:149

authorId

get authorId(): string
Returns the ID of the user who sent this message.

Returns string
- Defined in guilded.js/lib/structures/Message.ts:156

channel

get channel(): null | Channel
Returns the channel that this message belongs to, or null if the channel is not cached.

Returns null | Channel
- Defined in guilded.js/lib/structures/Message.ts:170

createdAt

get createdAt(): Date
Returns Date
- Defined in guilded.js/lib/structures/Message.ts:122

deletedAt

get deletedAt(): null | Date
Returns the date and time the message was deleted, if it was.

Returns null | Date
- Defined in guilded.js/lib/structures/Message.ts:136

member

get member(): null | Member
Returns the member of this message, if the message is in a server, or null otherwise or if the member is not cached.

Returns null | Member
- Defined in guilded.js/lib/structures/Message.ts:163

server

get server(): null | Server
Returns null | Server
- Defined in guilded.js/lib/structures/Message.ts:174

updatedAt

get updatedAt(): null | Date
Returns the date and time the message was last updated, if relevant.

Returns null | Date
- Defined in guilded.js/lib/structures/Message.ts:129

url

get url(): string
Returns the url of this message

Returns string
- Defined in guilded.js/lib/structures/Message.ts:141

Methods

_clone

_clone(): Message
Taken from https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/src/structures/Base.js#L20 Licensed under the Apache License 2.0 https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/LICENSE

Returns Message
Inherited from Base._clone
- Defined in guilded.js/lib/structures/Base.ts:28

_update

_update(data): Message
Update details of this structure
Parameters
- data: Partial<ChatMessagePayload> | {
  deletedAt: string;
  }
Returns Message
- Defined in guilded.js/lib/structures/Message.ts:91

addReaction

addReaction(emoteId): Promise<void>
Add a reaction emote.
Parameters
- emoteId: number
  
  The ID of the emote to add.
Returns Promise<void>
A promise that resolves when the emote has been added.
- Defined in guilded.js/lib/structures/Message.ts:245

awaitReactions

awaitReactions(options): Promise<CollectorReturnValue<MessageReaction>>
Parameters
- options: CollectorOptions<MessageReaction>
Returns Promise<CollectorReturnValue<MessageReaction>>
- Defined in guilded.js/lib/structures/Message.ts:235

createThread

createThread(name): Promise<ThreadChannel>
Parameters
- name: string
Returns Promise<ThreadChannel>
- Defined in guilded.js/lib/structures/Message.ts:227

delete

delete(): Promise<void>
Delete this message.

Returns Promise<void>
A promise that resolves when the message has been deleted.
- Defined in guilded.js/lib/structures/Message.ts:273

deleteReaction

deleteReaction(emoteId, userId?): Promise<void>
Deletes either a whole reaction emote from a message or a specific user's if a userId is provided.
Parameters
- emoteId: number
  
  The ID of the emote to delete.
- Optional userId: string
Returns Promise<void>
A promise that resolves when the emote has been deleted.
- Defined in guilded.js/lib/structures/Message.ts:259

edit

edit(newContent): Promise<Message>
Edit message content.
Parameters
- newContent: MessageContent
  
  The new content of the message.
Returns Promise<Message>
A promise that resolves with the updated message.
- Defined in guilded.js/lib/structures/Message.ts:184

reply

reply(content): Promise<Message>
Send a message that replies to this message. It mentions the user who sent this message.

Example
```
let replyObj = {
 content: 'This is text, supports **markdown**.',
 embeds: [{
   title: 'This is an embed title!',
   description: 'A description may go here'
 }]
};
message.reply(replyObj)
```
Parameters
- content: MessageContent
  
  The content of the message to send.
Returns Promise<Message>
- Defined in guilded.js/lib/structures/Message.ts:220

send

send(content): Promise<Message>

Send a message in the same channel as this message.

Example

let replyObj = {
 content: 'This is text, supports **markdown**.',
 embeds: [{
   title: 'This is an embed title!',
   description: 'A description may go here'
 }]
};
message.send(replyObj)

Parameters

content: MessageContent

The content of the message.

Class Message

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

data: ChatMessagePayload

Returns Message

Properties

Readonly _createdAt

_deletedAt

_updatedAt

Readonly channelId

Readonly client

content

Readonly createdById

Readonly createdByWebhookId

deleted

embeds

Readonly groupId

id

Readonly isPrivate

Readonly isReply

Readonly isSilent

Optional mentions

raw

Readonly replyMessageIds

Readonly serverId

Readonly type

Accessors

author

Returns null | User

authorId

Returns string

channel

Returns null | Channel

createdAt

Returns Date

deletedAt

Returns null | Date

member

Returns null | Member

server

Returns null | Server

updatedAt

Returns null | Date

url

Returns string

Methods

_clone

Returns Message

_update

Parameters

data: Partial<ChatMessagePayload> | { deletedAt: string; }

Returns Message

addReaction

Parameters

emoteId: number

Returns Promise<void>

awaitReactions

Parameters

options: CollectorOptions<MessageReaction>

Returns Promise<CollectorReturnValue<MessageReaction>>

createThread

Parameters

name: string

Returns Promise<ThreadChannel>

delete

Returns Promise<void>

deleteReaction

Parameters

emoteId: number

Optional userId: string

Returns Promise<void>

edit

`Readonly` _createdAt

`Readonly` channelId

`Readonly` client

`Readonly` createdById

`Readonly` createdByWebhookId

`Readonly` groupId

`Readonly` isPrivate

`Readonly` isReply

`Readonly` isSilent

`Optional` mentions

`Readonly` replyMessageIds

`Readonly` serverId

`Readonly` type

data: Partial<ChatMessagePayload> | {
deletedAt: string;
}

`Optional` userId: string