blackberry.bbm.platform.users.BBMPlatformUser
Provides read-only access to a BBM platform user's information as defined in their BBM profile.
Instances of this object are not created, but obtained from the BBM platform.
Current User
The current user's BBMPlatformUser instance is blackberry.bbm.platform.self. It also provides the ability to set properties of the current user.Other Users
You can obtain other users from the following functions/callbacks: blackberry.bbm.platform.io.Channel and blackberry.bbm.platform.io.Session also use BBMPlatformUser extensively.Supported Platform(s)
- BlackBerry OS 5.0+
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| displayName | Y | Y | Y | ||
| displayPicture | Y | Y | Y | ||
| handle | Y | Y | Y | ||
| personalMessage | Y | Y | Y | ||
| ppid | Y | Y | Y | ||
| status | Y | Y | Y | ||
| statusMessage | 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 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) |
|---|---|---|---|
| displayName |
String
readonly |
The display name.
|
- BlackBerry OS 5.0+
|
| displayPicture |
String
readonly |
The display picture, encoded as a base64 image string.
|
- BlackBerry OS 5.0+
|
| handle |
String
readonly |
A unique ID representing the user on a specific device. This will be different for the same user on different devices (BlackBerry smartphone, BlackBerry PlayBook, etc.)
|
- BlackBerry OS 5.0+
|
| personalMessage |
String
readonly |
The personal message.
|
- BlackBerry OS 5.0+
|
| ppid |
String
readonly |
A unique ID representing the user on all devices. This will be the same for the same user on all devices (BlackBerry smartphone, BlackBerry PlayBook, etc.)
|
- BlackBerry OS 5.0+
|
| status |
String
readonly |
One of "available" or "busy".
|
- BlackBerry OS 5.0+
|
| statusMessage |
String
readonly |
The status message.
|
- BlackBerry OS 5.0+
|
Code Example(s)
<script type="text/javascript">
// Show the current user's display picture
var user = blackberry.bbm.platform.self;
var displayPicImg = document.getElementById("displayPicture"); // Must have img tag with id='displayPicture'
displayPicImg.src = user.displayPicture;
</script>
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:15 GMT-0500 (EST)