net.rim.blackberry.api.bbm.platform.io
Interface BBMPlatformOutgoingJoinRequest

All Superinterfaces:

BBMPlatformJoinRequest

public interface BBMPlatformOutgoingJoinRequest

extends BBMPlatformJoinRequest

This interface defines an outgoing join request that the user sent to someone else who may or may not be in the user's BBM contact list.

Field Summary

Fields inherited from interface net.rim.blackberry.api.bbm.platform.io.BBMPlatformJoinRequest

REQUEST_STATUS_ACCEPTED, REQUEST_STATUS_CANCELED, REQUEST_STATUS_DECLINED, REQUEST_STATUS_PENDING

Method Summary

void	cancel() The third application can cancel a request as long as it's still in BBMPlatformJoinRequest.REQUEST_STATUS_PENDING status.
BBMPlatformContact	getHost() This API is used to get the person who is hosting a public connection and is supposed to receive the user's join request.

Methods inherited from interface net.rim.blackberry.api.bbm.platform.io.BBMPlatformJoinRequest

getRequestId, getStatus

Method Detail

cancel

public void cancel()

The third application can cancel a request as long as it's still in BBMPlatformJoinRequest.REQUEST_STATUS_PENDING status.
Note that the Platform doesn't persist the requests, that is, on device reset all pending requests will be cleared.
Once a join request is canceled by the user, it will be removed from the sender's as well as from the host's pending queue. Also, the request's status will be changed to BBMPlatformJoinRequest.REQUEST_STATUS_CANCELED, so the host cannot accept or decline it anymore.
If the request being canceled has already been canceled by the user, or has been accepted or declined by the host, calling this API will do nothing.

Throws:

PersistentContentException - when Content Protection is enabled and device is locked.

Since:

BBM SDK 1.0

getHost

public BBMPlatformContact getHost()

This API is used to get the person who is hosting a public connection and is supposed to receive the user's join request.

Returns:

The person who hosts the public connection and is supposed to receive/accept/decline the join request.

Since:

BBM SDK 1.0