Class MessageRouter

The message router for the Guilded REST API.

Example

new MessageRouter(rest);

Hierarchy

BaseRouter
- MessageRouter

Index

Constructors

constructor

new MessageRouter(rest: RESTManager): MessageRouter
Parameters
- rest: RESTManager
  
  The REST API manager the router belongs to.
Returns MessageRouter
Inherited from BaseRouter.constructor
- Defined in rest/src/routers/BaseRouter.ts:9

Properties

`Readonly` rest

rest: RESTManager

The REST API manager the router belongs to.

Methods

create

create(channelId: string, payload: APIMessagePayloadResolvable): Promise<APIMessage>
Create a message on Guilded.

Returns
The created message.

Example
```
messages.create('abc', 'Hello world!');
```
Parameters
- channelId: string
  
  The ID of the channel the message belongs to.
- payload: APIMessagePayloadResolvable
  
  The payload of the message.
Returns Promise<APIMessage>
- Defined in rest/src/routers/MessageRouter.ts:64

delete

delete(channelId: string, messageId: string): Promise<void>
Delete a message from Guilded.

Example
```
messages.delete('abc', 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the message belongs to.
- messageId: string
  
  The ID of the message to delete.
Returns Promise<void>
- Defined in rest/src/routers/MessageRouter.ts:102

edit

edit(channelId: string, messageId: string, payload: APIMessageEditPayloadResolvable): Promise<APIMessage>
Edit a message on Guilded.

Returns
The edited message.

Example
```
messages.edit('abc', 'abc', 'Hello world!');
```
Parameters
- channelId: string
  
  The ID of the channel the message belongs to.
- messageId: string
  
  The ID of the message to edit.
- payload: APIMessageEditPayloadResolvable
  
  The payload of the message.
Returns Promise<APIMessage>
- Defined in rest/src/routers/MessageRouter.ts:84

fetch

fetch(channelId: string, messageId: string): Promise<APIMessage>
Fetch a message from Guilded.

Returns
The fetched message.

Example
```
messages.fetch('abc', 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the message belongs to.
- messageId: string
  
  The ID of the message to fetch.
Returns Promise<APIMessage>
- Defined in rest/src/routers/MessageRouter.ts:24
fetch(channelId: string, options?: APIMessageFetchManyOptions): Promise<APIMessage[]>
Fetch messages from Guilded.

Returns
The fetched messages.

Example
```
messages.fetch('abc');
```
Parameters
- channelId: string
  
  The ID of the channel the messages belong to.
- Optional options: APIMessageFetchManyOptions
  
  The options to fetch messages with.
Returns Promise<APIMessage[]>
- Defined in rest/src/routers/MessageRouter.ts:32

Class MessageRouter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rest: RESTManager

Returns MessageRouter

Properties

Readonly rest

Methods

create

Returns

Example

Parameters

channelId: string

payload: APIMessagePayloadResolvable

Returns Promise<APIMessage>

delete

Example

Parameters

channelId: string

messageId: string

Returns Promise<void>

edit

Returns

Example

Parameters

channelId: string

messageId: string

payload: APIMessageEditPayloadResolvable

Returns Promise<APIMessage>

fetch

Returns

Example

Parameters

channelId: string

messageId: string

Returns Promise<APIMessage>

Returns

Example

Parameters

channelId: string

Optional options: APIMessageFetchManyOptions

Returns Promise<APIMessage[]>

Settings

Member Visibility

Theme

`Readonly` rest

`Optional` options: APIMessageFetchManyOptions