Added in API level 5

Nickname


class Nickname : ContactsContract.DataColumnsWithJoins, ContactsContract.CommonDataKinds.CommonColumns
kotlin.Any
   ↳ 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

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

String LABEL DATA3

Summary

Constants
static String

MIME type used when storing this in data table.

static String

Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras.

static String

The array of group counts for the corresponding group.

static String

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

static String

The name itself

static Int

static Int

static Int

static Int

static Int

static Int

Inherited constants

Constants

CONTENT_ITEM_TYPE

Added in API level 5
static val CONTENT_ITEM_TYPE: String

MIME type used when storing this in data table.

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

EXTRA_ADDRESS_BOOK_INDEX

static val EXTRA_ADDRESS_BOOK_INDEX: String

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);
  }
  

Value: "android.provider.extra.ADDRESS_BOOK_INDEX"

EXTRA_ADDRESS_BOOK_INDEX_COUNTS

static val EXTRA_ADDRESS_BOOK_INDEX_COUNTS: String

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[]

Value: "android.provider.extra.ADDRESS_BOOK_INDEX_COUNTS"

EXTRA_ADDRESS_BOOK_INDEX_TITLES

static val EXTRA_ADDRESS_BOOK_INDEX_TITLES: String

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

TYPE: String[]

Value: "android.provider.extra.ADDRESS_BOOK_INDEX_TITLES"

NAME

Added in API level 5
static val NAME: String

The name itself

Value: "data1"

TYPE_DEFAULT

Added in API level 5
static val TYPE_DEFAULT: Int
Value: 1

TYPE_INITIALS

Added in API level 5
static val TYPE_INITIALS: Int
Value: 5

TYPE_MAIDEN_NAME

Added in API level 9
static val TYPE_MAIDEN_NAME: Int
Value: 3

TYPE_MAINDEN_NAME

Added in API level 5
Deprecated in API level 15
static val TYPE_MAINDEN_NAME: Int

Deprecated: Use TYPE_MAIDEN_NAME instead.

Value: 3

TYPE_OTHER_NAME

Added in API level 5
static val TYPE_OTHER_NAME: Int
Value: 2

TYPE_SHORT_NAME

Added in API level 5
static val TYPE_SHORT_NAME: Int
Value: 4