ContactsContract.CommonDataKinds.StructuredPostal
public
static
final
class
ContactsContract.CommonDataKinds.StructuredPostal
extends Object
implements
ContactsContract.CommonDataKinds.CommonColumns,
ContactsContract.DataColumnsWithJoins
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 | Alias | Data column | |
---|---|---|---|
String | FORMATTED_ADDRESS |
ContactsContract.DataColumns.DATA1 |
|
int | ContactsContract.CommonDataKinds.CommonColumns.TYPE |
ContactsContract.DataColumns.DATA2 |
Allowed values are:
|
String | ContactsContract.CommonDataKinds.CommonColumns.LABEL |
ContactsContract.DataColumns.DATA3 |
|
String | STREET |
ContactsContract.DataColumns.DATA4 |
|
String | POBOX |
ContactsContract.DataColumns.DATA5 |
Post Office Box number |
String | NEIGHBORHOOD |
ContactsContract.DataColumns.DATA6 |
|
String | CITY |
ContactsContract.DataColumns.DATA7 |
|
String | REGION |
ContactsContract.DataColumns.DATA8 |
|
String | POSTCODE |
ContactsContract.DataColumns.DATA9 |
|
String | COUNTRY |
ContactsContract.DataColumns.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 |
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fields | |
---|---|
public
static
final
Uri |
CONTENT_URI
The content:// style URI for all data records of the
|
Public methods | |
---|---|
static
CharSequence
|
getTypeLabel(Resources res, int type, CharSequence label)
Return a |
static
int
|
getTypeLabelResource(int type)
Return the string resource that best describes the given
|
Inherited methods | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Constants
CITY
public static final 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
public static final String CONTENT_ITEM_TYPE
MIME type used when storing this in data table.
Constant Value: "vnd.android.cursor.item/postal-address_v2"
CONTENT_TYPE
public static final 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
public static final String COUNTRY
The name or code of the country.
Type: TEXT
Constant Value: "data10"
EXTRA_ADDRESS_BOOK_INDEX
public static final 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
public static final 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
public static final 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
public static final String FORMATTED_ADDRESS
The full, unstructured postal address. This field must be consistent with any structured data.
Type: TEXT
Constant Value: "data1"
NEIGHBORHOOD
public static final 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
public static final 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
public static final 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
public static final String REGION
A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
Type: TEXT
Constant Value: "data8"
STREET
public static final 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"
Fields
CONTENT_URI
public static final Uri CONTENT_URI
The content:// style URI for all data records of the
StructuredPostal.CONTENT_ITEM_TYPE
MIME type.
Public methods
getTypeLabel
public static CharSequence getTypeLabel (Resources res, int type, CharSequence label)
Return a CharSequence
that best describes the given type,
possibly substituting the given ContactsContract.CommonDataKinds.CommonColumns.LABEL
value
for ContactsContract.CommonDataKinds.BaseTypes.TYPE_CUSTOM
.
Parameters | |
---|---|
res |
Resources |
type |
int |
label |
CharSequence : This value may be null . |
Returns | |
---|---|
CharSequence |
getTypeLabelResource
public static int getTypeLabelResource (int type)
Return the string resource that best describes the given
ContactsContract.CommonDataKinds.CommonColumns.TYPE
. Will always return a valid resource.
Parameters | |
---|---|
type |
int |
Returns | |
---|---|
int |