net.rim.blackberry.api.pdap.contactlinking
Class LinkedContactInfoProvider

java.lang.Object
  extended by net.rim.blackberry.api.pdap.contactlinking.LinkedContactInfoProvider

public abstract class LinkedContactInfoProvider
extends Object

A provider to supply requested linked contact information.

See Also:
LinkedContactUtilities.registerLinkedContactInfoProvider(net.rim.blackberry.api.pdap.contactlinking.LinkedContactInfoProvider, long, int)
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

Field Summary
Category: Signed static int AVAILABILITY
          Bit flag for a linked contact's availability.
Category: Signed static int AVAILABILITY_AWAY
          Contact is away, busy, on the phone, etc.
Category: Signed static int AVAILABILITY_OFFLINE
          Contact is offline or otherwise unavailable.
Category: Signed static int AVAILABILITY_ONLINE
          Contact is online, available, free to chat, etc.
Category: Signed static int AVAILABILITY_UNSET
          Availability has not been set for this contact.
Category: Signed static int STATUS
          Bit flag for a linked contact's status.
Category: Signed static int USER_NAME
          Bit flag for a linked contact's user name.
 
Constructor Summary
Category: Signed protected LinkedContactInfoProvider()
          Constructs a LinkedContactInfoProvider.
 
Method Summary
Category: Signed abstract  Image getAppImage()
          Request the linked application image.
Category: Signed abstract  String getAppName()
          Request the name of the linked application.
Category: Signed  boolean isContactSelectionSupported()
          Check if the linked application supports returning a list of LinkableContact objects.
Category: Signed  boolean isSupported(int fieldType)
          Check support for the specified field type.
Category: Signed  void requestContactList(LinkedContactCallback callback)
          Initiate a request for a list of LinkableContact objects.
Category: Signed  void requestFields(String contactId, LinkedContactCallback callback, int fieldMask)
          Request an update for the specified field types.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

AVAILABILITY_UNSET

public static final int AVAILABILITY_UNSET
Availability has not been set for this contact.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

AVAILABILITY_ONLINE

public static final int AVAILABILITY_ONLINE
Contact is online, available, free to chat, etc.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

AVAILABILITY_AWAY

public static final int AVAILABILITY_AWAY
Contact is away, busy, on the phone, etc.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

AVAILABILITY_OFFLINE

public static final int AVAILABILITY_OFFLINE
Contact is offline or otherwise unavailable.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

USER_NAME

public static final int USER_NAME
Bit flag for a linked contact's user name.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

STATUS

public static final int STATUS
Bit flag for a linked contact's status.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

AVAILABILITY

public static final int AVAILABILITY
Bit flag for a linked contact's availability.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0


Constructor Detail

LinkedContactInfoProvider

protected LinkedContactInfoProvider()
Constructs a LinkedContactInfoProvider.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0


Method Detail

requestFields

public void requestFields(String contactId,
                          LinkedContactCallback callback,
                          int fieldMask)
Request an update for the specified field types.

Parameters:
contactId - The ID of the linked contact
callback - The callback to apply the results to
fieldMask - The specified field types, may be a combination of LinkedContactInfoProvider.USER_NAME, LinkedContactInfoProvider.STATUS or LinkedContactInfoProvider.AVAILABILITY.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

isSupported

public boolean isSupported(int fieldType)
Check support for the specified field type. Subclasses should override this method to indicate support for a particular field type. By default, all fields are not supported.

Parameters:
fieldType - currently one of LinkedContactInfoProvider.USER_NAME, LinkedContactInfoProvider.STATUS or LinkedContactInfoProvider.AVAILABILITY.
Returns:
true if the field is supported, false otherwise
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

isContactSelectionSupported

public boolean isContactSelectionSupported()
Check if the linked application supports returning a list of LinkableContact objects.

Returns:
true if supported, false otherwise
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

requestContactList

public void requestContactList(LinkedContactCallback callback)
Initiate a request for a list of LinkableContact objects. This list can be loaded as contacts become available over multiple calls.

Parameters:
callback - The object to set the list of returned contacts
See Also:
LinkedContactCallback.setContactList(net.rim.blackberry.api.pdap.contactlinking.LinkableContact[], boolean, int)
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

getAppImage

public abstract Image getAppImage()
Request the linked application image. An image must be returned for any information to be displayed when viewing a contact in the Contacts application.

Returns:
the image of the linked application
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0

getAppName

public abstract String getAppName()
Request the name of the linked application. A name must be returned for any information to be displayed when editing a contact in the Contacts application.

Returns:
the application name
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 6.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal