Class FilesAPI`Beta`

High-level files/blob storage API.

Index

Constructors

Methods

delete download getMetadata getUrl list replace subscribePath updateMetadata upload

Constructors

constructor

new FilesAPI(api: API): FilesAPI
Beta
Parameters
- api: API
Returns FilesAPI
- Defined in sdk/src/api/files.ts:19

Methods

delete

delete(fileId: string): Promise<BazaarMessage>
Beta
Delete a file.
Parameters
- fileId: string
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/files.ts:92

download

download(fileId: string, options?: { onProgress?: OnProgress }): Promise<Blob>
Beta
Download a file's binary content.
Parameters
- fileId: string
- Optionaloptions: { onProgress?: OnProgress }
Returns Promise<Blob>
- Defined in sdk/src/api/files.ts:48

getMetadata

getMetadata(fileId: string): Promise<BazaarFile | null>
Beta
Get file metadata by ID.
Parameters
- fileId: string
Returns Promise<BazaarFile | null>
- Defined in sdk/src/api/files.ts:56

getUrl

getUrl(fileId: string, options?: { expiresIn?: number }): Promise<string>
Beta
Get a URL for a file, for <img src>, <video src> and links, on the server holding it. Good for this user and app, for this file only, and only as long as they may read it.
Parameters
- fileId: string
- Optionaloptions: { expiresIn?: number }
  expiresIn: seconds it's good for, at least (default 1 hour, at most 24). Repeat calls give the same URL for a while.
Returns Promise<string>
- Defined in sdk/src/api/files.ts:68

list

list(options?: FileListOptions): Promise<FileListResult>
Beta
List files and directories.
Parameters
- Optionaloptions: FileListOptions
Returns Promise<FileListResult>
- Defined in sdk/src/api/files.ts:86

replace

replace(
    fileId: string,
    file: File | Blob,
    options?: { onProgress?: OnProgress },
): Promise<BazaarFile>
Beta
Replace the binary content of an existing file.
Parameters
- fileId: string
- file: File | Blob
- Optionaloptions: { onProgress?: OnProgress }
Returns Promise<BazaarFile>
- Defined in sdk/src/api/files.ts:38

subscribePath

subscribePath(
options: FileListOptions,
listener: SubscribeListener<BazaarFile>,
): Promise<() => Promise<string>>
Beta
Subscribe to file changes in a path.
Parameters
- options: FileListOptions
- listener: SubscribeListener<BazaarFile>
Returns Promise<() => Promise<string>>
- Defined in sdk/src/api/files.ts:97

updateMetadata

updateMetadata(fileId: string, metadata: FileMetadata): Promise<BazaarFile>
Beta
Replace a file's custom metadata.
Parameters
- fileId: string
- metadata: FileMetadata
Returns Promise<BazaarFile>
- Defined in sdk/src/api/files.ts:77

upload

upload(
    file: File | Blob,
    options?: {
        filename?: string;
        metadata?: FileMetadata;
        onProgress?: OnProgress;
        path?: string;
    },
): Promise<BazaarFile>
Beta
Upload a new file.
Parameters
- file: File | Blob
- Optionaloptions: {
      filename?: string;
      metadata?: FileMetadata;
      onProgress?: OnProgress;
      path?: string;
  }
Returns Promise<BazaarFile>
- Defined in sdk/src/api/files.ts:24