LensStudio:Workspaces.PresetHandle
ClassOpaque handle returned by IWorkspaceManager.register() for an installed workspace preset.
Opaque handle returned by IWorkspaceManager.register() for an installed workspace preset. Pass it to unregister() to remove the preset; the preset is also removed when the handle is released, so keep a reference while the preset should stay installed.
Example
Track the presets a plugin installs so it can remove them later, for example in stop(). Keep each PresetHandle referenced: releasing a handle also removes its preset.
import { IWorkspaceManager, PresetHandle } from 'LensStudio:Workspaces';
export class InstalledPresets {
manager: IWorkspaceManager;
handles: PresetHandle[];
constructor(manager: IWorkspaceManager) {
this.manager = manager;
this.handles = [];
}
// Returns false when the folder is not a preset or the preset is already installed.
install(presetFolder: Editor.Path): boolean {
const descriptor = this.manager.readDescriptor(presetFolder);
if (!descriptor || this.manager.isRegistered(descriptor)) return false;
this.handles.push(this.manager.register(descriptor));
return true;
}
removeAll(): void {
for (const handle of this.handles) this.manager.unregister(handle);
this.handles = [];
}
}
Use readDescriptor() with the filesystem permission in module.json.