Settings

Provides read access to settings for BBM connected apps.


Supported Platform(s)

- BlackBerry OS 5.0+
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
alwaysAllowPublicConns Y Y Y       
profileboxEnabled Y Y Y       

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

You must declare the feature element(s) below in your configuration document:

Feature IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.bbm.platform" /> Y Y Y       

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Properties

Properties

static readonly Boolean alwaysAllowPublicConns


Indicates whether a prompt is shown when hosting a public connection or when requesting to join a public connection.

true if the prompt is never shown; false otherwise.

See blackberry.bbm.platform.io.host and blackberry.bbm.platform.io.joinHost


Supported Platforms
 - BlackBerry OS 5.0+

static readonly Boolean profileboxEnabled


Indicates whether the application profile box appears in the current user's BBM profile.

true if the profile box appears; false otherwise.

See blackberry.bbm.platform.self.profilebox


Supported Platforms
 - BlackBerry OS 5.0+

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:10 GMT-0500 (EST)