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
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | 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 | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| <feature id="blackberry.invoke" /> | Y | Y | Y | Y | |
| <feature id="blackberry.invoke.PhoneArguments" /> | 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
Constructors
Properties
Constants
blackberry.invoke.PhoneArguments
| blackberry.invoke.PhoneArguments ([dialString: String], [smartDialing: Boolean], [lineId: Number]) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
The PhoneArguments object must be created as an instance using the new keyword.
| Parameter | Type | Description |
|---|---|---|
| dialString |
String
Optional |
Optional parameter specifying the Number to dial; this may contain special dialing characters in addition to the components of a traditional phone number. |
| smartDialing |
Boolean
Optional |
Optional parameter. If true, smart dialing will be enabled. Smart dialing is ignored if a line id is specified. |
| lineId |
Number
Optional |
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(s)
<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:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| view | Number |
Value that specifies what kind of view you want to open in the Phone application.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
Constants:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| VIEW_CALL | Number |
Make Phone Call
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_VOICEMAIL | Number |
Call Voicemail
|
- BlackBerry OS 5.0+
- Ripple Emulator |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:19 GMT-0500 (EST)