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

All Known Subinterfaces:

BBMPlatformIncomingJoinRequest, BBMPlatformOutgoingJoinRequest

public interface BBMPlatformJoinRequest

This interface is a base interface of BBMPlatformOutgoingJoinRequest and BBMPlatformIncomingJoinRequest providing functionality of sending or canceling join requests for request senders, and accepting or declining join requests for hosts.

Field Summary

static int	REQUEST_STATUS_ACCEPTED This constant indicates the join request has been accepted by the host.
static int	REQUEST_STATUS_CANCELED This constant indicates the join request has been canceled.
static int	REQUEST_STATUS_DECLINED This constant indicates the join request has been declined.
static int	REQUEST_STATUS_PENDING This constant indicates a join request is in pending status, which means the the request hasn't been accepted or declined by the host.

Method Summary

int	getRequestId() This API is used to get the unique Id for a join request.
int	getStatus() This API is used to keep track of the status of a join request.

Field Detail

REQUEST_STATUS_ACCEPTED

public static final int REQUEST_STATUS_ACCEPTED

This constant indicates the join request has been accepted by the host.

Since:

BBM SDK 1.0

REQUEST_STATUS_CANCELED

public static final int REQUEST_STATUS_CANCELED

This constant indicates the join request has been canceled.

Since:

BBM SDK 1.0

REQUEST_STATUS_DECLINED

public static final int REQUEST_STATUS_DECLINED

This constant indicates the join request has been declined.

Since:

BBM SDK 1.0

REQUEST_STATUS_PENDING

public static final int REQUEST_STATUS_PENDING

This constant indicates a join request is in pending status, which means the the request hasn't been accepted or declined by the host. The request sender can cancel a join request that has been sent only if is still pending.

Since:

BBM SDK 1.0

Method Detail

getRequestId

public int getRequestId()

This API is used to get the unique Id for a join request.

Returns:

The request Id which must be unique within an application.
The Platform maintains a list of BBMPlatformOutgoingJoinRequest for a request sender and a list of BBMPlatformIncomingJoinRequest for a host.
Note that a user can be a request sender and a host at the same time, i.e., the user can send a join request to a public connection hosted by someone else, and can host a public connection to let other people join.
The Platform generates the request Id on the sender side, and the host side who receives a join request will just use the same Id when receving the request.

Since:

BBM SDK 1.0

getStatus

public int getStatus()

This API is used to keep track of the status of a join request.

Returns:

The status of the join request, whic cann be REQUEST_STATUS_PENDING, REQUEST_STATUS_ACCEPTED, REQUEST_STATUS_DECLINED or REQUEST_STATUS_CANCELED.

Since:

BBM SDK 1.0