SHOW Signed

net.rim.blackberry.api.phone
Class Phone

java.lang.Object
  |
  +--net.rim.blackberry.api.phone.Phone

public final class Phone
extends Object

Provides advanced utilities for interaction with the phone application.

You can use the methods in this class for finer manipulation of the phone application, for example, injecting DTMF tones into active calls.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 4.0.0

Method Summary
 Category: Signed static void addPhoneListener(PhoneListener pl)
          Registers a phone listener with the system.
 Category: Signed static PhoneCall getActiveCall()
          Retrieves the active phone call.
 Category: Signed static PhoneCall getCall(int callid)
          Retrieves call by ID.
 Category: Signed static String getDevicePhoneNumber(boolean format)
          retrieves the device's phone number if present
 Category: Signed static void removePhoneListener(PhoneListener pl)
          De-registers a phone listener from the system.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getActiveCall

public static PhoneCall getActiveCall()
Retrieves the active phone call.
Returns:
Currently active call.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getCall

public static PhoneCall getCall(int callid)
Retrieves call by ID.
Parameters:
callid - ID provided to one of the PhoneListener methods.
Returns:
Phone call for ID, or null if no such call has yet been built by the phone application.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

addPhoneListener

public static void addPhoneListener(PhoneListener pl)
Registers a phone listener with the system.
Parameters:
pl - Listener to handle phone events.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

removePhoneListener

public static void removePhoneListener(PhoneListener pl)
De-registers a phone listener from the system.
Parameters:
pl - Phone listener to remove from the system's list.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDevicePhoneNumber

public static String getDevicePhoneNumber(boolean format)
retrieves the device's phone number if present
Parameters:
format - true if you wish to retrieve the phone number in it's formatted form, which varies with the region
Returns:
a String representing the device's phone number, or null if no phone number is currently available
Since:
JDE 4.1.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2006 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.