Skip to content

gi-nx


gi-nx / updateWorkspaceDetails

ts
function updateWorkspaceDetails(this: RpcCallContext, patch: {
  properties?: WorkspacePropertyTree;
  settings?: Partial<SdkWorkspaceDetails["settings"]>;
}): Promise<SdkWorkspaceDetails>;

Parameters ​

ParameterTypeDescription
thisRpcCallContext-
patch.properties?WorkspacePropertyTree-
patch.settings?Partial<SdkWorkspaceDetails["settings"]>-

Returns ​

Promise<SdkWorkspaceDetails>

SdkWorkspaceDetails after the patch is applied, or undefined if no workspace is loaded.

Throws ​

Error if the patch is empty or if the resulting payload is too large. Only available to approved apps. Contact us for details.

Example ​

typescript
await rpc.invoke("updateWorkspaceDetails", [{
  settings: { accentColor: "#FF5733" }
}]);