blackberry.bbm.platform.io.IncomingJoinRequest
A request to join received on the host'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 | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
|---|---|---|---|---|---|---|---|
| <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. |
Properties
| String | cookie |
| blackberry.bbm.platform.users.BBMPlatformUser | peer |
|
Functions
void
accept
([cookie : String])
Accepts the join request from a peer. This can be called from the host's side.
onHostAccepted supplied to blackberry.bbm.platform.io.joinHost will
be invoked on the peer's side.
| Supported Platforms | |
|---|---|
| - BlackBerry OS 5.0+ | |
| Parameters | |
|---|---|
| cookie | A custom parameter provided by the third party application. This parameter will be sent to the joining peer. |
| Throws | |
|---|---|
| IllegalArgumentException |
If cookie is longer than 128 characters.
|
void
decline
()
Declines the join request from a peer. This can be called from the host's side.
onHostDeclined supplied to blackberry.bbm.platform.io.joinHost will
be invoked on the peer's
side, with the reason "declinedbyhost".
| Supported Platforms | |
|---|---|
| - BlackBerry OS 5.0+ | |
Properties
String
cookie
The cookie specified by the requesting peer. undefined if no cookie was specified.
| Supported Platforms | |
|---|---|
| - BlackBerry OS 5.0+ | |
blackberry.bbm.platform.users.BBMPlatformUser
peer
The user who is requesting to join.
| Supported Platforms | |
|---|---|
| - BlackBerry OS 5.0+ | |