net.rim.blackberry.api.invoke
Class PhoneArguments

java.lang.Object
  net.rim.blackberry.api.invoke.ApplicationArguments
      net.rim.blackberry.api.invoke.PhoneArguments

public final class PhoneArguments
extends ApplicationArguments

Encapsulates arguments to pass to the Phone application.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Field Summary
	static String	ARG_CALL Argument to open the Phone application for an outgoing call.
	static String	VOICEMAIL String representing the device's voicemail number

Constructor Summary
	PhoneArguments() Creates a new PhoneArgument instance in the default view.
	PhoneArguments(String actionArg, String dialStringArg) Creates a new PhoneArgument instance with dialing string.
	PhoneArguments(String actionArg, String dialStringArg, boolean smartDialing) Creates a new PhoneArgument instance with dialing string.

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_CALL

public static final String ARG_CALL

Argument to open the Phone application for an outgoing call.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

VOICEMAIL

public static final String VOICEMAIL

String representing the device's voicemail number

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

Constructor Detail

PhoneArguments

public PhoneArguments()

Creates a new PhoneArgument instance in the default view.

The default arguments instruct the Phone application to open in the default (recent call list) view.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

PhoneArguments

public PhoneArguments(String actionArg,
                      String dialStringArg)

Creates a new PhoneArgument instance with dialing string.

In addition to the traditional "phone number characters" that you would use to compose a phone number (for example, +1-519-888-7465), you can also specify more precise dialing behaviour:

• , : A comma directs the phone application to pause for 2 seconds before proceeding to process the rest of the contents of the dialing string.
• ! : An exclamation mark directs the phone application to wait for user input; the system presents a dialog with three choices:
  - Proceed to dial the rest of the dialing string up to the next comma or exclamation mark
  - Skip directly to the next comma or exlamation mark in the dialing string
  - Cancel the call altogether
• # and * : Generate "pound" and "star" DTMF tones.
• 0 - 9 : Generate numeric DTMF tones.
• PhoneArguments.VOICEMAIL : Dial the device's voicemail number, as specified by the Phone application Options.

Parameters:

actionArg - Specify PhoneArguments.ARG_CALL to open the Phone application and dial the provided dial string.

dialStringArg - Number to dial; this may contain special dialing characters in addition to the components of a traditional phone number.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

PhoneArguments

public PhoneArguments(String actionArg,
                      String dialStringArg,
                      boolean smartDialing)

Creates a new PhoneArgument instance with dialing string.

In addition to the traditional "phone number characters" that you would use to compose a phone number (for example, +1-519-888-7465), you can also specify more precise dialing behaviour:

• , : A comma directs the phone application to pause for 2 seconds before proceeding to process the rest of the contents of the dialing string.
• ! : An exclamation mark directs the phone application to wait for user input; the system presents a dialog with three choices:
  - Proceed to dial the rest of the dialing string up to the next comma or exclamation mark
  - Skip directly to the next comma or exlamation mark in the dialing string
  - Cancel the call altogether
• # and * : Generate "pound" and "star" DTMF tones.
• 0 - 9 : Generate numeric DTMF tones.
• PhoneArguments.VOICEMAIL : Dial the device's voicemail number, as specified by the Phone application Options.

Parameters:

actionArg - Specify PhoneArguments.ARG_CALL to open the Phone application and dial the provided dial string.

dialStringArg - Number to dial; this may contain special dialing characters in addition to the components of a traditional phone number.

smartDialing - If true, smart dialing will be enabled.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.2.1