MessageService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• messageCreate
• messageInfo
• messageList
• messageReactionCreate
• messageReactionRemove
• messageRemove
• postApiMessageShare
• postApiMessageTaskShare

Constructors

constructor

• new MessageService(httpRequest: BaseHttpRequest): MessageService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns MessageService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicmessageCreate

• messageCreate(__namedParameters: { requestBody: CreateMessageParam }): CancelablePromise<{ data?: CreateMessageResponse }>

• Create a message Bot-compatible Creates a message in a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: CreateMessageParam }

  Returns CancelablePromise<{ data?: CreateMessageResponse }>

  any Successfully created the message.

publicmessageInfo

• messageInfo(__namedParameters: { id: string }): CancelablePromise<{ data?: Message }>

• Get a message's information Bot-compatible Retrieves information about a message.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { id: string }

  Returns CancelablePromise<{ data?: Message }>

  any Successfully retrieved information about the message.

publicmessageList

• messageList(__namedParameters: { channelId: string; limit?: number; offset?: string }): CancelablePromise<{ data?: GetMessageListResponse }>

• List out messages Bot-compatible Lists out a given number of messages in a channel. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { channelId: string; limit?: number; offset?: string }

  Returns CancelablePromise<{ data?: GetMessageListResponse }>

  any Successfully retrieved the messages.

publicmessageReactionCreate

• messageReactionCreate(__namedParameters: { requestBody: AddMessageReactionParam }): CancelablePromise<{ data?: AddMessageReactionResponse }>

• React to a message Adds a reaction emoji to a message.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddMessageReactionParam }

  Returns CancelablePromise<{ data?: AddMessageReactionResponse }>

  any Successfully added the reaction.

publicmessageReactionRemove

• messageReactionRemove(__namedParameters: { requestBody: DelMessageReactionParam }): CancelablePromise<any>

• Remove a reaction emoji from a message Removes a reaction emoji from a message.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelMessageReactionParam }

  Returns CancelablePromise<any>

  any Successfully removed the reaction.

publicmessageRemove

• messageRemove(__namedParameters: { requestBody: DeleteMessageParam }): CancelablePromise<any>

• Delete a message Bot-compatible Deletes a message in a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DeleteMessageParam }

  Returns CancelablePromise<any>

  any Successfully deleted the message.

publicpostApiMessageShare

• postApiMessageShare(__namedParameters: { requestBody?: { channel_id?: string; message_id?: string } }): CancelablePromise<{ data?: CreateMessageFromMailResponse }>

• Share a message to a channel Shares a message to a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { channel_id?: string; message_id?: string } }

  Returns CancelablePromise<{ data?: CreateMessageFromMailResponse }>

  any OK

publicpostApiMessageTaskShare

• postApiMessageTaskShare(__namedParameters: { requestBody?: { channel_id?: string; task_id?: string } }): CancelablePromise<{ data?: CreateMessageFromMailResponse }>

• Share a task to a channel Shares a task to a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { channel_id?: string; task_id?: string } }

  Returns CancelablePromise<{ data?: CreateMessageFromMailResponse }>

  any OK