Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParentApi

Hierarchy

  • ParentApi

Index

Properties

Optional getConfig

getConfig: function

Get the current parent config.

Type declaration

Optional hideBusyIndicator

hideBusyIndicator: function

Is called by an application when it needs to hide the busy indicator to indicate the user can interact with the application again For each call to the application should make a @{link {ParentApi.showBusyIndicator}} call.

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

Optional hideMask

hideMask: function

Is called by an application when it needs to hide said mask again.

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

Optional navigate

navigate: function

Is called by an application to perform internal or cross-app navigation. It does trigger the nav-app to perform a ‘beforeNavigate’ and ‘navigate’ to route to the provided location. *Do not set locations to other applications for navigation *

param

The NavLocation navigated to

Type declaration

Optional onError

onError: function

Pass on an error that occurred on the client side.

param

object containing info about the error

Type declaration

    • Parameters

      Returns void | Promise<void>

Optional onSessionExpired

onSessionExpired: function

Is called by an application when it detects that it's internal session has expired.

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

Optional onUserActivity

onUserActivity: function

Is called by an active application when a user makes some actions. Nav-app can propagate this calls to other applications to prevent session expiration.

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

Optional showBusyIndicator

showBusyIndicator: function

Is called by an application when it needs to show the busy indicator to indicate the user has to wait until the application has changed its ui state. For each call to the application should make a @{link {ParentApi.hideBusyIndicator}} call.

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

Optional showMask

showMask: function

Is called by an application when it needs to cover the nav-app’s UI surface with a mask to prevent user interactions for example because the user input is needed for a dialog.

Type declaration

    • (): void | Promise<void>
    • Returns void | Promise<void>

Optional updateNavLocation

updateNavLocation: function

Is called by an application when the application performs internal navigation. updateNavLocation does not trigger a subsequent navigate callback. Also, upon navigating to a new state (see navigate callback above), an application may use this method to make sure the browser URL and breadcrumbs label maintained by the nav-app are set appropriately. These parameters may depend on application-internal state.

param

the NavLocation navigated to

Type declaration