FileReadApi API
The fileReadApi module of the @codebolt/plugin-sdk.
import plugin from '@codebolt/plugin-sdk';
Quick Reference
| Method | Description |
|---|---|
allFiles | |
autocomplete | |
autocompleteFolders | |
autocompleteForSearch | |
read | |
search |
Methods
allFiles
plugin.fileReadApi.allFiles(params?: FileSearchParams): Promise<FileSearchResult[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
params | FileSearchParams | No |
Returns: Promise<FileSearchResult[]>
autocomplete
plugin.fileReadApi.autocomplete(params?: FileAutocompleteParams): Promise<FileAutocompleteResult[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
params | FileAutocompleteParams | No |
Returns: Promise<FileAutocompleteResult[]>
autocompleteFolders
plugin.fileReadApi.autocompleteFolders(params?: FileAutocompleteParams): Promise<FileAutocompleteResult[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
params | FileAutocompleteParams | No |
Returns: Promise<FileAutocompleteResult[]>
autocompleteForSearch
plugin.fileReadApi.autocompleteForSearch(params?: FileSearchParams): Promise<FileAutocompleteResult[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
params | FileSearchParams | No |
Returns: Promise<FileAutocompleteResult[]>
read
plugin.fileReadApi.read(params?: FileReadParams): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
params | FileReadParams | No |
Returns: Promise<unknown>
search
plugin.fileReadApi.search(params?: FileSearchParams): Promise<FileSearchResult[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
params | FileSearchParams | No |
Returns: Promise<FileSearchResult[]>