Android APIs
public static final class

ContactsContract.CommonDataKinds.StructuredPostal

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

Class Overview

A data kind representing a postal addresses.

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

Column aliases

Type AliasData column
String FORMATTED_ADDRESS DATA1
int TYPE DATA2 Allowed values are:

String LABEL DATA3
String STREET DATA4
String POBOX DATA5 Post Office Box number
String NEIGHBORHOOD DATA6
String CITY DATA7
String REGION DATA8
String POSTCODE DATA9
String COUNTRY DATA10

Summary

Constants
String CITY Can be city, village, town, borough, etc.
String CONTENT_ITEM_TYPE MIME type used when storing this in data table.
String CONTENT_TYPE The MIME type of CONTENT_URI providing a directory of postal addresses.
String COUNTRY The name or code of the country.
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 FORMATTED_ADDRESS The full, unstructured postal address.
String NEIGHBORHOOD This is used to disambiguate a street address when a city contains more than one street with the same name, or to specify a small place whose mail is routed through a larger postal town.
String POBOX Covers actual P.O.
String POSTCODE Postal code.
String REGION A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
String STREET Can be street, avenue, road, etc.
int TYPE_HOME
int TYPE_OTHER
int TYPE_WORK
[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
Fields
public static final Uri CONTENT_URI The content:// style URI for all data records of the CONTENT_ITEM_TYPE MIME type.
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 CITY

Added in API level 5

Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.

Type: TEXT

Constant Value: "data7"

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/postal-address_v2"

public static final String CONTENT_TYPE

Added in API level 5

The MIME type of CONTENT_URI providing a directory of postal addresses.

Constant Value: "vnd.android.cursor.dir/postal-address_v2"

public static final String COUNTRY

Added in API level 5

The name or code of the country.

Type: TEXT

Constant Value: "data10"

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 FORMATTED_ADDRESS

Added in API level 5

The full, unstructured postal address. This field must be consistent with any structured data.

Type: TEXT

Constant Value: "data1"

public static final String NEIGHBORHOOD

Added in API level 5

This is used to disambiguate a street address when a city contains more than one street with the same name, or to specify a small place whose mail is routed through a larger postal town. In China it could be a county or a minor city.

Type: TEXT

Constant Value: "data6"

public static final String POBOX

Added in API level 5

Covers actual P.O. boxes, drawers, locked bags, etc. This is usually but not always mutually exclusive with street.

Type: TEXT

Constant Value: "data5"

public static final String POSTCODE

Added in API level 5

Postal code. Usually country-wide, but sometimes specific to the city (e.g. "2" in "Dublin 2, Ireland" addresses).

Type: TEXT

Constant Value: "data9"

public static final String REGION

Added in API level 5

A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.

Type: TEXT

Constant Value: "data8"

public static final String STREET

Added in API level 5

Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.

Type: TEXT

Constant Value: "data4"

public static final int TYPE_HOME

Added in API level 5

Constant Value: 1 (0x00000001)

public static final int TYPE_OTHER

Added in API level 5

Constant Value: 3 (0x00000003)

public static final int TYPE_WORK

Added in API level 5

Constant Value: 2 (0x00000002)

Fields

public static final Uri CONTENT_URI

Added in API level 5

The content:// style URI for all data records of the CONTENT_ITEM_TYPE MIME type.

Public Methods

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

Added in API level 5

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 5

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