net.rim.blackberry.api.bbm.platform.profile
Interface Presence

All Known Implementing Classes:

UserProfile, BBMPlatformContact

public interface Presence

Presence includes basic BBM profile elements and provides methods to retrieve them

Field Summary

static int	STATUS_AVAILABLE Available status
static int	STATUS_BUSY Busy status

Method Summary

String	getAppVersion() Returns the BBM Connected Application version that the contact is running
int	getBBMSDKVersion() Returns the BBM SDK version that the contact is running.
String	getDisplayName() Retrieves contact's display name
Bitmap	getDisplayPicture() Retrieves contact's display picture
String	getPersonalMessage() Retrieves contact's personal message
int	getStatus() Retrieves contact's status
String	getStatusMessage() Retrieves contact's status message

Field Detail

STATUS_AVAILABLE

public static final int STATUS_AVAILABLE

Available status

Since:

BBM SDK 1.0

STATUS_BUSY

public static final int STATUS_BUSY

Busy status

Since:

BBM SDK 1.0

Method Detail

getAppVersion

public String getAppVersion()

Returns the BBM Connected Application version that the contact is running

Returns:

BBM Connected Application version

Since:

BBM SDK 1.2

getBBMSDKVersion

public int getBBMSDKVersion()

Returns the BBM SDK version that the contact is running. One of the BBM_SDK_VER_* constants in BBMPlatformContext.

Returns:

BBM SDK version

Since:

BBM SDK 1.2

getDisplayName

public String getDisplayName()

Retrieves contact's display name

Returns:

Display name of contact

Throws:

PersistentContentException - when Content Protection is enabled and device is locked

Since:

BBM SDK 1.0

getDisplayPicture

public Bitmap getDisplayPicture()

Retrieves contact's display picture

Returns:

Bitmap of contact's display picture

Since:

BBM SDK 1.0

getPersonalMessage

public String getPersonalMessage()

Retrieves contact's personal message

Returns:

Perosnal Message of contact

Throws:

PersistentContentException - when Content Protection is enabled and device is locked

Since:

BBM SDK 1.0

getStatus

public int getStatus()

Retrieves contact's status

Returns:

status value of contact defined in Presence

Since:

BBM SDK 1.0

getStatusMessage

public String getStatusMessage()

Retrieves contact's status message

Returns:

status message of contact

Throws:

PersistentContentException - when Content Protection is enabled and device is locked

Since:

BBM SDK 1.0