# ContactsContract.CommonDataKinds.Relation Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # Relation *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/provider/ContactsContract.CommonDataKinds.Relation "View this page in Java") ``` class Relation : ContactsContract.CommonDataKinds.CommonColumns, ContactsContract.DataColumnsWithJoins ``` |---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.provider.ContactsContract.CommonDataKinds.Relation](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#) | A data kind representing a relation. You can use all columns defined for[ContactsContract.Data](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.Data)as well as the following aliases. ## Column aliases | Type | Alias | Data column || |--------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | String | [NAME](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#NAME:kotlin.String) | [DATA1](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.DataColumns#DATA1:kotlin.String) | | | int | [TYPE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#TYPE:kotlin.String) | [DATA2](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.DataColumns#DATA2:kotlin.String) | Allowed values are:
- [TYPE_CUSTOM](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.BaseTypes#TYPE_CUSTOM:kotlin.Int). Put the actual type in[LABEL](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#LABEL:kotlin.String). - [TYPE_ASSISTANT](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_ASSISTANT:kotlin.Int) - [TYPE_BROTHER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_BROTHER:kotlin.Int) - [TYPE_CHILD](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_CHILD:kotlin.Int) - [TYPE_DOMESTIC_PARTNER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_DOMESTIC_PARTNER:kotlin.Int) - [TYPE_FATHER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_FATHER:kotlin.Int) - [TYPE_FRIEND](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_FRIEND:kotlin.Int) - [TYPE_MANAGER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_MANAGER:kotlin.Int) - [TYPE_MOTHER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_MOTHER:kotlin.Int) - [TYPE_PARENT](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_PARENT:kotlin.Int) - [TYPE_PARTNER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_PARTNER:kotlin.Int) - [TYPE_REFERRED_BY](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_REFERRED_BY:kotlin.Int) - [TYPE_RELATIVE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_RELATIVE:kotlin.Int) - [TYPE_SISTER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_SISTER:kotlin.Int) - [TYPE_SPOUSE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_SPOUSE:kotlin.Int)
| | String | [LABEL](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#LABEL:kotlin.String) | [DATA3](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.DataColumns#DATA3:kotlin.String) | | ## Summary | Constants || |----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [CONTENT_ITEM_TYPE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#CONTENT_ITEM_TYPE:kotlin.String) MIME type used when storing this in data table. | | static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [EXTRA_ADDRESS_BOOK_INDEX](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#EXTRA_ADDRESS_BOOK_INDEX:kotlin.String) Add this query parameter to a URI to get back row counts grouped by the address book index as cursor extras. | | static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [EXTRA_ADDRESS_BOOK_INDEX_COUNTS](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#EXTRA_ADDRESS_BOOK_INDEX_COUNTS:kotlin.String) The array of group counts for the corresponding group. | | static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [EXTRA_ADDRESS_BOOK_INDEX_TITLES](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#EXTRA_ADDRESS_BOOK_INDEX_TITLES:kotlin.String) The array of address book index titles, which are returned in the same order as the data in the cursor. | | static[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [NAME](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#NAME:kotlin.String) The name of the relative as the user entered it. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_ASSISTANT](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_ASSISTANT:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_BROTHER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_BROTHER:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_CHILD](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_CHILD:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_DOMESTIC_PARTNER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_DOMESTIC_PARTNER:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_FATHER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_FATHER:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_FRIEND](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_FRIEND:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_MANAGER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_MANAGER:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_MOTHER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_MOTHER:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_PARENT](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_PARENT:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_PARTNER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_PARTNER:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_REFERRED_BY](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_REFERRED_BY:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_RELATIVE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_RELATIVE:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_SISTER](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_SISTER:kotlin.Int)
| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_SPOUSE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#TYPE_SPOUSE:kotlin.Int)
| | Inherited constants || |---|---| | From class[CommonColumns](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns) |----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [DATA](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#DATA:kotlin.String)
The data for the contact method. Type: TEXT
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [LABEL](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#LABEL:kotlin.String)
The user defined label for the the contact method. Type: TEXT
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [TYPE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#TYPE:kotlin.String)
The type of data, for example Home or Work. Type: INTEGER
| || | From class[BaseTypes](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.BaseTypes) |----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [TYPE_CUSTOM](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.BaseTypes#TYPE_CUSTOM:kotlin.Int)
A custom type. The custom label should be supplied by user.
| || | Public methods || |------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | static[CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)! | [getTypeLabel](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#getTypeLabel(android.content.res.Resources,%20kotlin.Int,%20kotlin.CharSequence))`(`res:` `[Resources](https://developer.android.com/reference/kotlin/android/content/res/Resources.html#)!`, `type:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `label:` `[CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)?`)` Return a[CharSequence](https://developer.android.com/reference/kotlin/java/lang/CharSequence.html#)that best describes the given type, possibly substituting the given[LABEL](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#LABEL:kotlin.String)value for[TYPE_CUSTOM](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.BaseTypes#TYPE_CUSTOM:kotlin.Int). | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getTypeLabelResource](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.Relation#getTypeLabelResource(kotlin.Int))`(`type:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Return the string resource that best describes the given[TYPE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#TYPE:kotlin.String). | ## Constants ### CONTENT_ITEM_TYPE Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val CONTENT_ITEM_TYPE: String ``` MIME type used when storing this in data table. Value: "vnd.android.cursor.item/relation" ### 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.
```kotlin 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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val NAME: String ``` The name of the relative as the user entered it. Type: TEXT Value: "data1" ### TYPE_ASSISTANT Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_ASSISTANT: Int ``` Value: 1 ### TYPE_BROTHER Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_BROTHER: Int ``` Value: 2 ### TYPE_CHILD Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_CHILD: Int ``` Value: 3 ### TYPE_DOMESTIC_PARTNER Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_DOMESTIC_PARTNER: Int ``` Value: 4 ### TYPE_FATHER Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_FATHER: Int ``` Value: 5 ### TYPE_FRIEND Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_FRIEND: Int ``` Value: 6 ### TYPE_MANAGER Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_MANAGER: Int ``` Value: 7 ### TYPE_MOTHER Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_MOTHER: Int ``` Value: 8 ### TYPE_PARENT Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_PARENT: Int ``` Value: 9 ### TYPE_PARTNER Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_PARTNER: Int ``` Value: 10 ### TYPE_REFERRED_BY Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_REFERRED_BY: Int ``` Value: 11 ### TYPE_RELATIVE Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_RELATIVE: Int ``` Value: 12 ### TYPE_SISTER Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_SISTER: Int ``` Value: 13 ### TYPE_SPOUSE Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val TYPE_SPOUSE: Int ``` Value: 14 ## Public methods ### getTypeLabel Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static fun getTypeLabel(     res: Resources!,     type: Int,     label: CharSequence? ): CharSequence! ``` Return a[CharSequence](https://developer.android.com/reference/kotlin/java/lang/CharSequence.html#)that best describes the given type, possibly substituting the given[LABEL](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#LABEL:kotlin.String)value for[TYPE_CUSTOM](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.BaseTypes#TYPE_CUSTOM:kotlin.Int). | Parameters || |---------|-------------------------------------------------------------------------------------------------------------------------| | `label` | [CharSequence](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html)?:This value may be`null`. | ### getTypeLabelResource Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static fun getTypeLabelResource(type: Int): Int ``` Return the string resource that best describes the given[TYPE](https://developer.android.com/reference/kotlin/android/provider/ContactsContract.CommonDataKinds.CommonColumns#TYPE:kotlin.String). Will always return a valid resource.