Added in API level 5

Relation

class Relation : ContactsContract.DataColumnsWithJoins, ContactsContract.CommonDataKinds.CommonColumns
kotlin.Any
   ↳ 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 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 of the relative as the user entered it.
static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

Inherited constants
Public methods
static CharSequence!
getTypeLabel(res: Resources!, type: Int, label: CharSequence?)

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

Return the string resource that best describes the given TYPE.

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/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. 

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 of the relative as the user entered it.

Type: TEXT

Value: "data1"

TYPE_ASSISTANT

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

TYPE_BROTHER

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

TYPE_CHILD

Added in API level 5
static val TYPE_CHILD: Int
 
Value: 3

TYPE_DOMESTIC_PARTNER

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

TYPE_FATHER

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

TYPE_FRIEND

Added in API level 5
static val TYPE_FRIEND: Int
 
Value: 6

TYPE_MANAGER

Added in API level 5
static val TYPE_MANAGER: Int
 
Value: 7

TYPE_MOTHER

Added in API level 5
static val TYPE_MOTHER: Int
 
Value: 8

TYPE_PARENT

Added in API level 5
static val TYPE_PARENT: Int
 
Value: 9

TYPE_PARTNER

Added in API level 5
static val TYPE_PARTNER: Int
 
Value: 10

TYPE_REFERRED_BY

Added in API level 5
static val TYPE_REFERRED_BY: Int
 
Value: 11

TYPE_RELATIVE

Added in API level 5
static val TYPE_RELATIVE: Int
 
Value: 12

TYPE_SISTER

Added in API level 5
static val TYPE_SISTER: Int
 
Value: 13

TYPE_SPOUSE

Added in API level 5
static val TYPE_SPOUSE: Int
 
Value: 14

Public methods

getTypeLabel

Added in API level 11
static fun getTypeLabel(
    res: Resources!, 
    type: Int, 
    label: CharSequence?
): CharSequence!

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

Parameters
label CharSequence?: This value may be null.

getTypeLabelResource

Added in API level 11
static fun getTypeLabelResource(type: Int): Int

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