Class: MessageEndpoint

Defined in: endpoints/message.ts:20

Constructors

Constructor

new MessageEndpoint(client): MessageEndpoint;

Defined in: endpoints/message.ts:21

Parameters

Parameter	Type
client	RESTClient

Returns

MessageEndpoint

Methods

addReaction()

addReaction(
   channelId, 
   messageId, 
   reaction
): Promise<IMessageReactionsResponse>;

Defined in: endpoints/message.ts:39

React to a message with either a unicode emoji or a custom one. Reacting twice with the same emoji is a no-op, not an error.

Parameters

Parameter	Type
channelId	number
messageId	number
reaction	IMessageReactionInput

Returns

Promise<IMessageReactionsResponse>

---

buzz()

buzz(channelId): Promise<IBuzzResponse>;

Defined in: endpoints/message.ts:162

Shake the screens of the other people in a private channel, MSN-style.

Rejected with buzz_cooldown if the sender buzzed this channel within the last minute, and buzz_not_allowed outside a private channel.

Parameters

Parameter	Type
channelId	number

Returns

Promise<IBuzzResponse>

---

createPoll()

createPoll(channelId, poll): Promise<ISendMessageResponse>;

Defined in: endpoints/message.ts:69

Post a poll as a new message, in a server text channel or a group chat. Needs create_polls as well as send_messages.

Parameters

Parameter	Type
channelId	number
poll	IPollInput

Returns

Promise<ISendMessageResponse>

---

deleteMessage()

deleteMessage(channelId, messageId): Promise<IDeleteMessageResponse>;

Defined in: endpoints/message.ts:180

Parameters

Parameter	Type
channelId	number
messageId	number

Returns

Promise<IDeleteMessageResponse>

---

editMessage()

editMessage(
   channelId, 
   messageId, 
   params
): Promise<IEditMessageResponse>;

Defined in: endpoints/message.ts:176

Parameters

Parameter	Type
channelId	number
messageId	number
params	{ content: string; }
params.content	string

Returns

Promise<IEditMessageResponse>

---

endPoll()

endPoll(channelId, messageId): Promise<IMessagePollResponse>;

Defined in: endpoints/message.ts:84

Close voting now. For the poll's creator, or anyone who can delete others' messages.

Parameters

Parameter	Type
channelId	number
messageId	number

Returns

Promise<IMessagePollResponse>

---

forwardMessage()

forwardMessage(
   channelId, 
   messageId, 
   targetChannelId
): Promise<ISendMessageResponse>;

Defined in: endpoints/message.ts:59

Copy a message into another channel. Content and attachments are copied, so the forward survives the original being deleted.

Parameters

Parameter	Type
channelId	number
messageId	number
targetChannelId	number

Returns

Promise<ISendMessageResponse>

---

getChannelMessages()

getChannelMessages(channelId, params?): Promise<IChannelMessagesResponse>;

Defined in: endpoints/message.ts:98

A page of a channel's history, newest first. Page from a message held by passing its createdAt and its id together (beforeTimestamp + beforeId, or afterTimestamp + afterId): messages sharing that millisecond are then ordered by id, so a page boundary between them skips none.

Parameters

Parameter	Type
channelId	number
params?	{ afterId?: number; afterTimestamp?: number; beforeId?: number; beforeTimestamp?: number; limit?: number; }
params.afterId?	number
params.afterTimestamp?	number
params.beforeId?	number
params.beforeTimestamp?	number
params.limit?	number

Returns

Promise<IChannelMessagesResponse>

---

getChannelPins()

getChannelPins(channelId): Promise<IGetChannelPinsResponse>;

Defined in: endpoints/message.ts:23

Parameters

Parameter	Type
channelId	number

Returns

Promise<IGetChannelPinsResponse>

---

getMessagesAround()

getMessagesAround(channelId, messageId): Promise<IChannelMessagesResponse>;

Defined in: endpoints/message.ts:127

Parameters

Parameter	Type
channelId	number
messageId	number

Returns

Promise<IChannelMessagesResponse>

---

getPendingUrgent()

getPendingUrgent(): Promise<IPendingUrgentResponse>;

Defined in: endpoints/message.ts:172

Urgent messages the caller has not read yet.

Fetched on startup so the reminder survives a reload; afterwards the socket keeps the list current.

Returns

Promise<IPendingUrgentResponse>

---

getReactions()

getReactions(channelId, messageId): Promise<IMessageReactionsResponse>;

Defined in: endpoints/message.ts:88

Parameters

Parameter	Type
channelId	number
messageId	number

Returns

Promise<IMessageReactionsResponse>

---

pinMessage()

pinMessage(channelId, messageId): Promise<ICreatePinResponse>;

Defined in: endpoints/message.ts:27

Parameters

Parameter	Type
channelId	number
messageId	number

Returns

Promise<ICreatePinResponse>

---

removeReaction()

removeReaction(
   channelId, 
   messageId, 
   emojiKey
): Promise<IMessageReactionsResponse>;

Defined in: endpoints/message.ts:48

Remove your own reaction. emojiKey is a grapheme or "custom:<id>".

Parameters

Parameter	Type
channelId	number
messageId	number
emojiKey	string

Returns

Promise<IMessageReactionsResponse>

---

searchChannel()

searchChannel(
   channelId, 
   query, 
   options?
): Promise<ISearchMessagesResponse>;

Defined in: endpoints/message.ts:116

search one channel's messages; api.search.messages searches everywhere

Parameters

Parameter	Type
channelId	number
query	string
options?	ISearchMessagesOptions

Returns

Promise<ISearchMessagesResponse>

---

sendMessage()

sendMessage(params): Promise<ISendMessageResponse>;

Defined in: endpoints/message.ts:132

Parameters

Parameter	Type	Description
params	{ channelId: number; content: string; mediaIds?: number[]; nonce?: string; replyToMessageId?: number | null; urgent?: boolean; }	-
params.channelId	number	-
params.content	string	-
params.mediaIds?	number[]	-
params.nonce?	string	Picked by the client for each message, and sent again unchanged when retrying it: in a channel another instance owns, a retry after a lost answer is then stored once, not twice.
params.replyToMessageId?	number | null	must be a message in the same channel
params.urgent?	boolean	sent with /!; reminds the recipients until they read it

Returns

Promise<ISendMessageResponse>

---

unpinMessage()

unpinMessage(channelId, messageId): Promise<IDeletePinResponse>;

Defined in: endpoints/message.ts:31

Parameters

Parameter	Type
channelId	number
messageId	number

Returns

Promise<IDeletePinResponse>

---

votePoll()

votePoll(
   channelId, 
   messageId, 
   optionIds
): Promise<IMessagePollResponse>;

Defined in: endpoints/message.ts:77

Replace your vote with these answers; an empty list takes it back. Refused with poll_closed once the poll has ended.

Parameters

Parameter	Type
channelId	number
messageId	number
optionIds	number[]

Returns

Promise<IMessagePollResponse>