Call
Represents an active phone call.
Supported Platform(s)
- BlackBerry OS 5.0+
- Ripple Emulator
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| isOnHold | Y | Y | Y | ||
| outgoing | Y | Y | Y | Y | |
| recipientName | Y | Y | Y | Y | |
| recipientNumber | 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.phone.Phone" /> | 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. |
isOnHold
| Boolean isOnHold() |
Supported Platform(s)
- BlackBerry OS 5.0+Description
Determines whether or not the current call is being held.
Returns
Returns true if there the call is on hold.Code Example(s)
<script type="text/javascript">
// Check if active call at index specified is on hold
var res = blackberry.phone.Phone.activeCalls();
if (res) {
var index = 0;
alert("Is active call " + index + " on hold? " + res[index].isOnHold());
}
</script>
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| outgoing |
Boolean
readonly |
Indicates if the call is outgoing.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| recipientName |
String
readonly |
Number string for display in a UI. If a contact list entry is found with a matching phone number, the 'friendly name' (either First/Last or Company name) is returned.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| recipientNumber |
String
readonly |
Number associated with this phone call.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:15 GMT-0500 (EST)