Class ChRISFileBrowser

Class for browsing ChRIS filesystem objects.

Index

Constructors

Accessors

bindOp_get fileBrowserFolder_get resource_get

Methods

client_get dirs_bind files_bind links_bind method_bind

Constructors

constructor

new ChRISFileBrowser(
variant?: BrowserType,
chrisObj: FileBrowserFolder,
): ChRISFileBrowser
Parameters
- variant: BrowserType = BrowserType.Files
- chrisObj: FileBrowserFolder
Returns ChRISFileBrowser
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:40

Accessors

bindOp_get

get bindOp_get(): BoolString
Gets the status of the binding operation.

Returns BoolString
The binding operation status.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:61

fileBrowserFolder_get

get fileBrowserFolder_get(): FileBrowserFolder | null
Gets the underlying FileBrowserFolder object.

Returns FileBrowserFolder | null
The FileBrowserFolder instance or null.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:157

resource_get

get resource_get(): ChRISResource | null
Gets the associated ChRIS resource.

Returns ChRISResource | null
The ChRISResource instance or null.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:149

Methods

client_get

client_get(): Promise<Client | null>
Retrieves the ChRIS client instance asynchronously.

Returns Promise<Client | null>
A Promise resolving to the Client instance or null.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:50

dirs_bind

dirs_bind(): BoolString
Binds the getChildren (dirs) method to the ChRIS resource.

Returns BoolString
The status of the binding operation.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:105

files_bind

files_bind(): BoolString
Binds the getFiles method to the ChRIS resource.

Returns BoolString
The status of the binding operation.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:69

links_bind

links_bind(): BoolString
Binds the getLinkFiles method to the ChRIS resource.

Returns BoolString
The status of the binding operation.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:87

method_bind

method_bind(variant: BrowserType): BoolString
Binds the appropriate method based on the browser variant.
Parameters
- variant: BrowserType
  The browser type (Files, Links, Dirs).
Returns BoolString
The status of the binding operation.
- Defined in packages/cumin/src/filebrowser/chrisFileBrowser.ts:124