blackberry.bbm.platform.io.OutgoingJoinRequest

A request to join sent from the peer's side.


Supported Platform(s)

- BlackBerry OS 5.0+
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
cancel Y Y Y       
host 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.

Functions

void cancel ()


Cancels the request. The request can only be canceled if its status == "pending"; otherwise, this does nothing.

onRequestCanceled supplied to blackberry.bbm.platform.io.host is invoked on the host's side.


Supported Platforms
 - BlackBerry OS 5.0+

Properties

blackberry.bbm.platform.users.BBMPlatformUser host


The host that the request is sent to.


Supported Platforms
 - BlackBerry OS 5.0+

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