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

APIOS 5.0OS 6.0OS 7.0PlayBookRipple
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 IDOS 5.0OS 6.0OS 7.0PlayBookRipple
<feature id="blackberry.pim.Address" /> Y Y Y  Y

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

blackberry.pim.Address

blackberry.pim.Address ()

Supported Platform(s)

 - BlackBerry OS 5.0+
 - Ripple Emulator

Description

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



Code Example(s)

<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:

Property Type Description Supported Platform(s)
address1 String Contains the street of a particular address.
 - BlackBerry OS 5.0+
 - Ripple Emulator
address2 String Contains the extra street information of a particular address.
 - BlackBerry OS 5.0+
 - Ripple Emulator
city String Contains the locality information of a particular address; for example a town, city, or county.
 - BlackBerry OS 5.0+
 - Ripple Emulator
country String Contains the country of a particular address.
 - BlackBerry OS 5.0+
 - Ripple Emulator
stateProvince String Contains the region information (such as province, state, or territory) of a particular address.
 - BlackBerry OS 5.0+
 - Ripple Emulator
zipPostal String Contains the postal code or zip code of a pariticular address.
 - BlackBerry OS 5.0+
 - Ripple Emulator
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:15 GMT-0500 (EST)