@smokeballdev/smokeball-client-sdkDocumentation Index
Fetch the complete documentation index at: https://docs.smokeball.com/llms.txt
Use this file to discover all available pages before exploring further.
Interface: Api
Entry point for files in Smokeball.Methods
add()
add(Adds a new file to the specified Matter. Returns upload details including upload URL.request):Promise<UploadMatterFileResponse>
Parameters
request
AddMatterFileRequest
Returns
Promise<UploadMatterFileResponse>
Example
download()
download(Returns download details including download URL for the specified files. Limit of 10 files per request.request):Promise<MatterFileDownloadDetails[]>
Parameters
request
DownloadMatterFilesRequest
Returns
Promise<MatterFileDownloadDetails[]>
Example
get()
get(Returns a file from the given Matter and File Id.request):Promise<FileDetails>
Parameters
request
GetMatterFileRequest
Returns
Promise<FileDetails>
Example
getMany()
getMany(Returns a page of files from the given Matter and Folder.request):Promise<GetMatterFilesResponse>
Parameters
request
GetMatterFilesRequest
Returns
Promise<GetMatterFilesResponse>
Example
open()
open(Opens the specified file in the native app.request):void
Parameters
request
FileRequest
Returns
void
Example
select()
select(Opens a file picker to select files from a matter. Returns the selected files.request):Promise<File[]>
Parameters
request
SelectFilesRequest
Returns
Promise<File[]>
Example
selectItems()
selectItems(Opens a file and/or folder picker to select files and folders from a matter. Folders can be selected in addition to files if the allowFolderSelection flag is set to true in the request. If allowFolderSelection is false or unset, only files can be selected and the picker will function the same as the select method. Returns the selected files and folders.request):Promise<SelectItemsResponse>
Parameters
request
SelectItemsRequest
Returns
Promise<SelectItemsResponse>
Example
update()
update(Updates an existing file in the specified Matter. Returns upload details including upload URL.request):Promise<UploadMatterFileResponse>
Parameters
request
UpdateMatterFileRequest
Returns
Promise<UploadMatterFileResponse>