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 results in changing the state to "starting". The application's URL is then loaded in the background. The app is shown to the user when the loading finishes. At this point the onShow callback is called and the state changes to "started".

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

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

Calling it when the app is in the "ready" state results in changing the state to "starting":

  • If the application has not been installed or is not up-to-date, it is installed or updated respectively.

  • If the application is installed and up-to-date, the application's URL is loaded in the background. The app is shown to the user when the loading finishes. At this point the onShow callback is called and the state changes to "started".

  • If any of the operations fails, the aplication chages its state to "failed".

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 displays on the screen. A value of "false" means that the application starts but is not shown. This option is only supported under Android and iOS. boolean optional

Related topics

Public API reference
ApplicationManager
Legal notice | Copyright © 2019 and Confidential to Pegasystems Inc. All rights reserved
Pega Community | Feedback
Advanced...