networkStatus


Purpose

The object provides information about the state of the network connection. It is updated automatically as the value changes on the device. The object's value is cached by the JavaScript.

You can access the object by using the launchbox.Container.networkStatus reference.

Module

This object and its methods belong to the Base product module.

Note

To use the Container API's network-related features, the Network Status module must be included at application building stage.

Property

Name Description
type The type of the connection available. The property can take one of the following values: wifi, 2G, 3G, 4G, none, unknown. If there is no connection present, it will take the value of "none". If the connection is unknown, it will take the value of "unknown".The property can take one of the following values: none, other. If there is no connection present, it will take the value of "none", otherwise it will take the value of "other".

Note

On iOS, the public API does not return a specific network type information, therefore all GSM networks return the "3G" value.

Methods

Name Description Return type
addListener

Adds a connection type listener to the list of listeners.

undefined
removeListener

Removes a connection type listener from the list of listeners.

undefined

Related topics

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