Class AttachmentClient

Hierarchy

AttachmentClient

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new AttachmentClient(client: HttpClient): AttachmentClient

- Defined in admin-api/src/clients/AttachmentClient.ts:8
Parameters
- client: HttpClient
Returns AttachmentClient

Properties

Private client

client: HttpClient

Methods

delete

delete(attachmentId: number): Promise<Response<Attachment[]>>

- Defined in admin-api/src/clients/AttachmentClient.ts:57
Delete attachment permanently by attachment id.

Parameters
- attachmentId: number
  
  attachment id
Returns Promise<Response<Attachment[]>>
Returns attachment detail of deleted

deleteInBatch

deleteInBatch(attachmentIds: number[]): Promise<Response<Attachment[]>>

- Defined in admin-api/src/clients/AttachmentClient.ts:44
Batch delete attachment permanently by attachment ids.

Parameters
- attachmentIds: number[]
  
  a collection of attachment id
Returns Promise<Response<Attachment[]>>
Returns attachments of deleted

get

get(attachmentId: number): Promise<Response<Attachment>>

- Defined in admin-api/src/clients/AttachmentClient.ts:18
Gets attachment detail by id.

Parameters
- attachmentId: number
  
  attachment id
Returns Promise<Response<Attachment>>
Returns attachment detail response.

list

list(params: AttachmentQuery): Promise<Response<Page<Attachment>>>

- Defined in admin-api/src/clients/AttachmentClient.ts:31
Page query attachment list.

Parameters
- params: AttachmentQuery
  
  attachment query parameter
Returns Promise<Response<Page<Attachment>>>
Returns attachment page response.

listMediaTypes

listMediaTypes(): Promise<Response<string[]>>

- Defined in admin-api/src/clients/AttachmentClient.ts:83
List all of attachment media types.

Returns Promise<Response<string[]>>
Returns attachment media types response.

listTypes

listTypes(): Promise<Response<string[]>>

- Defined in admin-api/src/clients/AttachmentClient.ts:95
List all of attachment types.

Returns Promise<Response<string[]>>
Returns a response of attachment types.

update

update(attachmentId: number, name: string): Promise<Response<Attachment>>

- Defined in admin-api/src/clients/AttachmentClient.ts:71
Update attachment name by id.

Parameters
- attachmentId: number
  
  attachment id
- name: string
  
  a new attachment name
Returns Promise<Response<Attachment>>
Returns an updated attachment response.

upload

upload(data: unknown, options?: UploadOptions): Promise<Response<Attachment>>

- Defined in admin-api/src/clients/AttachmentClient.ts:109
Upload a single attachment file.

Parameters
- data: unknown
  
  attachment file object.
- Optional options: UploadOptions
  
  other upload options.
Returns Promise<Response<Attachment>>
Returns a response of uploaded attachment

uploadInBatch

uploadInBatch(data: unknown[], options?: UploadOptions): Promise<Response<Attachment[]>>

- Defined in admin-api/src/clients/AttachmentClient.ts:125
Batch upload attachments.

Parameters
- data: unknown[]
  
  attachment file object.
- Optional options: UploadOptions
  
  other upload options.
Returns Promise<Response<Attachment[]>>
Returns a response of uploaded attachments.

Generated using TypeDoc