Interface IExternalStorageConnection

The interface for the external storage connection.

interface IExternalStorageConnection {
    close(): void;
    get(path: string): Promise<IFile>;
    getName(): string;
    getOwnerId(): string;
    list(path: string, options?: IExternalStorageListOptions): Promise<ObjectDescriptor[]>;
    subscribe(label: string, callback: ((data: StorageEvent) => void)): void;
    unsubscribe(label: string): void;
}

Hierarchy (view full)

IDataStream
- IExternalStorageConnection

Index

Methods

close get getName getOwnerId list subscribe unsubscribe

Methods

close

close(): void
Close the database.

Returns void

get

get(path): Promise<IFile>
Get an object from the bucket.
Parameters
- path: string
  The path of the object.
Returns Promise<IFile>
The object.

getName

getName(): string
Get the name of the database.

Returns string
Overrides IDataStream.getName

getOwnerId

getOwnerId(): string
Get the owner ID of the database.

Returns string
Overrides IDataStream.getOwnerId

list

list(path, options?): Promise<ObjectDescriptor[]>
List the objects and folders of the bucket.
Parameters
- path: string
  The path of the folder.
- Optionaloptions: IExternalStorageListOptions
  The optional options for listing the objects and folders.
Returns Promise<ObjectDescriptor[]>
The list of objects and folders.

subscribe

subscribe(label, callback): void
Subscribe to the bucket events.
Parameters
- label: string
  The label of the subscriber.
- callback: ((data: StorageEvent) => void)
  The callback function.
  - - (data): void
    - Parameters
      data: StorageEvent
      Returns void
Returns void

unsubscribe

unsubscribe(label): void
Unsubscribe from the bucket.
Parameters
- label: string
  The label of the subscriber.
Returns void