PhoneArguments

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

Supported Platform(s)

- BlackBerry OS 5.0+

- Ripple Emulator

View Supported Platform Table

API	BB5.0	BB6.0	BB7.0	Ripple
blackberry.invoke.PhoneArguments	Y	Y	Y	Y
view	Y	Y	Y	Y
VIEW_CALL	Y	Y	Y	Y
VIEW_VOICEMAIL	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	BB5.0	BB6.0	BB7.0	PB1.0	PB2.0	BB10	Ripple
<feature id="blackberry.invoke" />	Y	Y	Y				Y
<feature id="blackberry.invoke.PhoneArguments" />	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.PhoneArguments

Properties

Number

view

Constants

Number	VIEW_CALL
Number	VIEW_VOICEMAIL

Constructors

blackberry.invoke.PhoneArguments ([dialString : String], [smartDialing : Boolean], [lineId : Number])

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

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Parameters
dialString	Optional parameter specifying the Number to dial; this may contain special dialing characters in addition to the components of a traditional phone number.
smartDialing	Optional parameter. If true, smart dialing will be enabled. Smart dialing is ignored if a line id is specified.
lineId	Optional ID of the line to use for the call. If not specified the default line is used. Line ID cannot be specified when VIEW_VOICEMAIL is used. This will cause the invocation to throw an IllegalArgumentException.

Code Example:

<script type="text/javascript">   
  var args = new blackberry.invoke.PhoneArguments('555-555-5555', true);
  args.view = blackberry.invoke.PhoneArguments.VIEW_CALL;     

  blackberry.invoke.invoke(blackberry.invoke.APP_PHONE, args);  
</script>

Properties

Number view

Value that specifies what kind of view you want to open in the Phone application.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Constants

static Number VIEW_CALL

Make Phone Call

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

static Number VIEW_VOICEMAIL

Call Voicemail

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:41 GMT-0500 (EST)