Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
protected static interface

ContactsContract.ContactNameColumns

android.provider.ContactsContract.ContactNameColumns
Known Indirect Subclasses

Class Overview

Contact name and contact name metadata columns in the RawContacts table.

See Also

Summary

Constants
String DISPLAY_NAME_ALTERNATIVE

An alternative representation of the display name, such as "family name first" instead of "given name first" for Western names.

String DISPLAY_NAME_PRIMARY

The standard text shown as the contact's display name, based on the best available information for the contact (for example, it might be the email address if the name is not available).

String DISPLAY_NAME_SOURCE The kind of data that is used as the display name for the contact, such as structured name or email address.
String PHONETIC_NAME

Pronunciation of the full name in the phonetic alphabet specified by PHONETIC_NAME_STYLE .

String PHONETIC_NAME_STYLE The phonetic alphabet used to represent the PHONETIC_NAME .
String SORT_KEY_ALTERNATIVE Sort key based on the alternative representation of the full name, DISPLAY_NAME_ALTERNATIVE .
String SORT_KEY_PRIMARY Sort key that takes into account locale-based traditions for sorting names in address books.

Constants

public static final String DISPLAY_NAME_ALTERNATIVE

Added in API level 11

An alternative representation of the display name, such as "family name first" instead of "given name first" for Western names. If an alternative is not available, the values should be the same as DISPLAY_NAME_PRIMARY .

A contacts provider is free to provide alternatives as necessary for its target market. For example the default Android Open Source Project contacts provider currently provides an alternative in a single case: if the display name is based on the structured name and the structured name follows the Western full name style, then the field contains the "family name first" version of the full name. Other cases may be added later.

Constant Value: "display_name_alt"

public static final String DISPLAY_NAME_PRIMARY

Added in API level 11

The standard text shown as the contact's display name, based on the best available information for the contact (for example, it might be the email address if the name is not available). The information actually used to compute the name is stored in DISPLAY_NAME_SOURCE .

A contacts provider is free to choose whatever representation makes most sense for its target market. For example in the default Android Open Source Project implementation, if the display name is based on the structured name and the structured name follows the Western full-name style, then this field contains the "given name first" version of the full name.

See Also
Constant Value: "display_name"

public static final String DISPLAY_NAME_SOURCE

Added in API level 11

The kind of data that is used as the display name for the contact, such as structured name or email address. See ContactsContract.DisplayNameSources .

Constant Value: "display_name_source"

public static final String PHONETIC_NAME

Added in API level 11

Pronunciation of the full name in the phonetic alphabet specified by PHONETIC_NAME_STYLE .

The value may be set manually by the user. This capability is of interest only in countries with commonly used phonetic alphabets, such as Japan and Korea. See ContactsContract.PhoneticNameStyle .

Constant Value: "phonetic_name"

public static final String PHONETIC_NAME_STYLE

Added in API level 11

The phonetic alphabet used to represent the PHONETIC_NAME . See ContactsContract.PhoneticNameStyle .

Constant Value: "phonetic_name_style"

public static final String SORT_KEY_ALTERNATIVE

Added in API level 11

Sort key based on the alternative representation of the full name, DISPLAY_NAME_ALTERNATIVE . Thus for Western names, it is the one using the "family name first" format.

Constant Value: "sort_key_alt"

public static final String SORT_KEY_PRIMARY

Added in API level 11

Sort key that takes into account locale-based traditions for sorting names in address books. The default sort key is DISPLAY_NAME_PRIMARY . For Chinese names the sort key is the name's Pinyin spelling, and for Japanese names it is the Hiragana version of the phonetic name.

Constant Value: "sort_key"