Class: ReadEndpoint ​
Defined in: endpoints/read.ts:4
Constructors ​
Constructor ​
ts
new ReadEndpoint(client): ReadEndpoint;Defined in: endpoints/read.ts:5
Parameters ​
| Parameter | Type |
|---|---|
client | RESTClient |
Returns ​
ReadEndpoint
Methods ​
getChannelUnreadCounts() ​
ts
getChannelUnreadCounts(serverId?): Promise<IChannelUnreadCountsResponse>;Defined in: endpoints/read.ts:26
Parameters ​
| Parameter | Type |
|---|---|
serverId? | number |
Returns ​
Promise<IChannelUnreadCountsResponse>
getReadState() ​
ts
getReadState(channelId): Promise<IChannelReadStateResponse>;Defined in: endpoints/read.ts:13
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
Returns ​
Promise<IChannelReadStateResponse>
markAllAsRead() ​
ts
markAllAsRead(channelId): Promise<IChannelReadStateResponse>;Defined in: endpoints/read.ts:17
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
Returns ​
Promise<IChannelReadStateResponse>
markServerAsRead() ​
ts
markServerAsRead(serverId): Promise<IMarkServerReadResponse>;Defined in: endpoints/read.ts:22
mark every channel you can see in a server as read
Parameters ​
| Parameter | Type |
|---|---|
serverId | number |
Returns ​
Promise<IMarkServerReadResponse>
updateReadPosition() ​
ts
updateReadPosition(channelId, lastReadMessageId): Promise<IChannelReadStateResponse>;Defined in: endpoints/read.ts:7
Parameters ​
| Parameter | Type |
|---|---|
channelId | number |
lastReadMessageId | number |
Returns ​
Promise<IChannelReadStateResponse>