TaskCommentService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• taskCommentCreate
• taskCommentList
• taskCommentRemove
• taskCommentUpdate

Constructors

constructor

• new TaskCommentService(httpRequest: BaseHttpRequest): TaskCommentService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns TaskCommentService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publictaskCommentCreate

• taskCommentCreate(__namedParameters: { requestBody: AddTaskCommentParam }): CancelablePromise<{ data?: AddTaskCommentResponse }>

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

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddTaskCommentParam }

  Returns CancelablePromise<{ data?: AddTaskCommentResponse }>

  any Successfully commented on the task.

publictaskCommentList

• taskCommentList(__namedParameters: { bodyType?: plain | json_string; limit?: number; offset?: string; taskId: string }): CancelablePromise<{ data?: GetTaskCommentResponse }>

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

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { bodyType?: plain | json_string; limit?: number; offset?: string; taskId: string }

  Returns CancelablePromise<{ data?: GetTaskCommentResponse }>

  any Successfully retrieved the comments.

publictaskCommentRemove

• taskCommentRemove(__namedParameters: { requestBody: DelTaskCommentParam }): CancelablePromise<any>

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

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelTaskCommentParam }

  Returns CancelablePromise<any>

  any Successfully deleted the comment.

publictaskCommentUpdate

• taskCommentUpdate(__namedParameters: { requestBody: PutTaskCommentParam }): CancelablePromise<{ data?: PutTaskCommentResponse }>

• Edit a task comment Bot-compatible Edits a comment on a task.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: PutTaskCommentParam }

  Returns CancelablePromise<{ data?: PutTaskCommentResponse }>

  any Successfully edited the comment.