Open URL


Purpose

The Open URL API enables the Hybrid Container to open specific URLs on a device and react to them. It is possible to invoke URLs directly from one app to trigger another app to automatically launch in the foreground. By calling the API's methods, you can pass authentication information and metadata between apps. Metadata can be used to perform a desired action in the target app. A URL address can also be presented on a web page, delivered in an e-mail, or in an instant message.

To access the OpenURL object, use the window.launchbox.Container.OpenURL reference.

Module

This object belongs to the Base product module.

Methods

Name Description Return type
canOpen

This method verifies whether a given URL scheme can be opened in any native app installed on the device.

promise
open

This method opens a native app installed on the device, using a registered URL scheme.

promise
onOpenURL

This is an observer event. Add it to the onLaunchboxLoaded method. When an associated custom URL opens, the Hybrid Container starts, and the onOpenURL event executes right after the onLaunchboxLoaded method.

undefined

Related topics

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