MessageCommentService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• messageCommentCreate
• messageCommentList
• messageCommentRemove
• postApiMessageCommentReactionCreate

Constructors

constructor

• new MessageCommentService(httpRequest: BaseHttpRequest): MessageCommentService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns MessageCommentService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicmessageCommentCreate

• messageCommentCreate(__namedParameters: { requestBody: CreateMessageCommentParam }): CancelablePromise<{ data?: CreateMessageCommentResponse }>

• Comment on a message Bot-compatible Posts a comment on a message.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: CreateMessageCommentParam }

  Returns CancelablePromise<{ data?: CreateMessageCommentResponse }>

  any Successfully commented on the message.

publicmessageCommentList

• messageCommentList(__namedParameters: { limit?: number; messageId: string; offset?: string }): CancelablePromise<{ data?: GetMessageCommentListResponse }>

• List out message comments Bot-compatible Lists out a given number of comments on a message. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

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

  Returns CancelablePromise<{ data?: GetMessageCommentListResponse }>

  any Successfully retrieved the comments.

publicmessageCommentRemove

• messageCommentRemove(__namedParameters: { requestBody: DeleteMessageCommentParam }): CancelablePromise<any>

• Delete a message comment Bot-compatible Deletes a comment on a message.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DeleteMessageCommentParam }

  Returns CancelablePromise<any>

  any Successfully deleted the comment.

publicpostApiMessageCommentReactionCreate

• postApiMessageCommentReactionCreate(__namedParameters: { requestBody?: { comment_id?: string; reaction_value?: string } }): CancelablePromise<void>

• React to a message comment Adds a reaction emoji to a message's comment.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { comment_id?: string; reaction_value?: string } }

  Returns CancelablePromise<void>

  void