Class FileStorageClient

Hierarchy (View Summary)

QbraidClient
- FileStorageClient

Index

Constructors

Properties

Methods

downloadFile getUser runningInLab uploadFile

Constructors

constructor

new FileStorageClient(session?: QbraidSession): FileStorageClient
Parameters
- Optionalsession: QbraidSession
Returns FileStorageClient
Overrides QbraidClient.constructor
- Defined in storage/src/client.ts:12

Properties

`Protected`session

session: QbraidSession

The QbraidSession instance used by this client.

Methods

downloadFile

downloadFile(
namespace: string,
objectPath: string,
): Promise<DownloadFileResponse>
Parameters
- namespace: string
- objectPath: string
Returns Promise<DownloadFileResponse>
- Defined in storage/src/client.ts:16

getUser

getUser(): Promise<QbraidUser>
Returns Promise<QbraidUser>
Inherited from QbraidClient.getUser
- Defined in base/dist/src/client.d.ts:9

runningInLab

runningInLab(): Promise<boolean>
Returns Promise<boolean>
Inherited from QbraidClient.runningInLab
- Defined in base/dist/src/client.d.ts:10

uploadFile

uploadFile(
    filePath: string,
    namespace: string,
    objectPath: string,
    overwrite?: boolean,
): Promise<UploadFileResponse>
Parameters
- filePath: string
- namespace: string
- objectPath: string
- overwrite: boolean = false
Returns Promise<UploadFileResponse>
- Defined in storage/src/client.ts:31