Class MessageReaction

Represents a message reaction on Guilded.

Example

new MessageReaction(message, rawReaction);

Hierarchy

Base<number>
- MessageReaction

Index

Constructors

constructor

new MessageReaction(message: Message, raw: APIMessageReaction, cache?: boolean): MessageReaction
Parameters
- message: Message
  
  The message the reaction belongs to.
- raw: APIMessageReaction
  
  The raw data of the reaction.
- cache: boolean = ...
  
  Whether to cache the reaction.
Returns MessageReaction
Overrides Base.constructor
- Defined in guilded.ts/src/structures/message/MessageReaction.ts:25

Properties

`Readonly` channelId

channelId: string

The ID of the channel the message belongs to.

`Readonly` client

client: Client

The client the data model belongs to.

`Readonly` createdBy

createdBy: string

The ID of the user that created the reaction.

`Readonly` emote

emote: APIEmote

The emote of the reaction.

`Readonly` id

id: number

The ID of the structure.

`Readonly` message

message: Message

The message the reaction belongs to.

`Readonly` messageId

messageId: string

The ID of the message.

`Readonly` raw

raw: APIMessageReaction

The raw data of the reaction.

Accessors

author

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

Returns undefined | ServerMember
- Defined in guilded.ts/src/structures/message/MessageReaction.ts:59

channel

get channel(): ChatChannel
The channel the message belongs to.

Returns ChatChannel
- Defined in guilded.ts/src/structures/message/MessageReaction.ts:44

isCached

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

Returns boolean
- Defined in guilded.ts/src/structures/message/MessageReaction.ts:39

server

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

Returns undefined | Server
- Defined in guilded.ts/src/structures/message/MessageReaction.ts:54

serverId

get serverId(): undefined | string
The ID of the server the message belongs to.

Returns undefined | string
- Defined in guilded.ts/src/structures/message/MessageReaction.ts:49

Methods

fetchAuthor

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

Returns
The fetched server member.

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

fetchServer

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

Returns
The fetched server.

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

remove

remove(): Promise<void>
Remove the reaction from the message.

Example
```
reaction.remove();
```
Returns Promise<void>
- Defined in guilded.ts/src/structures/message/MessageReaction.ts:88

Class MessageReaction

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

message: Message

raw: APIMessageReaction

cache: boolean = ...

Returns MessageReaction

Properties

Readonly channelId

Readonly client

Readonly createdBy

Readonly emote

Readonly id

Readonly message

Readonly messageId

Readonly raw

Accessors

author

Returns undefined | ServerMember

channel

Returns ChatChannel

isCached

Returns boolean

server

Returns undefined | Server

serverId

Returns undefined | string

Methods

fetchAuthor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

fetchServer

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<Server>

remove

Example

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` channelId

`Readonly` client

`Readonly` createdBy

`Readonly` emote

`Readonly` id

`Readonly` message

`Readonly` messageId

`Readonly` raw

`Optional` options: FetchOptions

`Optional` options: FetchOptions