SHOW Signed

net.rim.blackberry.api.invoke
Class MapsArguments

java.lang.Object
  |
  +--net.rim.blackberry.api.invoke.ApplicationArguments
        |
        +--net.rim.blackberry.api.invoke.MapsArguments

public final class MapsArguments

extends ApplicationArguments

Encapsulates arguments to pass to the BlackBerry Maps application.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 4.2.0

Field Summary

static String

ARG_LOCATION_DOCUMENT Argument to open Maps and display points using the provided location document

Constructor Summary

	MapsArguments() Creates a new MapsArguments instance with default arguments.
	MapsArguments(Contact contact, int addressIndex) Creates a new MapsArguments instance with provided arguments
	MapsArguments(MapView mapView) Creates a new MapsArguments instance with a specified view.
	MapsArguments(String arg, String locationDocument) Creates a new MapsArguments instance with provided arguments.

Method Summary

Methods inherited from class net.rim.blackberry.api.invoke.ApplicationArguments

getArgs

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARG_LOCATION_DOCUMENT

public static final String ARG_LOCATION_DOCUMENT

Argument to open Maps and display points using the provided location document

Since:

JDE 4.2.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Constructor Detail

MapsArguments

public MapsArguments()

Creates a new MapsArguments instance with default arguments.

The default arguments instruct Maps to open in the default view or last lat/long.

Since:

JDE 4.2.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

MapsArguments

public MapsArguments(Contact contact,
                     int addressIndex)

Creates a new MapsArguments instance with provided arguments

Parameters:

contact - A contact with at least one address. The Maps application will start and attempt to search for one of the addresses for the contact. If the contact has no addresses, when invoked with this MapsArgument the Maps application will open to the default location.

addressIndex - The index (beginning at 0) of the address you would like displayed. If the index is invalid, when invoked with this MapsArgument the Maps application will open to the default location.

Since:

JDE 4.2.1

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

MapsArguments

public MapsArguments(MapView mapView)

Creates a new MapsArguments instance with a specified view. Note: the rotation specified in the view is currently ignored.

Parameters:

mapView - The view used to display the map

Since:

JDE 4.2.1

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

MapsArguments

public MapsArguments(String arg,
                     String locationDocument)

Creates a new MapsArguments instance with provided arguments.

Parameters:

arg - Specify #ARG_LOCATION to open BlackBerry Maps to display the points of interest in the location document. The following example shows how to invoke the client to display a single location: String location = "<location-document>" + "<location x='4500000' y='-7500000'/>" + "</location-document>";
The following example shows how to invoke the client to display multiple points of interest: String location = "<location-document>" + " <location x='4500000' y='-7500000' label='TestPoint1' description='This could have a phone number. 555-1212'/>" +
" <location x='4500100' y='-7500000' label='TestPoint2' description='This could have a phone number. 555-1212'/>" +
" <location x='4500200' y='-7500000' label='TestPoint3' description='This could have a phone number. 555-1212'/>" + * "</location-document>";

locationDocument - A string that contains location data.

Since:

JDE 4.2.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.