GData JavaScript Client 2.2

Class google.gdata.StructuredPostalAddress

Object
   |
   +--google.gdata.StructuredPostalAddress

class google.gdata.StructuredPostalAddress


Describes a structured postal address.
Defined in gdata.js


Field Summary
 Object $agentClass_
          
 Object $cityClass_
          
 Object $countryClass_
          
 Object $formattedAddressClass_
          
 Object $housenameClass_
          
 Object $neighborhoodClass_
          
 Object $poboxClass_
          
 Object $postcodeClass_
          
 Object $regionClass_
          
 Object $streetClass_
          
 Object $subregionClass_
          
 {string|undefined} label
          Simple string value used to name this address.
 {string|undefined} mailClass
          The mail class.
 {string|undefined} primary
          Whether this is the primary postal address.
 {string|undefined} rel
          The postal address type.
 {string|undefined} usage
          The context for the address use.
<static>  <final> {string} MAILCLASS_BOTH
          Both structured postal address.
<static>  <final> {string} MAILCLASS_LETTERS
          Letters structured postal address.
<static>  <final> {string} MAILCLASS_NEITHER
          Neither structured postal address.
<static>  <final> {string} MAILCLASS_PARCELS
          Parcels structured postal address.
<static>  <final> {string} REL_HOME
          Home structured postal address.
<static>  <final> {string} REL_OTHER
          Other structured postal address.
<static>  <final> {string} REL_WORK
          Work structured postal address.
<static>  <final> {string} USAGE_GENERAL
          General structured postal address.
<static>  <final> {string} USAGE_LOCAL
          Local structured postal address.
 
Constructor Summary
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.
 
Method Summary
 google.gdata.Agent|undefined getAgent()
           Returns the Used in work addresses.
 google.gdata.City|undefined getCity()
           Returns the Can be city, village, town, borough, etc.
 google.gdata.Country|undefined getCountry()
           Returns the The country name.
 google.gdata.FormattedAddress|undefined getFormattedAddress()
           Returns the The full, unstructured address.
 google.gdata.HouseName|undefined getHousename()
           Returns the Used in places where houses or buildings have names.
 string|undefined getLabel()
           Returns the Simple string value used to name this address.
 string|undefined getMailClass()
           Returns the The mail class.
 google.gdata.Neighborhood|undefined getNeighborhood()
           Returns the Neighborhood.
 google.gdata.PoBox|undefined getPobox()
           Returns the P.O.
 google.gdata.PostCode|undefined getPostcode()
           Returns the Postal code.
 boolean|undefined getPrimary()
           Returns whether this is the primary postal address.
 google.gdata.Region|undefined getRegion()
           Returns the Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
 string|undefined getRel()
           Returns the the postal address type.
 google.gdata.Street|undefined getStreet()
           Returns the Can be street, avenue, road, etc.
 google.gdata.Subregion|undefined getSubregion()
           Returns the Subregion is county (US), province (in Italy), etc.
 string|undefined getUsage()
           Returns the The context for the address use.
 void setAgent(<google.gdata.Agent|Object|undefined> agent)
           Sets the Used in work addresses.
 void setCity(<google.gdata.City|Object|undefined> city)
           Sets the Can be city, village, town, borough, etc.
 void setCountry(<google.gdata.Country|Object|undefined> country)
           Sets the The country name.
 void setFormattedAddress(<google.gdata.FormattedAddress|Object|undefined> formattedAddress)
           Sets the The full, unstructured address.
 void setHousename(<google.gdata.HouseName|Object|undefined> housename)
           Sets the Used in places where houses or buildings have names.
 void setLabel(<string|undefined> label)
           Sets the Simple string value used to name this address.
 void setMailClass(<string|undefined> mailClass)
           Sets the The mail class.
 void setNeighborhood(<google.gdata.Neighborhood|Object|undefined> neighborhood)
           Sets the Neighborhood.
 void setPobox(<google.gdata.PoBox|Object|undefined> pobox)
           Sets the P.O.
 void setPostcode(<google.gdata.PostCode|Object|undefined> postcode)
           Sets the Postal code.
 void setPrimary(<boolean|undefined> primary)
           Sets whether this is the primary postal address.
 void setRegion(<google.gdata.Region|Object|undefined> region)
           Sets the Region is state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
 void setRel(<string|undefined> rel)
           Sets the the postal address type.
 void setStreet(<google.gdata.Street|Object|undefined> street)
           Sets the Can be street, avenue, road, etc.
 void setSubregion(<google.gdata.Subregion|Object|undefined> subregion)
           Sets the Subregion is county (US), province (in Italy), etc.
 void setUsage(<string|undefined> usage)
           Sets the The context for the address use.

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

mailClass

{string|undefined} mailClass

primary

{string|undefined} primary

rel

{string|undefined} rel

usage

{string|undefined} usage

MAILCLASS_BOTH

<static> <final> {string} MAILCLASS_BOTH

MAILCLASS_LETTERS

<static> <final> {string} MAILCLASS_LETTERS

MAILCLASS_NEITHER

<static> <final> {string} MAILCLASS_NEITHER

MAILCLASS_PARCELS

<static> <final> {string} MAILCLASS_PARCELS

REL_HOME

<static> <final> {string} REL_HOME

REL_OTHER

<static> <final> {string} REL_OTHER

REL_WORK

<static> <final> {string} REL_WORK

USAGE_GENERAL

<static> <final> {string} USAGE_GENERAL

USAGE_LOCAL

<static> <final> {string} USAGE_LOCAL

Constructor Detail

google.gdata.StructuredPostalAddress

google.gdata.StructuredPostalAddress(<Object> opt_params)

Method Detail

getAgent

google.gdata.Agent|undefined getAgent()

getCity

google.gdata.City|undefined getCity()

getCountry

google.gdata.Country|undefined getCountry()

getFormattedAddress

google.gdata.FormattedAddress|undefined getFormattedAddress()

getHousename

google.gdata.HouseName|undefined getHousename()

getLabel

string|undefined getLabel()

getMailClass

string|undefined getMailClass()

getNeighborhood

google.gdata.Neighborhood|undefined getNeighborhood()

getPobox

google.gdata.PoBox|undefined getPobox()

getPostcode

google.gdata.PostCode|undefined getPostcode()

getPrimary

boolean|undefined getPrimary()

getRegion

google.gdata.Region|undefined getRegion()

getRel

string|undefined getRel()

getStreet

google.gdata.Street|undefined getStreet()

getSubregion

google.gdata.Subregion|undefined getSubregion()

getUsage

string|undefined getUsage()

setAgent

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

setCity

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

setCountry

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

setFormattedAddress

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

setHousename

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

setLabel

void setLabel(<string|undefined> label)

setMailClass

void setMailClass(<string|undefined> mailClass)

setNeighborhood

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

setPobox

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

setPostcode

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

setPrimary

void setPrimary(<boolean|undefined> primary)

setRegion

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

setRel

void setRel(<string|undefined> rel)

setStreet

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

setSubregion

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

setUsage

void setUsage(<string|undefined> usage)

GData JavaScript Client 2.2

Documentation generated by JSDoc on Mon Dec 14 15:04:11 2009