ContactsContract.CommonDataKinds.Nickname

public static final class ContactsContract.CommonDataKinds.Nickname
extends Object implements ContactsContract.DataColumnsWithJoins, ContactsContract.CommonDataKinds.CommonColumns

java.lang.Object
   ↳ android.provider.ContactsContract.CommonDataKinds.Nickname


A data kind representing the contact's nickname. For example, for Bob Parr ("Mr. Incredible"):

 ArrayList<ContentProviderOperation> ops =
          new ArrayList<ContentProviderOperation>();

 ops.add(ContentProviderOperation.newInsert(Data.CONTENT_URI)
          .withValue(Data.RAW_CONTACT_ID, rawContactId)
          .withValue(Data.MIMETYPE, StructuredName.CONTENT_ITEM_TYPE)
          .withValue(StructuredName.DISPLAY_NAME, "Bob Parr")
          .build());

 ops.add(ContentProviderOperation.newInsert(Data.CONTENT_URI)
          .withValue(Data.RAW_CONTACT_ID, rawContactId)
          .withValue(Data.MIMETYPE, Nickname.CONTENT_ITEM_TYPE)
          .withValue(Nickname.NAME, "Mr. Incredible")
          .withValue(Nickname.TYPE, Nickname.TYPE_CUSTOM)
          .withValue(Nickname.LABEL, "Superhero")
          .build());

 getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);
 

You can use all columns defined for ContactsContract.Data as well as the following aliases.

Column aliases

TypeAliasData column
String NAME ContactsContract.DataColumns.DATA1
int ContactsContract.CommonDataKinds.CommonColumns.TYPE ContactsContract.DataColumns.DATA2 Allowed values are:

String ContactsContract.CommonDataKinds.CommonColumns.LABEL ContactsContract.DataColumns.DATA3

Summary

Constants

String CONTENT_ITEM_TYPE

MIME type used when storing this in data table.

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 NAME

The name itself

int TYPE_DEFAULT

int TYPE_INITIALS

int TYPE_MAIDEN_NAME

int TYPE_MAINDEN_NAME

This constant was deprecated in API level 15. Use TYPE_MAIDEN_NAME instead.

int TYPE_OTHER_NAME

int TYPE_SHORT_NAME

Inherited constants

Inherited methods

Constants

CONTENT_ITEM_TYPE

Added in API level 5
public static final String CONTENT_ITEM_TYPE

MIME type used when storing this in data table.

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

EXTRA_ADDRESS_BOOK_INDEX

public static final 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. 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"

EXTRA_ADDRESS_BOOK_INDEX_COUNTS

public static final String EXTRA_ADDRESS_BOOK_INDEX_COUNTS

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"

EXTRA_ADDRESS_BOOK_INDEX_TITLES

public static final 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.

TYPE: String[]

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

NAME

Added in API level 5
public static final String NAME

The name itself

Constant Value: "data1"

TYPE_DEFAULT

Added in API level 5
public static final int TYPE_DEFAULT

Constant Value: 1 (0x00000001)

TYPE_INITIALS

Added in API level 5
public static final int TYPE_INITIALS

Constant Value: 5 (0x00000005)

TYPE_MAIDEN_NAME

Added in API level 9
public static final int TYPE_MAIDEN_NAME

Constant Value: 3 (0x00000003)

TYPE_MAINDEN_NAME

Added in API level 5
Deprecated in API level 15
public static final int TYPE_MAINDEN_NAME

This constant was deprecated in API level 15.
Use TYPE_MAIDEN_NAME instead.

Constant Value: 3 (0x00000003)

TYPE_OTHER_NAME

Added in API level 5
public static final int TYPE_OTHER_NAME

Constant Value: 2 (0x00000002)

TYPE_SHORT_NAME

Added in API level 5
public static final int TYPE_SHORT_NAME

Constant Value: 4 (0x00000004)