@smokeballdev/smokeball-client-sdk

​
Interface: Api

Entry point for files in Smokeball.

​
Methods

​
download()

download(request): Promise<MatterFileDownloadDetails[]>
Returns download details including download URL for the specified files. Limit of 10 files per request.

​
Parameters

request
DownloadMatterFilesRequest

​
Returns

Promise<MatterFileDownloadDetails[]>

​
Example

const downloadUrls = await sdk.files.download({
  files: [
    {
      matterId: matterId,
      id: fileId
    }
  ]
});

​
getMany()

getMany(request): Promise<GetMatterFilesResponse>
Returns a page of files from the given Matter and Folder.

​
Parameters

request
GetMatterFilesRequest

​
Returns

Promise<GetMatterFilesResponse>

​
Example

const request: GetMatterFilesRequest = {
 matterId: '410f2b2b-7adf-436e-a5fd-dab1733d3fba',
 // The folder id can be left empty and will default to the root directory.
 folderId: '410f2b2b-7adf-436e-a5fd-dab1733d3fbb',
 limit: 10,
 offset: 0
}
const files = sdk.files.getMany(request);

​
open()

open(request): void
Opens the specified file in the native app.

​
Parameters

request
FileRequest

​
Returns

void

​
Example

const request: FileRequest = {
 id: 'da06e491-3a68-4da1-be1c-7e734491bbe6',
 versionId: '410f2b2b-7adf-436e-a5fd-dab1733d3fba'
}
sdk.files.open(request);

​
select()

select(request): Promise<File[]>
Opens a file picker to select files from a matter. Returns the selected files.

​
Parameters

request
SelectFilesRequest

​
Returns

Promise<File[]>

​
Example

const request: SelectFilesRequest = {
 confirmationText: 'SELECT',
 fileSelectionLimit: 2,
 showEmails: false,
}
sdk.files.select(request);