blackberry.bbm.platform.io.OutgoingJoinRequest
A request to join sent from the peer's side.
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. |
API Summary
Functions
cancel
| void cancel() |
Supported Platform(s)
- BlackBerry OS 5.0+Description
Cancels the request. The request can only be canceled if its status == "pending"; otherwise, this will do nothing.
onRequestCanceled supplied to host will be invoked on the host's side.
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| host | blackberry.bbm.platform.users.BBMPlatformUser |
The host to whom the request is sent.
|
- BlackBerry OS 5.0+
|
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:19 GMT-0500 (EST)