Android APIs
public static final class

ContactsContract.CommonDataKinds.Relation

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

Class Overview

A data kind representing a relation.

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

Column aliases

Type AliasData 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 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 of the relative as the user entered it.
int TYPE_ASSISTANT
int TYPE_BROTHER
int TYPE_CHILD
int TYPE_DOMESTIC_PARTNER
int TYPE_FATHER
int TYPE_FRIEND
int TYPE_MANAGER
int TYPE_MOTHER
int TYPE_PARENT
int TYPE_PARTNER
int TYPE_REFERRED_BY
int TYPE_RELATIVE
int TYPE_SISTER
int TYPE_SPOUSE
[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.DataUsageStatColumns
From interface android.provider.ContactsContract.RawContactsColumns
From interface android.provider.ContactsContract.StatusColumns
Public Methods
final static CharSequence getTypeLabel(Resources res, int type, CharSequence label)
Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.
final static int getTypeLabelResource(int type)
Return the string resource that best describes the given TYPE.
[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/relation"

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 NAME

Added in API level 5

The name of the relative as the user entered it.

Type: TEXT

Constant Value: "data1"

public static final int TYPE_ASSISTANT

Added in API level 5

Constant Value: 1 (0x00000001)

public static final int TYPE_BROTHER

Added in API level 5

Constant Value: 2 (0x00000002)

public static final int TYPE_CHILD

Added in API level 5

Constant Value: 3 (0x00000003)

public static final int TYPE_DOMESTIC_PARTNER

Added in API level 5

Constant Value: 4 (0x00000004)

public static final int TYPE_FATHER

Added in API level 5

Constant Value: 5 (0x00000005)

public static final int TYPE_FRIEND

Added in API level 5

Constant Value: 6 (0x00000006)

public static final int TYPE_MANAGER

Added in API level 5

Constant Value: 7 (0x00000007)

public static final int TYPE_MOTHER

Added in API level 5

Constant Value: 8 (0x00000008)

public static final int TYPE_PARENT

Added in API level 5

Constant Value: 9 (0x00000009)

public static final int TYPE_PARTNER

Added in API level 5

Constant Value: 10 (0x0000000a)

public static final int TYPE_REFERRED_BY

Added in API level 5

Constant Value: 11 (0x0000000b)

public static final int TYPE_RELATIVE

Added in API level 5

Constant Value: 12 (0x0000000c)

public static final int TYPE_SISTER

Added in API level 5

Constant Value: 13 (0x0000000d)

public static final int TYPE_SPOUSE

Added in API level 5

Constant Value: 14 (0x0000000e)

Public Methods

public static final CharSequence getTypeLabel (Resources res, int type, CharSequence label)

Added in API level 11

Return a CharSequence that best describes the given type, possibly substituting the given LABEL value for TYPE_CUSTOM.

public static final int getTypeLabelResource (int type)

Added in API level 11

Return the string resource that best describes the given TYPE. Will always return a valid resource.