Skip to content

Class: ChatEndpoint

Extends

Methods

banUser()

banUser(channel, target, duration?): Promise<GenericApiResponse<null>>

Parameters

ParameterType
channelstring
targetstring
duration?number

Returns

Promise<GenericApiResponse<null>>

endpoints/chat/chat.endpoint.ts:140


deleteMessage()

deleteMessage(chatroomId, messageId): Promise<GenericApiResponse<null>>

Parameters

ParameterType
chatroomIdstring | number
messageIdstring

Returns

Promise<GenericApiResponse<null>>

endpoints/chat/chat.endpoint.ts:66


getMessageHistory()

getMessageHistory(channelId): Promise<GenericApiResponse<Messages>>

Parameters

ParameterType
channelIdnumber

Returns

Promise<GenericApiResponse<Messages>>

endpoints/chat/chat.endpoint.ts:128


pinMessage()

pinMessage(channel, messageId): Promise<GenericApiResponse<null>>

Parameters

ParameterType
channelstring
messageIdstring

Returns

Promise<GenericApiResponse<null>>

endpoints/chat/chat.endpoint.ts:83


sendMessage()

sendMessage(chatroomId, message, replyTo?): Promise<SendMessageResponse>

Parameters

ParameterType
chatroomIdstring | number
messagestring
replyTo?ChatMessageReference

Returns

Promise<SendMessageResponse>

endpoints/chat/chat.endpoint.ts:25


unbanUser()

unbanUser(channel, target): Promise<GenericApiResponse<null>>

Parameters

ParameterType
channelstring
targetstring

Returns

Promise<GenericApiResponse<null>>

endpoints/chat/chat.endpoint.ts:173


unpinMessage()

unpinMessage(channel): Promise<GenericApiResponse<null>>

Parameters

ParameterType
channelstring

Returns

Promise<GenericApiResponse<null>>

endpoints/chat/chat.endpoint.ts:111


Generated using typedoc-plugin-markdown and TypeDoc