Class google.gdata.StructuredPostalAddress

Object
   |
   +--google.gdata.StructuredPostalAddress

class google.gdata.StructuredPostalAddress

Describes a structured postal address.
Defined in gdata.js

Field Detail

$agentClass_

Object $agentClass_

$cityClass_

Object $cityClass_

$countryClass_

Object $countryClass_

$formattedAddressClass_

Object $formattedAddressClass_

$housenameClass_

Object $housenameClass_

$neighborhoodClass_

Object $neighborhoodClass_

$poboxClass_

Object $poboxClass_

$postcodeClass_

Object $postcodeClass_

$regionClass_

Object $regionClass_

$streetClass_

Object $streetClass_

$subregionClass_

Object $subregionClass_

label

{string|undefined} label

Simple string value used to name this address. This attribute is optional.

mailClass

{string|undefined} mailClass

The mail class. This attribute is optional.

primary

{string|undefined} primary

Whether this is the primary postal address. This attribute is optional.

rel

{string|undefined} rel

The postal address type. This attribute is optional.

usage

{string|undefined} usage

The context for the address use. This attribute is optional.

MAILCLASS_BOTH

<static> <final> {string} MAILCLASS_BOTH

Both structured postal address.

MAILCLASS_LETTERS

<static> <final> {string} MAILCLASS_LETTERS

Letters structured postal address.

MAILCLASS_NEITHER

<static> <final> {string} MAILCLASS_NEITHER

Neither structured postal address.

MAILCLASS_PARCELS

<static> <final> {string} MAILCLASS_PARCELS

Parcels structured postal address.

REL_HOME

<static> <final> {string} REL_HOME

Home structured postal address.

REL_OTHER

<static> <final> {string} REL_OTHER

Other structured postal address.

REL_WORK

<static> <final> {string} REL_WORK

Work structured postal address.

USAGE_GENERAL

<static> <final> {string} USAGE_GENERAL

General structured postal address.

USAGE_LOCAL

<static> <final> {string} USAGE_LOCAL

Local structured postal address.

google.gdata.StructuredPostalAddress

google.gdata.StructuredPostalAddress(<Object> opt_params)

Constructs a structured postal address using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: agent, city, country, formattedAddress, housename, label, mailClass, neighborhood, pobox, postcode, primary, region, rel, street, subregion, and usage.

getAgent

google.gdata.Agent|undefined getAgent()

Returns the Used in work addresses. Also for 'in care of' or 'c/o'. This element is optional.

Returns:
Used in work addresses. Also for 'in care of' or 'c/o' or undefined for none.

getCity

google.gdata.City|undefined getCity()

Returns the Can be city, village, town, borough, etc. This element is optional.

Returns:
Can be city, village, town, borough, etc or undefined for none.

getCountry

google.gdata.Country|undefined getCountry()

Returns the The country name. This element is optional.

Returns:
The country name or undefined for none.

getFormattedAddress

google.gdata.FormattedAddress|undefined getFormattedAddress()

Returns the The full, unstructured address. This element is optional.

Returns:
The full, unstructured address or undefined for none.

getHousename

google.gdata.HouseName|undefined getHousename()

Returns the Used in places where houses or buildings have names. This element is optional.

Returns:
Used in places where houses or buildings have names or undefined for none.

getLabel

string|undefined getLabel()

Returns the Simple string value used to name this address. This attribute is optional.

Returns:
Simple string value used to name this address or undefined for none.

getMailClass

string|undefined getMailClass()

Returns the The mail class. This attribute is optional.

Returns:
The mail class or undefined for none.

getNeighborhood

google.gdata.Neighborhood|undefined getNeighborhood()

Returns the Neighborhood. Used to disambiguate a street. This element is optional.

Returns:
Neighborhood. Used to disambiguate a street or undefined for none.

getPobox

google.gdata.PoBox|undefined getPobox()

Returns the P.O. box. This element is optional.

Returns:
P.O. box or undefined for none.

getPostcode

google.gdata.PostCode|undefined getPostcode()

Returns the Postal code. This element is optional.

Returns:
Postal code or undefined for none.

getPrimary

boolean|undefined getPrimary()

Returns whether this is the primary postal address. This attribute is optional.

Returns:
Whether this is the primary postal address or undefined for none.

getRegion

google.gdata.Region|undefined getRegion()

Returns the Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc. This element is optional.

Returns:
Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc or undefined for none.

getRel

string|undefined getRel()

Returns the the postal address type. This attribute is optional.

Returns:
The postal address type or undefined for none.

getStreet

google.gdata.Street|undefined getStreet()

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

Returns:
Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number or undefined for none.

getSubregion

google.gdata.Subregion|undefined getSubregion()

Returns the Subregion is county (US), province (in Italy), etc. This element is optional.

Returns:
Subregion is county (US), province (in Italy), etc or undefined for none.

getUsage

string|undefined getUsage()

Returns the The context for the address use. This attribute is optional.

Returns:
The context for the address use or undefined for none.

setAgent

void setAgent(<google.gdata.Agent|Object|undefined> agent)

Sets the Used in work addresses. Also for 'in care of' or 'c/o'. This element is optional.

Parameters:
agent - Used in work addresses. Also for 'in care of' or 'c/o', or object to use as a parameter to the google.gdata.Agent constructor, or undefined for none.

setCity

void setCity(<google.gdata.City|Object|undefined> city)

Sets the Can be city, village, town, borough, etc. This element is optional.

Parameters:
city - Can be city, village, town, borough, etc, or object to use as a parameter to the google.gdata.City constructor, or undefined for none.

setCountry

void setCountry(<google.gdata.Country|Object|undefined> country)

Sets the The country name. This element is optional.

Parameters:
country - The country name, or object to use as a parameter to the google.gdata.Country constructor, or undefined for none.

setFormattedAddress

void setFormattedAddress(<google.gdata.FormattedAddress|Object|undefined> formattedAddress)

Sets the The full, unstructured address. This element is optional.

Parameters:
formattedAddress - The full, unstructured address, or object to use as a parameter to the google.gdata.FormattedAddress constructor, or undefined for none.

setHousename

void setHousename(<google.gdata.HouseName|Object|undefined> housename)

Sets the Used in places where houses or buildings have names. This element is optional.

Parameters:
housename - Used in places where houses or buildings have names, or object to use as a parameter to the google.gdata.HouseName constructor, or undefined for none.

setLabel

void setLabel(<string|undefined> label)

Sets the Simple string value used to name this address. This attribute is optional.

Parameters:
label - Simple string value used to name this address or undefined for none.

setMailClass

void setMailClass(<string|undefined> mailClass)

Sets the The mail class. This attribute is optional.

Parameters:
mailClass - The mail class or undefined for none.

setNeighborhood

void setNeighborhood(<google.gdata.Neighborhood|Object|undefined> neighborhood)

Sets the Neighborhood. Used to disambiguate a street. This element is optional.

Parameters:
neighborhood - Neighborhood. Used to disambiguate a street, or object to use as a parameter to the google.gdata.Neighborhood constructor, or undefined for none.

setPobox

void setPobox(<google.gdata.PoBox|Object|undefined> pobox)

Sets the P.O. box. This element is optional.

Parameters:
pobox - P.O. box, or object to use as a parameter to the google.gdata.PoBox constructor, or undefined for none.

setPostcode

void setPostcode(<google.gdata.PostCode|Object|undefined> postcode)

Sets the Postal code. This element is optional.

Parameters:
postcode - Postal code, or object to use as a parameter to the google.gdata.PostCode constructor, or undefined for none.

setPrimary

void setPrimary(<boolean|undefined> primary)

Sets whether this is the primary postal address. This attribute is optional.

Parameters:
primary - Whether this is the primary postal address or undefined for none.

setRegion

void setRegion(<google.gdata.Region|Object|undefined> region)

Sets the Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc. This element is optional.

Parameters:
region - Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc, or object to use as a parameter to the google.gdata.Region constructor, or undefined for none.

setRel

void setRel(<string|undefined> rel)

Sets the the postal address type. This attribute is optional.

Parameters:
rel - The postal address type or undefined for none.

setStreet

void setStreet(<google.gdata.Street|Object|undefined> street)

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

Parameters:
street - Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number, or object to use as a parameter to the google.gdata.Street constructor, or undefined for none.

setSubregion

void setSubregion(<google.gdata.Subregion|Object|undefined> subregion)

Sets the Subregion is county (US), province (in Italy), etc. This element is optional.

Parameters:
subregion - Subregion is county (US), province (in Italy), etc, or object to use as a parameter to the google.gdata.Subregion constructor, or undefined for none.

setUsage

void setUsage(<string|undefined> usage)

Sets the The context for the address use. This attribute is optional.

Parameters:
usage - The context for the address use or undefined for none.