Class CommentApi

CommentApi - object-oriented interface

Export

Hierarchy

BaseAPI
- CommentApi

Index

Constructors

Properties

axios basePath configuration

Methods

createComment deleteComment getComment getComments getPostComments updateComment

Constructors

constructor

new CommentApi(configuration?, basePath?, axios?): CommentApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CommentApi
Inherited from BaseAPI.constructor
- Defined in client/base.ts:51

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

createComment

createComment(requestParameters, options?): Promise<AxiosResponse<Comment, any>>
記事に新しいコメントを作成します。
Parameters
- requestParameters: CommentApiCreateCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Comment, any>>

Summary
コメントを投稿する

Throws

Memberof
CommentApi
- Defined in client/api/comment-api.ts:1079

deleteComment

deleteComment(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定されたコメントを削除します。
Parameters
- requestParameters: CommentApiDeleteCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
コメントを削除する

Throws

Memberof
CommentApi
- Defined in client/api/comment-api.ts:1103

getComment

getComment(requestParameters, options?): Promise<AxiosResponse<Comment, any>>
指定されたコメントを取得します。
Parameters
- requestParameters: CommentApiGetCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Comment, any>>

Summary
コメントを取得する

Throws

Memberof
CommentApi
- Defined in client/api/comment-api.ts:1124

getComments

getComments(requestParameters, options?): Promise<AxiosResponse<PaginatedComments, any>>
チーム全体のコメント一覧を作成日の降順で返却します。
Parameters
- requestParameters: CommentApiGetCommentsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedComments, any>>

Summary
コメント一覧を取得する

Throws

Memberof
CommentApi
- Defined in client/api/comment-api.ts:1146

getPostComments

getPostComments(requestParameters, options?): Promise<AxiosResponse<PaginatedComments, any>>
記事のコメント一覧を更新日の降順で返却します。
Parameters
- requestParameters: CommentApiGetPostCommentsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedComments, any>>

Summary
記事のコメント一覧を取得する

Throws

Memberof
CommentApi
- Defined in client/api/comment-api.ts:1168

updateComment

updateComment(requestParameters, options?): Promise<AxiosResponse<Comment, any>>
指定されたコメントを更新します。
Parameters
- requestParameters: CommentApiUpdateCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Comment, any>>

Summary
コメントを更新する

Throws

Memberof
CommentApi
- Defined in client/api/comment-api.ts:1191

Generated using TypeDoc