blackberry.bbm.platform.self.profilebox.ProfileBoxItem

A profile box item. Consists of text and possibly an icon.


Supported Platform(s)

- BlackBerry OS 5.0+
- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
cookie Y Y Y     Y 
icon Y Y Y       
iconId           Y 
id Y Y Y       
id           Y 
text Y 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     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

String cookie
String icon
Number iconId
Number id
String id
String text

Properties

readonly String cookie


The customizable cookie. This is undefined if this item has no cookie.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry 10

readonly String icon


The item icon as a base64 encoded image string. This is undefined if the item has no icon.


Supported Platforms
 - BlackBerry OS 5.0+

readonly Number iconId


The item icon as a base64 encoded image string. This is undefined if the item has no icon.


Supported Platforms
 - BlackBerry 10

readonly Number id


The item ID.


Supported Platforms
 - BlackBerry OS 5.0+

static readonly String id


The item ID.


Supported Platforms
 - BlackBerry 10

readonly String text


The item text.


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry 10

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