Class MessageAPI

A wrapper for the FoxoChat message API.

Index

Constructors

Methods

create createAttachments delete edit get list

Constructors

constructor

new MessageAPI(rest: REST): MessageAPI
Parameters
- rest: REST
Returns MessageAPI
- Defined in packages/api/src/MessageAPI.ts:22

Methods

create

create(channelId: number, body: RESTPostAPIMessageBody): Promise<APIMessage>
Sends a message in a channel.
Parameters
- channelId: number
- body: RESTPostAPIMessageBody
Returns Promise<APIMessage>
- Defined in packages/api/src/MessageAPI.ts:36

createAttachments

createAttachments(
channelId: number,
body: RESTPutAPIMessageAttachmentsBody,
): Promise<RESTPutAPIMessageAttachmentsResult>
Creates a message attachments.
Parameters
- channelId: number
- body: RESTPutAPIMessageAttachmentsBody
Returns Promise<RESTPutAPIMessageAttachmentsResult>
- Defined in packages/api/src/MessageAPI.ts:66

delete

delete(channelId: number, messageId: number): Promise<APIOk>
Deletes a message.
Parameters
- channelId: number
- messageId: number
Returns Promise<APIOk>
- Defined in packages/api/src/MessageAPI.ts:59

edit

edit(
    channelId: number,
    messageId: number,
    body: RESTPatchAPIMessageBody,
): Promise<APIMessage>
Edits a message.
Parameters
- channelId: number
- messageId: number
- body: RESTPatchAPIMessageBody
Returns Promise<APIMessage>
- Defined in packages/api/src/MessageAPI.ts:52

get

get(channelId: number, messageId: number): Promise<APIMessage>
Fetches a message.
Parameters
- channelId: number
- messageId: number
Returns Promise<APIMessage>
- Defined in packages/api/src/MessageAPI.ts:45

list

list(
channelId: number,
query?: RESTGetAPIMessageListQuery,
): Promise<RESTGetAPIMessageListResult>
Fetches the messages in a channel.
Parameters
- channelId: number
- query: RESTGetAPIMessageListQuery = {}
Returns Promise<RESTGetAPIMessageListResult>
- Defined in packages/api/src/MessageAPI.ts:27