Skip to content

Most visited

Recently visited

navigation
Added in API level 5

ContactsContract.CommonDataKinds.Relation

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

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


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

Inherited constants

From interface android.provider.ContactsContract.CommonDataKinds.CommonColumns
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
From interface android.provider.ContactsContract.CommonDataKinds.BaseTypes

Public methods

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

static final int getTypeLabelResource(int type)

Return the string resource that best describes the given TYPE.

Inherited methods

From class java.lang.Object

Constants

CONTENT_ITEM_TYPE

Added in API level 5
String CONTENT_ITEM_TYPE

MIME type used when storing this in data table.

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

EXTRA_ADDRESS_BOOK_INDEX

Added in API level 21
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

Added in API level 21
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

Added in API level 21
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
String NAME

The name of the relative as the user entered it.

Type: TEXT

Constant Value: "data1"

TYPE_ASSISTANT

Added in API level 5
int TYPE_ASSISTANT

Constant Value: 1 (0x00000001)

TYPE_BROTHER

Added in API level 5
int TYPE_BROTHER

Constant Value: 2 (0x00000002)

TYPE_CHILD

Added in API level 5
int TYPE_CHILD

Constant Value: 3 (0x00000003)

TYPE_DOMESTIC_PARTNER

Added in API level 5
int TYPE_DOMESTIC_PARTNER

Constant Value: 4 (0x00000004)

TYPE_FATHER

Added in API level 5
int TYPE_FATHER

Constant Value: 5 (0x00000005)

TYPE_FRIEND

Added in API level 5
int TYPE_FRIEND

Constant Value: 6 (0x00000006)

TYPE_MANAGER

Added in API level 5
int TYPE_MANAGER

Constant Value: 7 (0x00000007)

TYPE_MOTHER

Added in API level 5
int TYPE_MOTHER

Constant Value: 8 (0x00000008)

TYPE_PARENT

Added in API level 5
int TYPE_PARENT

Constant Value: 9 (0x00000009)

TYPE_PARTNER

Added in API level 5
int TYPE_PARTNER

Constant Value: 10 (0x0000000a)

TYPE_REFERRED_BY

Added in API level 5
int TYPE_REFERRED_BY

Constant Value: 11 (0x0000000b)

TYPE_RELATIVE

Added in API level 5
int TYPE_RELATIVE

Constant Value: 12 (0x0000000c)

TYPE_SISTER

Added in API level 5
int TYPE_SISTER

Constant Value: 13 (0x0000000d)

TYPE_SPOUSE

Added in API level 5
int TYPE_SPOUSE

Constant Value: 14 (0x0000000e)

Public methods

getTypeLabel

Added in API level 11
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.

Parameters
res Resources
type int
label CharSequence
Returns
CharSequence

getTypeLabelResource

Added in API level 11
int getTypeLabelResource (int type)

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

Parameters
type int
Returns
int
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.