SHOW Signed

net.rim.blackberry.api.pim
Interface BlackBerryContact

All Superinterfaces:

Contact, PIMItem

public interface BlackBerryContact

extends Contact

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 BlackBerry Contact.

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

BlackBerryContacts 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

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 addStringArray 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 addStringArray method.

On commit:

• If the NAME_FIRST 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 getAttributes 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 the BlackBerryPIMList.setCustomLabel method. Changing a label affects all contacts in the list.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

See Also:

Contact, PIMItem

Field Summary

	static int	PIN Unique identifier for a BlackBerry device.
	static int	USER1 User defined String field.
	static int	USER2 User defined String field.
	static int	USER3 User defined String field.
	static int	USER4 User defined String field.

Fields inherited from interface net.rim.blackberry.api.pim.Contact

ADDR, ADDR_COUNTRY, ADDR_EXTRA, ADDR_LOCALITY, ADDR_POBOX, ADDR_POSTALCODE, ADDR_REGION, ADDR_STREET, ADDRSIZE, ATTR_ASST, ATTR_AUTO, ATTR_FAX, ATTR_HOME, ATTR_MOBILE, ATTR_OTHER, ATTR_PAGER, ATTR_PREFERRED, ATTR_SMS, ATTR_WORK, BIRTHDAY, CLASS, CLASS_CONFIDENTIAL, CLASS_PRIVATE, CLASS_PUBLIC, EMAIL, FORMATTED_ADDR, FORMATTED_NAME, NAME, NAME_FAMILY, NAME_GIVEN, NAME_OTHER, NAME_PREFIX, NAME_SUFFIX, NAMESIZE, NICKNAME, NOTE, ORG, PHOTO, PHOTO_URL, PUBLIC_KEY, PUBLIC_KEY_STRING, REVISION, TEL, TITLE, UID, URL

Fields inherited from interface net.rim.blackberry.api.pim.PIMItem

ATTR_NONE, BINARY, BOOLEAN, DATE, EXTENDED_ATTRIBUTE_MIN_VALUE, EXTENDED_FIELD_MIN_VALUE, INT, STRING, STRING_ARRAY

Methods inherited from interface net.rim.blackberry.api.pim.Contact

getPreferredIndex

Methods inherited from interface net.rim.blackberry.api.pim.PIMItem

addBinary, addBoolean, addDate, addInt, addString, addStringArray, addToCategory, commit, countValues, getAttributes, getBinary, getBoolean, getCategories, getDate, getFields, getInt, getPIMList, getString, getStringArray, isModified, maxCategories, removeFromCategory, removeValue, setBinary, setBoolean, setDate, setInt, setString, setStringArray

Field Detail

PIN

public static final int PIN

Unique identifier for a BlackBerry device. This field is of type String, but the value must be a valid hex number.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

USER1

public static final int USER1

User defined String field.

The field can be named using the setCustomLabel method.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

USER2

public static final int USER2

User defined String field.

The field can be named using the setCustomLabel method.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

USER3

public static final int USER3

User defined String field.

The field can be named using the setCustomLabel method.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

USER4

public static final int USER4

User defined String field.

The field can be named using the setCustomLabel method.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.