blackberry.bbm.platform.io.JoinRequest

Provides basic request functionality including a request ID and status.

Supported Platform(s)

- BlackBerry OS 5.0+

View Supported Platform Table

APIOS 5.0OS 6.0OS 7.0PlayBookRipple
id Y Y Y   
status 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 IDOS 5.0OS 6.0OS 7.0PlayBookRipple
<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.

API Summary


Properties

Properties:


Property Type Description Supported Platform(s)
id Number The unique ID.
 - BlackBerry OS 5.0+
status String The status.
  • "pending": The request has not been accepted or denied by the host, or canceled by the peer.
  • "accepted": The request has been accepted by the host.
  • "declined": The request has been declined by the host.
  • "canceled": The request has been canceled by the peer.

 - BlackBerry OS 5.0+

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:18 GMT-0500 (EST)