blackberry.bbm.platform.io.IncomingJoinRequest

A request to join received on the host's side.

Supported Platform(s)

- BlackBerry OS 5.0+

API	OS 5.0	OS 6.0	OS 7.0
accept	Y	Y	Y
decline	Y	Y	Y
cookie	Y	Y	Y
peer	Y	Y	Y

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 inherited from class blackberry.bbm.platform.io.JoinRequest:: id status

void accept([cookie: String])

- BlackBerry OS 5.0+

Accepts the join request from a peer. This can be called from the host's side.

onHostAccepted supplied to joinHost will be invoked on the peer's side.

Parameter	Type	Description
cookie	String Optional	A custom parameter provided by the third party application. This parameter will be sent to the joining peer.

Throws	Description
IllegalArgumentException	If `cookie` is longer than 128 characters.

void decline()

- BlackBerry OS 5.0+

Declines the join request from a peer. This can be called from the host's side.

onHostDeclined supplied to joinHost will be invoked on the peer's side, with the reason "declinedbyhost".

Property	Type	Description	Supported Platform(s)
cookie	String	The cookie specified by the requesting peer. `undefined` if no cookie was specified.	- BlackBerry OS 5.0+
peer	blackberry.bbm.platform.users.BBMPlatformUser	The user who is requesting to join.	- BlackBerry OS 5.0+

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