Skip to content

UI builder - Studio API

Profiles

To execute Profile APIs, take a look at the examples below:

Api.profile.takeIn("My PageID");
Api.profile('My Profile').takeIn(...);
Api.profile('My Profile', 'My Channel').takeIn(...);
Api.profile('My Profile').channel('My Channel').takeIn(...);

takeIn

Take IN a Page by providing the PageID as parameter

Api.profile.takeIn(pageID?: string | number): void;
Parameter Type Description
pageID string/number The Page ID of the Page to take IN

takeOut

Take OUT a Page by providing the PageID as parameter

Api.profile.takeOut(pageID?: string | number): void;
Parameter Type Description
pageID string/number The Page ID of the Page to take OUT

update

Updates the Page specified in the parameter

Api.profile.update(page?: string | number): void;
Parameter Type Description
pageID string/number The Page ID of the Page to Update

continue

Continues the graphic of the Page specified in the parameter

Api.profile.continue(page?: string | number): void;
Parameter Type Description
pageID string/number The Page ID of the Page to Continue

trigger

Triggers an Action in the Page specified in the parameter

Api.profile.trigger(action: string, page?: string | number): void;
Parameter Type Description
action string The Action to be triggered
pageID string/number The Page ID of the Page where the action is to be triggered

previewIn

Preview IN a Page by providing the PageID as parameter

Api.profile.previewIn(page?: string | number): void;
Parameter Type Description
pageID string/number The Page ID of the Page to Preview IN

previewOut

Preview OUT a Page by providing the PageID as parameter

Api.profile.previewOut(page?: string | number): void;
Parameter Type Description
pageID string/number The Page ID of the Page to Preview OUT

previewUpdate

Updates the preview of the Page specified in the parameter

Api.profile.previewUpdate(page?: string | number): void; 
Parameter Type Description
pageID string/number The Page ID of the Page Update

previewContinue

Continues the graphic of the Preview Page specified in the parameter

Api.profile.previewContinue(page?: string | number): void;
Parameter Type Description
pageID string/number The Page ID of the Page to Continue

previewTrigger

Triggers an Action in the Preview Page specified in the parameter

Api.profile.previewTrigger(action: string, page?: string | number): void;
Parameter Type Description
action string The Action to be triggered
pageID string/number The Page ID of the Page to Trigger

sendCommand

Sends Command to the System provided in the parameter

Api.profile.sendCommand(system: string, command: object | string): void;
Parameter Type Description
system string The System where the command is to be sent
command object/string The command to be sent to the system

clear

Clears the Layer provided in the Parameter

Api.profile.clear(layer?: string): void;
Parameter Type Description
layer string The layer to be cleared

cleanUp

Cleans up the Engine currently in use

Api.profile.cleanup(): void;

cache

Cache the Asset/Assets in the path

Api.profile.cache(asset: string): void;
Parameter Type Description
asset string/string[ ] The Asset/Assets to be cached