Call

Represents an active phone call.


Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
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 IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.phone.Phone" /> 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.

Functions

Boolean isOnHold

Properties

Boolean outgoing
String recipientName
String recipientNumber

Functions

Boolean isOnHold ()


Determines whether or not the current call is being held.


Supported Platforms
 - BlackBerry OS 5.0+


Return:

Returns true if there the call is on hold.



Code Example:
<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

readonly Boolean outgoing


Indicates if the call is outgoing.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

readonly String recipientName


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.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

readonly String recipientNumber


Number associated with this phone call.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:03 GMT-0500 (EST)