Class CommentClient

Hierarchy

CommentClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new CommentClient(client: HttpClient): CommentClient

- Defined in admin-api/src/clients/CommentClient.ts:18
Parameters
- client: HttpClient
Returns CommentClient

Properties

Private client

client: HttpClient

Methods

create

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

- Defined in admin-api/src/clients/CommentClient.ts:72
Parameters
- target: <internal>.commentTargets
- params: BaseCommentParam
Returns Promise<Response<BaseComment>>

delete

delete(target: <internal>.commentTargets, commentId: number): Promise<Response<BaseComment>>

- Defined in admin-api/src/clients/CommentClient.ts:108
Parameters
- target: <internal>.commentTargets
- commentId: number
Returns Promise<Response<BaseComment>>

deleteInBatch

deleteInBatch(target: <internal>.commentTargets, postCommentIds: number[]): Promise<Response<BaseComment[]>>

- Defined in admin-api/src/clients/CommentClient.ts:115
Parameters
- target: <internal>.commentTargets
- postCommentIds: number[]
Returns Promise<Response<BaseComment[]>>

get

get(target: <internal>.commentTargets, commentId: number): Promise<Response<PostCommentWithPost>>

- Defined in admin-api/src/clients/CommentClient.ts:65
Parameters
- target: <internal>.commentTargets
- commentId: number
Returns Promise<Response<PostCommentWithPost>>

latest

latest(target: <internal>.commentTargets, top: number, status: CommentStatus): Promise<Response<Page<PostCommentWithPost>>>

- Defined in admin-api/src/clients/CommentClient.ts:29
Parameters
- target: <internal>.commentTargets
- top: number
- status: CommentStatus
Returns Promise<Response<Page<PostCommentWithPost>>>

list

list(target: <internal>.commentTargets, params: CommentQuery): Promise<Response<Page<PostCommentWithPost>>>

- Defined in admin-api/src/clients/CommentClient.ts:22
Parameters
- target: <internal>.commentTargets
- params: CommentQuery
Returns Promise<Response<Page<PostCommentWithPost>>>

listAsTreeView

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

- Defined in admin-api/src/clients/CommentClient.ts:51
Parameters
- target: <internal>.commentTargets
- targetId: number
- params: { page?: number; sort?: string[] }
  - 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<BaseComment>>>

- Defined in admin-api/src/clients/CommentClient.ts:40
Parameters
- target: <internal>.commentTargets
- targetId: number
- params: { page: number; sort?: string[] }
  - page: number
  - Optional sort?: string[]
Returns Promise<Response<Page<BaseComment>>>

update

update(target: <internal>.commentTargets, commentId: number, params: BaseCommentParam): Promise<Response<BaseComment>>

- Defined in admin-api/src/clients/CommentClient.ts:79
Parameters
- target: <internal>.commentTargets
- commentId: number
- params: BaseCommentParam
Returns Promise<Response<BaseComment>>

updateStatusById

updateStatusById(target: <internal>.commentTargets, commentId: number, status: CommentStatus): Promise<Response<BaseComment>>

- Defined in admin-api/src/clients/CommentClient.ts:86
Parameters
- target: <internal>.commentTargets
- commentId: number
- status: CommentStatus
Returns Promise<Response<BaseComment>>

updateStatusInBatch

updateStatusInBatch(target: <internal>.commentTargets, commentIds: number[], status: CommentStatus): Promise<Response<BaseComment[]>>

- Defined in admin-api/src/clients/CommentClient.ts:97
Parameters
- target: <internal>.commentTargets
- commentIds: number[]
- status: CommentStatus
Returns Promise<Response<BaseComment[]>>

Generated using TypeDoc