Class JournalCommentClient

Hierarchy

JournalCommentClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new JournalCommentClient(client: HttpClient): JournalCommentClient

- Defined in admin-api/src/clients/JournalCommentClient.ts:16
Parameters
- client: HttpClient
Returns JournalCommentClient

Properties

Private client

client: HttpClient

Methods

create

create(params: BaseCommentParam): Promise<Response<BaseComment>>

- Defined in admin-api/src/clients/JournalCommentClient.ts:39
Creates a journal comment.

Parameters
- params: BaseCommentParam
  
  comment parameter for creates
Returns Promise<Response<BaseComment>>
A response of created journal comment.

delete

delete(commentId: number): Promise<Response<BaseComment>>

- Defined in admin-api/src/clients/JournalCommentClient.ts:52
Deletes a journal comment by id.

Parameters
- commentId: number
  
  journal comment id.
Returns Promise<Response<BaseComment>>
A response of deleted journal comment.

latest

latest(params: { status?: CommentStatus; top?: number }): Promise<Response<BaseComment[]>>

- Defined in admin-api/src/clients/JournalCommentClient.ts:113
Lists latest journal comments.

Parameters
- params: { status?: CommentStatus; top?: number }
  
  parameter for queries
  - Optional status?: CommentStatus
  - Optional top?: number
Returns Promise<Response<BaseComment[]>>
A response of latest journal comments.

list

list(params: JournalCommentQuery): Promise<Response<Page<JournalCommentWithJournal>>>

- Defined in admin-api/src/clients/JournalCommentClient.ts:26
Lists journal comments.

Parameters
- params: JournalCommentQuery
  
  parameter for queries
Returns Promise<Response<Page<JournalCommentWithJournal>>>
A page response of journals.

listAsTree

listAsTree(params: { journalId: number; page?: number; sort?: string[] }): Promise<Response<Page<BaseComment>>>

- Defined in admin-api/src/clients/JournalCommentClient.ts:96
Lists comment with tree view.

Parameters
- params: { journalId: number; page?: number; sort?: string[] }
  
  parameter for queries
  - journalId: number
  - Optional page?: number
  - Optional sort?: string[]
Returns Promise<Response<Page<BaseComment>>>
A page response of journal comments tree.

listAsView

listAsView(params: { journalId: number; page?: number; sort?: string[] }): Promise<Response<Page<BaseComment>>>

- Defined in admin-api/src/clients/JournalCommentClient.ts:79
Lists comment with list view.

Parameters
- params: { journalId: number; page?: number; sort?: string[] }
  
  parameter for queries
  - journalId: number
  - Optional page?: number
  - Optional sort?: string[]
Returns Promise<Response<Page<BaseComment>>>
A page response of journal comments.

update

update(commentId: number, status: CommentStatus): Promise<Response<BaseComment>>

- Defined in admin-api/src/clients/JournalCommentClient.ts:66
Updates journal comment status by id.

Parameters
- commentId: number
  
  journal comment id
- status: CommentStatus
  
  comment status
Returns Promise<Response<BaseComment>>
A response of updated journal comment.

Generated using TypeDoc