default

Api Code Documentation / Exports / service/Client_storage_service / default

service/Client_storage_service.default

Implements

• StorageServiceClientI

Table of contents

Constructors

• constructor

Properties

• axiosInstance
• timeStamp

Methods

• deleteObject
• downloadObject
• getAxiosInstance
• getVersion
• isReady
• uploadObject

Constructors

constructor

• new default(settings)

Parameters

Name	Type
settings	AxiosRequestConfig<any>

Defined in

src/service/Client_storage_service.ts:31

Properties

axiosInstance

• Private axiosInstance: AxiosInstance

Defined in

src/service/Client_storage_service.ts:27

---

timeStamp

• Private timeStamp: number = 0

Defined in

src/service/Client_storage_service.ts:29

Methods

deleteObject

▸ deleteObject(id, secret): Promise<Type<DeleteResponse>>

Parameters

Name	Type
id	string
secret	string

Returns

Promise<Type<DeleteResponse>>

Implementation of

StorageServiceClientI.deleteObject

Defined in

src/service/Client_storage_service.ts:143

---

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>>

Implementation of

StorageServiceClientI.downloadObject

Defined in

src/service/Client_storage_service.ts:101

---

getAxiosInstance

▸ getAxiosInstance(): AxiosInstance

Returns

AxiosInstance

Defined in

src/service/Client_storage_service.ts:166

---

getVersion

▸ getVersion(): Promise<Version>

Get version of conncted storage service

Returns

Promise<Version>

Implementation of

StorageServiceClientI.getVersion

Defined in

src/service/Client_storage_service.ts:60

---

isReady

▸ isReady(): Promise<boolean>

Get readiness sattus of storage service

Returns

Promise<boolean>

Implementation of

StorageServiceClientI.isReady

Defined in

src/service/Client_storage_service.ts:55

---

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.

Implementation of

StorageServiceClientI.uploadObject

Defined in

src/service/Client_storage_service.ts:74