Class google.gdata.PostalAddress

Object
   |
   +--google.gdata.PostalAddress

class google.gdata.PostalAddress

Describes a postal address.
Defined in gdata.js

Field Detail

$t

{string|undefined} $t

Address string. This attribute is required.

label

{string|undefined} label

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

primary

{string|undefined} primary

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

rel

{string|undefined} rel

Postal address type. This attribute is optional.

REL_HOME

<static> <final> {string} REL_HOME

Home address.

REL_OTHER

<static> <final> {string} REL_OTHER

Other address.

REL_WORK

<static> <final> {string} REL_WORK

Work address.

google.gdata.PostalAddress

google.gdata.PostalAddress(<Object> opt_params)

Constructs a 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: label, primary, rel, and value.

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.

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.

getRel

string|undefined getRel()

Returns the postal address type. This attribute is optional.

Returns:
Postal address type or undefined for none.

getValue

string|undefined getValue()

Returns the address string. This attribute is required.

Returns:
Address string 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.

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.

setRel

void setRel(<string|undefined> rel)

Sets the postal address type. This attribute is optional.

Parameters:
rel - Postal address type or undefined for none.

setValue

void setValue(<string|undefined> value)

Sets the address string. This attribute is required.

Parameters:
value - Address string or undefined for none.