net.rim.blackberry.api.pdap.contactlinking
Interface LinkableContact

All Known Implementing Classes:

AbstractLinkableContact, DefaultLinkableContact

public interface LinkableContact

Represents an object that is linkable with a contact in the contacts application.

Note: A LinkableContact must contain at least an application ID and a contact ID. The application ID is used to identify the application the contact is from. The contact ID is the unique identifier of the contact within that application.

See Also:

LinkedContactUtilities

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 5.0.0

Field Summary
	static int	EMAIL Field for an email address.
	static int	FAX_PHONE Field for a fax number.
	static int	FAX_PHONE2 Field for a second fax number.
	static int	HOME_PHONE Field for a home phone number.
	static int	HOME_PHONE2 Field for a second home phone number.
	static int	MOBILE_PHONE Field for a mobile phone number.
	static int	MOBILE_PHONE2 Field for a second mobile phone number.
	static int	NAME Field specifying the name for this LinkableContact.
	static int	OTHER_PHONE Field for another phone number.
	static int	PIN Field for a PIN address.
	static int	WORK_PHONE Field for a work phone number.
	static int	WORK_PHONE2 Field for a second work phone number.

Method Summary
	long	getApplicationID() Gets the unique ID that identifies the application this contact is from.
	String	getContactID() Gets the unique ID of this contact.
	String	getString(int key) Gets the value of the LinkableContact attribute matching the supplied key.

Field Detail

NAME

static final int NAME

Field specifying the name for this LinkableContact.

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 5.0.0

PIN

static final int PIN

Field for a PIN address.

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

EMAIL

static final int EMAIL

Field for an email address.

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 5.0.0

HOME_PHONE

static final int HOME_PHONE

Field for a home phone number.

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 5.0.0

WORK_PHONE

static final int WORK_PHONE

Field for a work phone number.

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 5.0.0

HOME_PHONE2

static final int HOME_PHONE2

Field for a second home phone number.

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 5.0.0

WORK_PHONE2

static final int WORK_PHONE2

Field for a second work phone number.

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 5.0.0

MOBILE_PHONE

static final int MOBILE_PHONE

Field for a mobile phone number.

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 5.0.0

MOBILE_PHONE2

static final int MOBILE_PHONE2

Field for a second mobile phone number.

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

FAX_PHONE

static final int FAX_PHONE

Field for a fax number.

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

FAX_PHONE2

static final int FAX_PHONE2

Field for a second fax number.

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

OTHER_PHONE

static final int OTHER_PHONE

Field for another phone number.

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 5.0.0

Method Detail

getApplicationID

long getApplicationID()

Gets the unique ID that identifies the application this contact is from. A LinkableContact must have an application ID.

Returns:

The unique application ID.

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 5.0.0

getContactID

String getContactID()

Gets the unique ID of this contact. This is the ID used to identify a contact in your application. A LinkableContact must have a contact ID.

Returns:

The unique ID as a string; this method should never return null.

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 5.0.0

getString

String getString(int key)

Gets the value of the LinkableContact attribute matching the supplied key.

Parameters:

key - The key for the attribute to retrieve.

Returns:

The value corresponding to the supplied key or null if no value has been set.

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 5.0.0