net.rim.blackberry.api.bbm.platform.profile
Class BBMPlatformContact

java.lang.Object
  |
  +--net.rim.blackberry.api.bbm.platform.profile.BBMPlatformContact
All Implemented Interfaces:
Comparable, Presence

public abstract class BBMPlatformContact
extends Object
implements Presence, Comparable

This class provides access to basic contact profile details


Field Summary
 
Fields inherited from interface net.rim.blackberry.api.bbm.platform.profile.Presence
STATUS_AVAILABLE, STATUS_BUSY
 
Method Summary
abstract  int compareTo(Object obj)
          Compares two contacts by display name.
abstract  String getHandle()
          Retrieves the device-dependent ID of the contact - the handles for the contact are different on different BBM instances (BlackBerry devices, PlayBook, etc)
abstract  String getPPID()
          Retrieves the device-independent ID of the contact - the PPID of the contact is the same on different BBM instances (BlackBerry devices, PlayBook, etc) if the contact signs in with the same BlackBerry ID account.
 
Methods inherited from interface net.rim.blackberry.api.bbm.platform.profile.Presence
getAppVersion, getBBMSDKVersion, getDisplayName, getDisplayPicture, getPersonalMessage, getStatus, getStatusMessage
 

Method Detail

compareTo

public abstract int compareTo(Object obj)
Compares two contacts by display name. If two distinct contacts that have the same display name, an arbitrary but fixed order is returned.
Parameters:
obj - The second contact whose display name is compared against.
Returns:
a negative integer, zero, or a positive integer as this contact should be lexicographically less than, equal to, or greater than the second contact.
Throws:
IllegalArgumentException - if obj is not of type BBMPlatformContact
Since:
BBM SDK 1.0

getHandle

public abstract String getHandle()
Retrieves the device-dependent ID of the contact - the handles for the contact are different on different BBM instances (BlackBerry devices, PlayBook, etc)
Returns:
Handle of the contact
Since:
BBM SDK 1.0

getPPID

public abstract String getPPID()
Retrieves the device-independent ID of the contact - the PPID of the contact is the same on different BBM instances (BlackBerry devices, PlayBook, etc) if the contact signs in with the same BlackBerry ID account. It returns empty string for contacts that are not in BBM Contact List - like contacts in BBMPlatformSession that are not in user's BBM contact list will have no PPID.
Returns:
PPID of the contact
Since:
BBM SDK 1.0



Copyright 1999- Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.