Skip to content

Most visited

Recently visited

navigation
Added in API level 5

ContactsContract.CommonDataKinds.StructuredPostal

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

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


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

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

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.

Inherited methods

From class java.lang.Object

Constants

CITY

Added in API level 5
String CITY

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"

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

CONTENT_TYPE

Added in API level 5
String CONTENT_TYPE

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

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

COUNTRY

Added in API level 5
String COUNTRY

The name or code of the country.

Type: TEXT

Constant Value: "data10"

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"

FORMATTED_ADDRESS

Added in API level 5
String FORMATTED_ADDRESS

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

Type: TEXT

Constant Value: "data1"

NEIGHBORHOOD

Added in API level 5
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. In China it could be a county or a minor city.

Type: TEXT

Constant Value: "data6"

POBOX

Added in API level 5
String POBOX

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

Type: TEXT

Constant Value: "data5"

POSTCODE

Added in API level 5
String POSTCODE

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

Type: TEXT

Constant Value: "data9"

REGION

Added in API level 5
String REGION

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

Type: TEXT

Constant Value: "data8"

STREET

Added in API level 5
String STREET

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

Type: TEXT

Constant Value: "data4"

TYPE_HOME

Added in API level 5
int TYPE_HOME

Constant Value: 1 (0x00000001)

TYPE_OTHER

Added in API level 5
int TYPE_OTHER

Constant Value: 3 (0x00000003)

TYPE_WORK

Added in API level 5
int TYPE_WORK

Constant Value: 2 (0x00000002)

Fields

CONTENT_URI

Added in API level 5
Uri CONTENT_URI

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

Public methods

getTypeLabel

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