Android APIs
public static final class

ContactsContract.CommonDataKinds.StructuredName

extends Object
implements ContactsContract.DataColumnsWithJoins
java.lang.Object
   ↳ android.provider.ContactsContract.CommonDataKinds.StructuredName

Class Overview

A data kind representing the contact's proper name. You can use all columns defined for ContactsContract.Data as well as the following aliases.

Column aliases

TypeAliasData column
String DISPLAY_NAME DATA1
String GIVEN_NAME DATA2
String FAMILY_NAME DATA3
String PREFIX DATA4 Common prefixes in English names are "Mr", "Ms", "Dr" etc.
String MIDDLE_NAME DATA5
String SUFFIX DATA6 Common suffixes in English names are "Sr", "Jr", "III" etc.
String PHONETIC_GIVEN_NAME DATA7 Used for phonetic spelling of the name, e.g. Pinyin, Katakana, Hiragana
String PHONETIC_MIDDLE_NAME DATA8
String PHONETIC_FAMILY_NAME DATA9

Summary

Constants
String CONTENT_ITEM_TYPE MIME type used when storing this in data table.
String DISPLAY_NAME The name that should be used to display the contact.
String EXTRA_ADDRESS_BOOK_INDEX Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras.
String EXTRA_ADDRESS_BOOK_INDEX_COUNTS The array of group counts for the corresponding group.
String EXTRA_ADDRESS_BOOK_INDEX_TITLES The array of address book index titles, which are returned in the same order as the data in the cursor.
String FAMILY_NAME The family name for the contact.
String FULL_NAME_STYLE The style used for combining given/middle/family name into a full name.
String GIVEN_NAME The given name for the contact.
String MIDDLE_NAME The contact's middle name

Type: TEXT

String PHONETIC_FAMILY_NAME The phonetic version of the family name for the contact.
String PHONETIC_GIVEN_NAME The phonetic version of the given name for the contact.
String PHONETIC_MIDDLE_NAME The phonetic version of the additional name for the contact.
String PREFIX The contact's honorific prefix, e.g.
String SUFFIX The contact's honorific suffix, e.g.
[Expand]
Inherited Constants
From interface android.provider.BaseColumns
From interface android.provider.ContactsContract.DataColumns
From interface android.provider.ContactsContract.StatusColumns
From interface android.provider.ContactsContract.RawContactsColumns
From interface android.provider.ContactsContract.ContactsColumns
From interface android.provider.ContactsContract.ContactNameColumns
From interface android.provider.ContactsContract.ContactOptionsColumns
From interface android.provider.ContactsContract.ContactStatusColumns
From interface android.provider.ContactsContract.DataUsageStatColumns
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String CONTENT_ITEM_TYPE

Added in API level 5

MIME type used when storing this in data table.

Constant Value: "vnd.android.cursor.item/name"

public static final String DISPLAY_NAME

Added in API level 5

The name that should be used to display the contact. Unstructured component of the name should be consistent with its structured representation.

Type: TEXT

Constant Value: "data1"

public static final String EXTRA_ADDRESS_BOOK_INDEX

Added in API level 21

Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras. For most languages it is the first letter of the sort key. This parameter does not affect the main content of the cursor.

 Example:

 import android.provider.ContactsContract.Contacts;

 Uri uri = Contacts.CONTENT_URI.buildUpon()
          .appendQueryParameter(Contacts.EXTRA_ADDRESS_BOOK_INDEX, "true")
          .build();
 Cursor cursor = getContentResolver().query(uri,
          new String[] {Contacts.DISPLAY_NAME},
          null, null, null);
 Bundle bundle = cursor.getExtras();
 if (bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES) &&
         bundle.containsKey(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS)) {
     String sections[] =
             bundle.getStringArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_TITLES);
     int counts[] = bundle.getIntArray(Contacts.EXTRA_ADDRESS_BOOK_INDEX_COUNTS);
 }
 

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX"

public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

Added in API level 21

The array of group counts for the corresponding group. Contains the same number of elements as the EXTRA_ADDRESS_BOOK_INDEX_TITLES array.

TYPE: int[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_COUNTS"

public static final String EXTRA_ADDRESS_BOOK_INDEX_TITLES

Added in API level 21

The array of address book index titles, which are returned in the same order as the data in the cursor.

TYPE: String[]

Constant Value: "android.provider.extra.ADDRESS_BOOK_INDEX_TITLES"

public static final String FAMILY_NAME

Added in API level 5

The family name for the contact.

Type: TEXT

Constant Value: "data3"

public static final String FULL_NAME_STYLE

Added in API level 21

The style used for combining given/middle/family name into a full name. See ContactsContract.FullNameStyle.

Constant Value: "data10"

public static final String GIVEN_NAME

Added in API level 5

The given name for the contact.

Type: TEXT

Constant Value: "data2"

public static final String MIDDLE_NAME

Added in API level 5

The contact's middle name

Type: TEXT

Constant Value: "data5"

public static final String PHONETIC_FAMILY_NAME

Added in API level 5

The phonetic version of the family name for the contact.

Type: TEXT

Constant Value: "data9"

public static final String PHONETIC_GIVEN_NAME

Added in API level 5

The phonetic version of the given name for the contact.

Type: TEXT

Constant Value: "data7"

public static final String PHONETIC_MIDDLE_NAME

Added in API level 5

The phonetic version of the additional name for the contact.

Type: TEXT

Constant Value: "data8"

public static final String PREFIX

Added in API level 5

The contact's honorific prefix, e.g. "Sir"

Type: TEXT

Constant Value: "data4"

public static final String SUFFIX

Added in API level 5

The contact's honorific suffix, e.g. "Jr"

Constant Value: "data6"