FileApi API
The fileApi module of the @codebolt/plugin-sdk.
import plugin from '@codebolt/plugin-sdk';
Quick Reference
| Method | Description |
|---|---|
addFile | |
checkFileExists | |
deleteZip | |
zipFile |
Methods
addFile
plugin.fileApi.addFile(data: AddFileRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | AddFileRequest | Yes |
Returns: Promise<unknown>
checkFileExists
plugin.fileApi.checkFileExists(data: CheckFileExistsRequest): Promise<CheckFileExistsResponse>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | CheckFileExistsRequest | Yes |
Returns: Promise<CheckFileExistsResponse>
deleteZip
plugin.fileApi.deleteZip(data: DeleteZipRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | DeleteZipRequest | Yes |
Returns: Promise<unknown>
zipFile
plugin.fileApi.zipFile(data: ZipFileRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | ZipFileRequest | Yes |
Returns: Promise<unknown>