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
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| 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 ID | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| <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 Only) |
|---|
| This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. |
API Summary
blackberry.invoke.MapsArguments
| blackberry.invoke.MapsArguments (latitude : Number, longitude : Number) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
The MapsArguments object must be created as an instance using the new keyword.
| Parameter | Type | Description |
|---|---|---|
| latitude | Number | The latitude for the BlackBerry Maps Application to startup with. |
| longitude | Number | The longitude for the BlackBerry Maps Application to startup with. |
Code Example(s)
<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
| blackberry.invoke.MapsArguments (locationDocument : String) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
Creates a new MapsArguments object.
| Parameter | Type | Description |
|---|---|---|
| locationDocument | String | The location for the BlackBerry Maps Application to startup with. |
blackberry.invoke.MapsArguments
| blackberry.invoke.MapsArguments (locationDocument : Document) |
Supported Platform(s)
- BlackBerry OS 5.0- Ripple Emulator
Description
Creates a new MapsArguments object.
| Parameter | Type | Description |
|---|---|---|
| locationDocument | Document | The location for the BlackBerry Maps Application to startup with. |
blackberry.invoke.MapsArguments
| blackberry.invoke.MapsArguments (address : blackberry.pim.Address) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
Creates a new MapsArguments object.
| Parameter | Type | Description |
|---|---|---|
| address | blackberry.pim.Address | The address for the BlackBerry Maps Application to startup with. |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:18 GMT-0500 (EST)