NeedsExamples
opensocial.Address
Base interface for all address objects.
Methods
opensocial.Address.getField
;String getField(key, opt_params)
Parameters
NameTypeDescription |
key |
String |
The key to get data for; keys are defined in Address.Field |
|
opt_params |
Map.<opensocial.DataRequest.DataRequestFields |
Object> |
Additional params to pass to the request |
Returns
TypeDescription |
String |
The data |
Description
Gets data for this body type that is associated with the specified key.
opensocial.Address.Field
All of the fields that an address has. These are the supported keys for the Address.getField() method.
opensocial.Address.Field.COUNTRY
The country, specified as a string. This field may be used interchangeably with the string 'country'.
opensocial.Address.Field.EXTENDED_ADDRESS
<static> Member of: 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.LATITUDE
The latitude, specified as a number. This field may be used interchangeably with the string 'latitude'.
opensocial.Address.Field.LOCALITY
The locality, specified as a string. This field may be used interchangeably with the string 'locality'.
opensocial.Address.Field.LONGITUDE
The longitude, specified as a number. This field may be used interchangeably with the string 'longitude'.
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.POSTAL_CODE
The postal code, specified as a string. This field may be used interchangeably with the string 'postalCode'.
opensocial.Address.Field.REGION
The region, specified as a string. This field may be used interchangeably with the string 'region'.
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.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
<static> Member of: 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'.
{{ JsApiAlphaList_(v0.9) }}