Address

The Address object represents an address used for a contact or for use with launching the BlackBerry Maps application.

Supported Platform(s)

- BlackBerry OS 5.0+

- Ripple Emulator

View Supported Platform Table

API	BB5.0	BB6.0	BB7.0	Ripple
blackberry.pim.Address	Y	Y	Y	Y
address1	Y	Y	Y	Y
address2	Y	Y	Y	Y
city	Y	Y	Y	Y
country	Y	Y	Y	Y
stateProvince	Y	Y	Y	Y
zipPostal	Y	Y	Y	Y

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

You must declare the feature element(s) below in your configuration document:

Feature ID	BB5.0	BB6.0	BB7.0	PB1.0	PB2.0	BB10	Ripple
<feature id="blackberry.pim.Address" />	Y	Y	Y				Y

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Constructors

blackberry.pim.Address

Properties

String	address1
String	address2
String	city
String	country
String	stateProvince
String	zipPostal

Constructors

blackberry.pim.Address ()

The Address object is an instance object. If a new instance is desired, it must be created using the new keyword.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Code Example:

<script type="text/javascript">
  if (blackberry.system.hasCapability("location.maps")) {
    // Create our address 
    var homeAddress = new blackberry.pim.Address();
    homeAddress.country = "Canada";
    homeAddress.stateProvince = "Ontario";
    homeAddress.city = "Waterloo";  

    // Open our maps 
    var args = new blackberry.invoke.MapsArguments(homeAddress);
    blackberry.invoke.invoke(blackberry.invoke.APP_MAPS, args);  // Maps
  }
</script>

Properties

String address1

Contains the street of a particular address.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

String address2

Contains the extra street information of a particular address.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

String city

Contains the locality information of a particular address; for example a town, city, or county.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

String country

Contains the country of a particular address.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

String stateProvince

Contains the region information (such as province, state, or territory) of a particular address.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

String zipPostal

Contains the postal code or zip code of a pariticular address.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:30 GMT-0500 (EST)