blackberry.bbm.platform.self.profilebox.ProfileBoxItem
A profile box item. Consists of text and possibly an icon.
Supported Platform(s)
- BlackBerry OS 5.0+
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 ID | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| <feature id="blackberry.bbm.platform" /> | Y | Y | Y |
| Permission Elements (PlayBook Only) |
|---|
| This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. |
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| cookie |
String
readonly |
The customizable cookie. This is undefined if this item has no cookie.
|
- BlackBerry OS 5.0+
|
| icon |
String
readonly |
The item icon as a base64 encoded image string. This is undefined if the item has no icon.
|
- BlackBerry OS 5.0+
|
| id |
Number
readonly |
The item ID.
|
- BlackBerry OS 5.0+
|
| text |
String
readonly |
The item text.
|
- BlackBerry OS 5.0+
|
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:19 GMT-0500 (EST)