Skip to main content
Version: 1.x

Interface: BTPWorkZoneManager

Manager for BTP WorkZone dual-frame environments.

Example​

const manager: BTPWorkZoneManager = createWorkZoneManager(page, adapter);
const isWZ = await manager.detect();

Methods​

detect()​

detect(): Promise<boolean>

Detects whether the current page is a WorkZone environment.

Returns​

Promise<boolean>

enableDualBridge()​

enableDualBridge(): Promise<void>

Injects bridge in both shell and app frames.

Returns​

Promise<void>

getAppFrameForEval()​

getAppFrameForEval(): WorkZoneFrame

Returns a Frame for script execution (evaluate) in the app iframe.

Returns​

WorkZoneFrame

getCurrentApp()​

getCurrentApp(): Promise<string | null>

Gets the current app semantic object string, or null.

Returns​

Promise<string | null>

isAppReady()​

isAppReady(timeout?): Promise<boolean>

Checks if the app in the iframe is ready (UI5 stable).

Parameters​

timeout?​

number

Returns​

Promise<boolean>

navigateToApp(appId): Promise<void>

Navigates to an app within the WorkZone shell.

Parameters​

appId​

string

Returns​

Promise<void>

switchToApp()​

switchToApp(): WorkZoneFrameLocator

Returns a FrameLocator for element interactions in the app iframe.

Returns​

WorkZoneFrameLocator

switchToShell()​

switchToShell(): WorkZonePage

Returns the Page reference for shell-frame interactions.

Returns​

WorkZonePage