StorageServiceClientI
Api Code Documentation / Exports / service/Client_storage_service.h / StorageServiceClientI
service/Client_storage_service.h.StorageServiceClientI
Implemented by
Table of contents
Methods
Methods
deleteObject
▸ deleteObject(id
, secret
): Promise
<Type
<DeleteResponse
>>
Parameters
Name | Type |
---|---|
id | string |
secret | string |
Returns
Promise
<Type
<DeleteResponse
>>
Defined in
src/service/Client_storage_service.h.ts:61
downloadObject
▸ downloadObject(id
, secret
): Promise
<Type
<StorageObject
>>
Download an object using the matching secret
Parameters
Name | Type | Description |
---|---|---|
id | string | id of object stored |
secret | string | secret to access the object's data |
Returns
Promise
<Type
<StorageObject
>>
Defined in
src/service/Client_storage_service.h.ts:60
getVersion
▸ getVersion(): Promise
<Version
>
Get version of conncted storage service
Returns
Promise
<Version
>
Defined in
src/service/Client_storage_service.h.ts:38
isReady
▸ isReady(): Promise
<boolean
>
Get readiness sattus of storage service
Returns
Promise
<boolean
>
Defined in
src/service/Client_storage_service.h.ts:33
uploadObject
▸ uploadObject(file
): Promise
<Type
<UploadResponse
>>
Upload an object using the
Parameters
Name | Type | Description |
---|---|---|
file | File | File object containing id, fileName, documentBase64, and an optional comment. |
Returns
Promise
<Type
<UploadResponse
>>
- A promise that resolves to the upload response.