startApplication


Purpose

Starts an application that has been identified by means of an application ID or application's URL address.

The method may be called only if the application is in "ready", "starting" or "started" state.

  • Calling it when the app is in the "ready" state will result in changing the state to "starting". The application's URL will then be loaded in the background. The app will be shown to the user when the loading finishes. At this point the "onShow" callback will be called and the state will change to "started".

  • Calling it when the app is in the "starting" state will have no effect.

  • Calling it when the app is in "started" state will bring the app to front.

Note

The option to show or hide an application during its start is only supported under Android and iOS.

Signature

startApplication( application, show )

Returns

This method does not return anything.

Parameter

Name Description Type Use
application The application's ID or URL address. string required
show Specifies whether the application should show when it is started. The default value is 'true' which means it will display on the screen. A value of 'false' means that the application will start but will not be shown. This option is only supported under Android and iOS. boolean optional

Related topics

Public API reference
ApplicationManager
Legal notice | Copyright © 2016 and Confidential to Pegasystems Inc. All rights reserved
PDN | Hybrid Container | Feedback
Advanced...