Opensocial.Address (v0.8)
From OpenSocial
 |
This page does not include any example code. Please help improve this page by adding examples. (November 2008) |
opensocial.Address
Base interface for all address objects.
Methods
opensocial.Address.getField
opensocial.Address.getField(key, opt_params)- Parameters
String key- The key to get data for; keys are defined in opensocial.Address.FieldMap.<opensocial.DataRequest.DataRequestFields, Object> opt_params- Additional params to pass to the request- Returns
String- The data
Fields
opensocial.Address.Field.TYPE
The address type or label, specified as a string. Examples: work, my favorite store, my house, etc. This field may be used interchangeably with the string 'type'.
opensocial.Address.Field.UNSTRUCTURED_ADDRESS
If the container does not have structured addresses in its data store, this field contains the unstructured address that the user entered, specified as a string. Use opensocial.getEnvironment().supportsField to see which fields are supported. This field may be used interchangeably with the string 'unstructuredAddress'.
opensocial.Address.Field.PO_BOX
The P.O. box of the address, if there is one; specified as a string. This field may be used interchangeably with the string 'poBox'.
opensocial.Address.Field.STREET_ADDRESS
The street address, specified as a string. This field may be used interchangeably with the string 'streetAddress'.
opensocial.Address.Field.EXTENDED_ADDRESS
The extended street address, specified as a string. This field may be used interchangeably with the string 'extendedAddress'.
opensocial.Address.Field.REGION
The region, specified as a string. This field may be used interchangeably with the string 'region'.
opensocial.Address.Field.LOCALITY
The locality, specified as a string. This field may be used interchangeably with the string 'locality'.
opensocial.Address.Field.POSTAL_CODE
The postal code, specified as a string. This field may be used interchangeably with the string 'postalCode'.
opensocial.Address.Field.COUNTRY
The country, specified as a string. This field may be used interchangeably with the string 'country'.
opensocial.Address.Field.LATITUDE
The latitude, specified as a number. This field may be used interchangeably with the string 'latitude'.
opensocial.Address.Field.LONGITUDE
The longitude, specified as a number. This field may be used interchangeably with the string 'longitude'.
Examples
example goes here
|
OpenSocial 0.8 |
|||
|
opensocial.Address |
|||
