net.rim.blackberry.api.pim
Interface BlackBerryContact


Deprecated. In favour of BlackBerryContact.

public interface BlackBerryContact

This interface represents a contact contained in the default RIM BlackBerry address book.

This interface defines extended fields in addition to the standard fields that are used to reference fields with the BlackBerryContact.

You can use any of the static field constants defined here in your code on any valid BlackBerryContact instance.

BlackBerryContact objects support the following fields and attributes:

Field Values Per Field Supported Attributes
Contact.NAME 1 PIMItem.ATTR_NONE
Contact.TITLE 1 PIMItem.ATTR_NONE
Contact.ORG 1 PIMItem.ATTR_NONE
Contact.ADDR 1 PIMItem.ATTR_NONE
Contact.NOTE 1 PIMItem.ATTR_NONE
Contact.TEL 5 Contact.ATTR_WORK, Contact.ATTR_HOME, Contact.ATTR_MOBILE, Contact.ATTR_PAGER, Contact.ATTR_FAX
Contact.EMAIL 3 PIMItem.ATTR_NONE
Contact.NOTES 1 PIMItem.ATTR_NONE
Contact.UID 1 PIMItem.ATTR_NONE
BlackBerryContact.USER1 1 PIMItem.ATTR_NONE
BlackBerryContact.USER2 1 PIMItem.ATTR_NONE
BlackBerryContact.USER3 1 PIMItem.ATTR_NONE
BlackBerryContact.USER4 1 PIMItem.ATTR_NONE
BlackBerryContact.PIN 1 PIMItem.ATTR_NONE
BlackBerryContact.DCID 1 PIMItem.ATTR_NONE

Supported Fields
The NAME_OTHER and NAME_SUFFIX entries of the NAME array are not supported. They will be silently dropped if present in the parameter passed in to the PIMItem.addStringArray(int, int, java.lang.String[]) method.

The ADDR_POBOX entry of the ADDR array is not supported. It will be silently dropped if present in the parameter passed in to the PIMItem.addStringArray(int, int, java.lang.String[]) method.

On commit, if the NAME_GIVEN and NAME_LAST entries in the NAME array are null, and the ORG field is not assigned, a PIMException is triggered.

The TEL field supports at most 5 values, with each value having a distinct attribute. The PIMItem.getAttributes(int, int) method for the TEL field will always return one of ATTR_WORK, ATTR_HOME, ATTR_MOBILE, ATTR_PAGER, or ATTR_FAX.

When adding a TEL field, the attribute is chosen by examining the attributes parameter for the presence of one of the supported attributes in the following order: ATTR_FAX, ATTR_PAGER, ATTR_MOBILE, ATTR_HOME, ATTR_WORK, with the first one found that does not have a value already assigned to it being chosen. If no such attribute is found, then the first available attribute is used in the order: ATTR_WORK, ATTR_HOME, ATTR_MOBILE, ATTR_PAGER, ATTR_FAX (even though the attribute is not present in the attributes parameter).

Categories are not supported.

The labels for the extended fields USER1-4 can be modified using BlackBerryPIMList.setFieldLabel(int, java.lang.String). Changing a label affects all contacts in the list.

See Also:
Contact, PIMItem
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 3.6.0






Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.