NavigateToWorkspaceObject
Description
Navigate to the workspace view of the given object.
NOTE: Stability is experimental. Non-backward compatible changes or removal may occur in any future release. Use of this feature is not recommended for production environments.
Syntax
// shellFrame points to instance of IShellFrame
const result = await shellFrame.NavigateToWorkspaceObject(objId, newWindow);
Parameters
| Name | Optionality | Type | Description |
|---|---|---|---|
| objId | Required | ObjID | The object whose workspace is to be opened. |
| newWindow | Required | boolean | Flag to indicate if the navigation should happen in new window/tab. |
Return type
| Type | Description |
|---|---|
Promise < void > | Resolves once dashboard cleanup (when navigating in the current window) has completed and navigation has been triggered. |
Exceptions
ArgumentError - When objId is null or undefined. Thrown synchronously, before any dashboard cleanup or navigation is attempted.
Error - When objId lacks a valid object type/internal ID, workspace personalization is not supported in the current vault, or the object's type is not a real object type. Rejects the returned promise rather than throwing synchronously.