Class CommentClient

Hierarchy

CommentClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new CommentClient(client: HttpClient): CommentClient

- Defined in content-api/src/clients/CommentClient.ts:10
Parameters
- client: HttpClient
Returns CommentClient

Properties

Private client

client: HttpClient

Methods

create

create(target: <internal>.commentTargets, params: BaseCommentParam): Promise<object>

- Defined in content-api/src/clients/CommentClient.ts:100
Create a comment

Parameters
- target: <internal>.commentTargets
  
  posts, sheets, or journals
- params: BaseCommentParam
  
  the comment params
Returns Promise<object>

listAsTreeView

listAsTreeView(target: <internal>.commentTargets, targetId: number, params?: { page?: number; sort?: string[] }): Promise<Response<Page<BaseComment>>>

- Defined in content-api/src/clients/CommentClient.ts:59
Get comments as tree view

Parameters
- target: <internal>.commentTargets
  
  posts, sheets, or journals
- targetId: number
  
  the id of the target
- Optional params: { page?: number; sort?: string[] }
  
  optional query params
  - Optional page?: number
  - Optional sort?: string[]
Returns Promise<Response<Page<BaseComment>>>

listAsView

listAsView(target: <internal>.commentTargets, targetId: number, params?: { page?: number; sort?: string[] }): Promise<Response<Page<BaseCommentWithParent>>>

- Defined in content-api/src/clients/CommentClient.ts:80
Get comments as list view

Parameters
- target: <internal>.commentTargets
  
  posts, sheets, or journals
- targetId: number
  
  the id of the target
- Optional params: { page?: number; sort?: string[] }
  
  optional query params
  - Optional page?: number
  - Optional sort?: string[]
Returns Promise<Response<Page<BaseCommentWithParent>>>

listChildren

listChildren(target: <internal>.commentTargets, targetId: number, commentId: number, params?: { sort?: string[] }): Promise<Response<BaseComment[]>>

- Defined in content-api/src/clients/CommentClient.ts:40
Get children comments

Parameters
- target: <internal>.commentTargets
  
  posts, sheets, or journals
- targetId: number
  
  the id of the target
- commentId: number
  
  the id of the top comment
- Optional params: { sort?: string[] }
  
  optional query params
  - Optional sort?: string[]
Returns Promise<Response<BaseComment[]>>

listTopComments

listTopComments(target: <internal>.commentTargets, targetId: number, params?: { page: number; sort?: string[] }): Promise<Response<Page<CommentWithHasChildren>>>

- Defined in content-api/src/clients/CommentClient.ts:21
Get top comments

Parameters
- target: <internal>.commentTargets
  
  posts, sheets, or journals
- targetId: number
  
  the id of the target
- Optional params: { page: number; sort?: string[] }
  
  optional query params
  - page: number
  - Optional sort?: string[]
Returns Promise<Response<Page<CommentWithHasChildren>>>

Generated using TypeDoc