Skip to content

BusinessAppMethods

Experimental

Methods attached to each business app returned by the service.

Warning

Preview: These methods are experimental and may change or be removed in future releases.

Methods

delete()

delete(): Promise<void>

Experimental

Deletes this business app.

Returns

Promise<void>


update()

update(name: string, processKeys: string[], options?: BusinessAppUpdateOptions): Promise<BusinessAppGetResponse>

Experimental

Replaces this business app. A full replace — an omitted description, icon or color is cleared.

Parameters

Parameter Type Description
name string New display name, unique within the tenant
processKeys string[] The full set of Orchestrator process (release) keys the app surfaces
options? BusinessAppUpdateOptions Optional description, icon and color; omitting one clears it

Returns

Promise<BusinessAppGetResponse>

The app as stored after the write, as a BusinessAppGetResponse