to top
Android APIs
public static final class

ContactsContract.CommonDataKinds.Nickname

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

Class Overview

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

Type Alias Data column
String NAME DATA1
int TYPE DATA2 Allowed values are:

String LABEL DATA3

Summary

Constants
String CONTENT_ITEM_TYPE MIME type used when storing this in data table.
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 9. Use TYPE_MAIDEN_NAME instead.
int TYPE_OTHER_NAME
int TYPE_SHORT_NAME
[Expand]
Inherited Constants
From interface android.provider.BaseColumns
From interface android.provider.ContactsContract.CommonDataKinds.BaseTypes
From interface android.provider.ContactsContract.CommonDataKinds.CommonColumns
From interface android.provider.ContactsContract.ContactNameColumns
From interface android.provider.ContactsContract.ContactOptionsColumns
From interface android.provider.ContactsContract.ContactStatusColumns
From interface android.provider.ContactsContract.ContactsColumns
From interface android.provider.ContactsContract.DataColumns
From interface android.provider.ContactsContract.RawContactsColumns
From interface android.provider.ContactsContract.StatusColumns
[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/nickname"

public static final String NAME

Added in API level 5

The name itself

Constant Value: "data1"

public static final int TYPE_DEFAULT

Added in API level 5

Constant Value: 1 (0x00000001)

public static final int TYPE_INITIALS

Added in API level 5

Constant Value: 5 (0x00000005)

public static final int TYPE_MAIDEN_NAME

Added in API level 9

Constant Value: 3 (0x00000003)

public static final int TYPE_MAINDEN_NAME

Added in API level 5

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

Constant Value: 3 (0x00000003)

public static final int TYPE_OTHER_NAME

Added in API level 5

Constant Value: 2 (0x00000002)

public static final int TYPE_SHORT_NAME

Added in API level 5

Constant Value: 4 (0x00000004)
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.