|
GData JavaScript Client 1.10 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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 |
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
{string|undefined} mailClass
{string|undefined} primary
{string|undefined} rel
{string|undefined} usage
<static> <final> {string} MAILCLASS_BOTH
<static> <final> {string} MAILCLASS_LETTERS
<static> <final> {string} MAILCLASS_NEITHER
<static> <final> {string} MAILCLASS_PARCELS
<static> <final> {string} REL_HOME
<static> <final> {string} REL_OTHER
<static> <final> {string} REL_WORK
<static> <final> {string} USAGE_GENERAL
<static> <final> {string} USAGE_LOCAL
Constructor Detail |
google.gdata.StructuredPostalAddress(<Object> opt_params)
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.
Method Detail |
google.gdata.Agent|undefined getAgent()
google.gdata.City|undefined getCity()
google.gdata.Country|undefined getCountry()
google.gdata.FormattedAddress|undefined getFormattedAddress()
google.gdata.HouseName|undefined getHousename()
string|undefined getLabel()
string|undefined getMailClass()
google.gdata.Neighborhood|undefined getNeighborhood()
google.gdata.PoBox|undefined getPobox()
google.gdata.PostCode|undefined getPostcode()
boolean|undefined getPrimary()
google.gdata.Region|undefined getRegion()
string|undefined getRel()
google.gdata.Street|undefined getStreet()
google.gdata.Subregion|undefined getSubregion()
string|undefined getUsage()
void setAgent(<google.gdata.Agent|Object|undefined> agent)
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.
void setCity(<google.gdata.City|Object|undefined> city)
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.
void setCountry(<google.gdata.Country|Object|undefined> country)
country
- The country name, or object to use as a parameter to the google.gdata.Country constructor, or undefined for none.
void setFormattedAddress(<google.gdata.FormattedAddress|Object|undefined> formattedAddress)
formattedAddress
- The full, unstructured address, or object to use as a parameter to the google.gdata.FormattedAddress constructor, or undefined for none.
void setHousename(<google.gdata.HouseName|Object|undefined> housename)
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.
void setLabel(<string|undefined> label)
label
- Simple string value used to name this address or undefined for none.
void setMailClass(<string|undefined> mailClass)
mailClass
- The mail class or undefined for none.
void setNeighborhood(<google.gdata.Neighborhood|Object|undefined> neighborhood)
neighborhood
- Neighborhood. Used to disambiguate a street, or object to use as a parameter to the google.gdata.Neighborhood constructor, or undefined for none.
void setPobox(<google.gdata.PoBox|Object|undefined> pobox)
pobox
- P.O. box, or object to use as a parameter to the google.gdata.PoBox constructor, or undefined for none.
void setPostcode(<google.gdata.PostCode|Object|undefined> postcode)
postcode
- Postal code, or object to use as a parameter to the google.gdata.PostCode constructor, or undefined for none.
void setPrimary(<boolean|undefined> primary)
primary
- Whether this is the primary postal address or undefined for none.
void setRegion(<google.gdata.Region|Object|undefined> region)
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.
void setRel(<string|undefined> rel)
rel
- The postal address type or undefined for none.
void setStreet(<google.gdata.Street|Object|undefined> street)
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.
void setSubregion(<google.gdata.Subregion|Object|undefined> subregion)
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.
void setUsage(<string|undefined> usage)
usage
- The context for the address use or undefined for none.
|
GData JavaScript Client 1.10 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |