Most visited

Recently visited

Results for

Added in API level 5

Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]

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 Alias Data column

String NAME DATA1

int

Type	Alias	Data column
String	`NAME`	`DATA1`
int	`TYPE`	`DATA2`	Allowed values are: `TYPE_CUSTOM`. Put the actual type in `LABEL`. `TYPE_ASSISTANT` `TYPE_BROTHER` `TYPE_CHILD` `TYPE_DOMESTIC_PARTNER` `TYPE_FATHER` `TYPE_FRIEND` `TYPE_MANAGER` `TYPE_MOTHER` `TYPE_PARENT` `TYPE_PARTNER` `TYPE_REFERRED_BY` `TYPE_RELATIVE` `TYPE_SISTER` `TYPE_SPOUSE`
String	`LABEL`	`DATA3`

TYPE

DATA2

Allowed values are:

TYPE_CUSTOM. Put the actual type in LABEL.
TYPE_ASSISTANT
TYPE_BROTHER
TYPE_CHILD
TYPE_DOMESTIC_PARTNER
TYPE_FATHER
TYPE_FRIEND
TYPE_MANAGER
TYPE_MOTHER
TYPE_PARENT
TYPE_PARTNER
TYPE_REFERRED_BY
TYPE_RELATIVE
TYPE_SISTER
TYPE_SPOUSE

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

`String`	`CARRIER_PRESENCE` Carrier presence information.
`int`	`CARRIER_PRESENCE_VT_CAPABLE` Indicates that the entry is Video Telephony (VT) capable on the current carrier.
`String`	`DATA1` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA10` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA11` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA12` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA13` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA14` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA15` Generic data column, the meaning is `MIMETYPE` specific.
`String`	`DATA2` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA3` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA4` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA5` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA6` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA7` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA8` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA9` Generic data column, the meaning is `MIMETYPE` specific
`String`	`DATA_VERSION` The version of this data record.
`String`	`IS_PRIMARY` Whether this is the primary entry of its kind for the raw contact it belongs to.
`String`	`IS_READ_ONLY` The "read-only" flag: "0" by default, "1" if the row cannot be modified or deleted except by a sync adapter.
`String`	`IS_SUPER_PRIMARY` Whether this is the primary entry of its kind for the aggregate contact it belongs to.
`String`	`MIMETYPE` The MIME type of the item represented by this row.
`String`	`RAW_CONTACT_ID` A reference to the `_ID` that this data belongs to.
`String`	`RES_PACKAGE` The package name to use when creating `Resources` objects for this data row.
`String`	`SYNC1` Generic column for use by sync adapters.
`String`	`SYNC2` Generic column for use by sync adapters.
`String`	`SYNC3` Generic column for use by sync adapters.
`String`	`SYNC4` Generic column for use by sync adapters.

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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this 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`

Interfaces

Classes

Exceptions

Most visited

Recently visited

Results for

ContactsContract.CommonDataKinds.Relation

Column aliases

Summary

Constants

Inherited constants

Public methods

Inherited methods

Constants

CONTENT_ITEM_TYPE

EXTRA_ADDRESS_BOOK_INDEX

EXTRA_ADDRESS_BOOK_INDEX_COUNTS

EXTRA_ADDRESS_BOOK_INDEX_TITLES

NAME

TYPE_ASSISTANT

TYPE_BROTHER

TYPE_CHILD

TYPE_DOMESTIC_PARTNER

TYPE_FATHER

TYPE_FRIEND

TYPE_MANAGER

TYPE_MOTHER

TYPE_PARENT

TYPE_PARTNER

TYPE_REFERRED_BY

TYPE_RELATIVE

TYPE_SISTER

TYPE_SPOUSE

Public methods

getTypeLabel

getTypeLabelResource