Public API reference


The Hybrid Container public API for the bootstrap application consists of a number of interfaces and relevant methods that make it possible to prepare applications for launching and manage their status. The API is available to web applications as well. For a detailed description of individual objects and methods please follow the links below. The articles in this reference have been organized by functionality, therefore, in order to find individual objects and methods, you need to drill down the links.

Note

Public objects in the SQL storage API and File API can be accessed directly, using the window.object_name reference.

All the other objects in these APIs can be accessed using the window.launchbox.object_name reference.

Caution

You need to create the onLaunchboxLoaded method of the browser's window object (where you place the entry point to your application) before you can use any of the following APIs:

  • window.launchbox.object_name objects

  • objects that belong to the following APIs, which are based on standard W3C APIs: Encrypted SQL, Filesystem and Geolocation

  • objects you added to the window instance, i.e. window.object_name objects

  • legacy APIs

The method is called by the Hybrid Container when it loads all JavaScript/native code and web apps are allowed to call all their APIs.

Core functionality APIs

Hybrid Container API includes a number of core functionality APIs. Some of them allow developers to create applications that cooperate with existing functionalities of end-user devices, such as the contact database or a native file system, while others enable creating SQL databases, encryption, network connectivity, in-app browsing, application localization, etc.

A detailed description of core functionality APIs can be found in the next article.

Special functionality groups

Hybrid Container API set encompasses three groups of APIs that play a special role. Follow the links below for details:

Name Description
Management APIs These APIs allow to manage and monitor the lifecycle of both Hybrid Container and web applications, as well as manage user accounts.
Multi-application mode APIs These APIs allow developers to create solutions that utilize multiple web applications, which can be switched and can communicate with each other.
Pega 7 integration APIs These APIs allow developers to integrate the client with the Pega 7 capability.
Legal notice | Copyright © 2017 and Confidential to Pegasystems Inc. All rights reserved
PDN | Feedback
Advanced...