Edit

Share via

PageAPI interface

  • Reference
Package:
@ms-fabric/workload-client

An interface representing page related APIs

Methods

open(OpenPageConfig)

Opens a page that loads the workload app

Method Details

open(OpenPageConfig)

Opens a page that loads the workload app

function open(config: OpenPageConfig): Promise<OpenUIResult>

Parameters

config
OpenPageConfig

The configuration of the page, including the name of the workload app providing the page UI, the route to locate the page UI in the workload app, etc.

Returns

Promise<OpenUIResult>

A promise which resolves when the page is opened. Note that if the page opening is denied due to failed navigation guard checks, a rejection statement will be returned.