MapsArguments

The MapsArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the Maps application.


Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
blackberry.invoke.MapsArguments Y Y Y      Y
blackberry.invoke.MapsArguments Y Y Y      Y
blackberry.invoke.MapsArguments Y          Y
blackberry.invoke.MapsArguments 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 IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.invoke" /> Y Y Y      Y
<feature id="blackberry.invoke.MapsArguments" /> Y Y Y      Y
<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.invoke.MapsArguments (latitude : Number, longitude : Number)

The MapsArguments object must be created as an instance using the new keyword.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Parameters
latitude The latitude for the BlackBerry Maps Application to startup with.
longitude The longitude for the BlackBerry Maps Application to startup with.

Code Example:
<script type="text/javascript">  
   var args = new blackberry.invoke.MapsArguments(43.26, -80.30);
   blackberry.invoke.invoke(blackberry.invoke.APP_MAPS, args);
</script>

blackberry.invoke.MapsArguments (locationDocument : String)


Creates a new MapsArguments object.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Parameters
locationDocument The location for the BlackBerry Maps Application to startup with.

blackberry.invoke.MapsArguments (locationDocument : Document)


Creates a new MapsArguments object.


Supported Platforms
 - BlackBerry OS 5.0
 - Ripple Emulator


Parameters
locationDocument The location for the BlackBerry Maps Application to startup with.

blackberry.invoke.MapsArguments (address : blackberry.pim.Address)


Creates a new MapsArguments object.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Parameters
address The address for the BlackBerry Maps Application to startup with.
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:40 GMT-0500 (EST)