Class SheetCommentClient

Hierarchy

SheetCommentClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new SheetCommentClient(client: HttpClient): SheetCommentClient

- Defined in admin-api/src/clients/SheetCommentClient.ts:17
Parameters
- client: HttpClient
Returns SheetCommentClient

Properties

Private client

client: HttpClient

Methods

create

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

- Defined in admin-api/src/clients/SheetCommentClient.ts:64
Parameters
- params: BaseCommentParam
Returns Promise<Response<BaseComment>>

delete

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

- Defined in admin-api/src/clients/SheetCommentClient.ts:99
Parameters
- commentId: number
Returns Promise<Response<BaseComment>>

deleteInBatch

deleteInBatch(commentIds: number[]): Promise<Response<BaseComment[]>>

- Defined in admin-api/src/clients/SheetCommentClient.ts:92
Parameters
- commentIds: number[]
Returns Promise<Response<BaseComment[]>>

get

get(commentId: number): Promise<Response<SheetCommentWithSheet>>

- Defined in admin-api/src/clients/SheetCommentClient.ts:28
Parameters
- commentId: number
Returns Promise<Response<SheetCommentWithSheet>>

latest

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

- Defined in admin-api/src/clients/SheetCommentClient.ts:57
Parameters
- params: { status?: CommentStatus; top?: number }
  - Optional status?: CommentStatus
  - Optional top?: number
Returns Promise<Response<SheetCommentWithSheet[]>>

list

list(params: CommentQuery): Promise<Response<Page<SheetCommentWithSheet>>>

- Defined in admin-api/src/clients/SheetCommentClient.ts:21
Parameters
- params: CommentQuery
Returns Promise<Response<Page<SheetCommentWithSheet>>>

listAsTreeView

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

- Defined in admin-api/src/clients/SheetCommentClient.ts:46
Parameters
- params: { page?: number; sheetId: number; sort?: string[] }
  - Optional page?: number
  - sheetId: number
  - Optional sort?: string[]
Returns Promise<Response<Page<BaseComment>>>

listAsView

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

- Defined in admin-api/src/clients/SheetCommentClient.ts:35
Parameters
- params: { page?: number; sheetId: number; sort?: string[] }
  - Optional page?: number
  - sheetId: number
  - Optional sort?: string[]
Returns Promise<Response<Page<BaseCommentWithParent>>>

update

update(commentId: number, params: BaseCommentParam): Promise<Response<BaseComment>>

- Defined in admin-api/src/clients/SheetCommentClient.ts:71
Parameters
- commentId: number
- params: BaseCommentParam
Returns Promise<Response<BaseComment>>

updateStatusById

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

- Defined in admin-api/src/clients/SheetCommentClient.ts:78
Parameters
- commentId: number
- status: CommentStatus
Returns Promise<Response<BaseComment>>

updateStatusInBatch

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

- Defined in admin-api/src/clients/SheetCommentClient.ts:85
Parameters
- commentIds: number[]
- status: CommentStatus
Returns Promise<Response<BaseComment>>

Generated using TypeDoc