SHOW Signed

net.rim.blackberry.api.phone
Class PhoneCall

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

public class PhoneCall

extends Object

Represents an active phone call.

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

Field Summary

	static int	STATUS_CONNECTED Call is connected.
	static int	STATUS_CONNECTED_MUTED Call is connected, but muted.
	static int	STATUS_CONNECTING Call is currently connecting, but not yet connected.
	static int	STATUS_DISCONNECTED Call is disconnected.
	static int	STATUS_HELD Call is being held.

Method Summary

	int	getCallId() Retrieves this call's ID.
	String	getDisplayPhoneNumber() Retrieves this call's number string for display in a UI.
	String	getDTMFTones() Retrieves this call's current send queue of DTMF tones.
	int	getElapsedTime() Retrieve this call's current elapsed time.
	int	getStatus() Retrieves this call's current status.
	String	getStatusString() Retrieves this call's current status as a string for display in a UI.
	boolean	isOutgoing() Determines if the current call is an outgoing call.
	boolean	sendDTMFTone(char tone) Adds a DTMF tone to this call's send queue.
	boolean	sendDTMFTones(String tones) Adds a number of DTMF tones to this call's send queue.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATUS_CONNECTED

public static final int STATUS_CONNECTED

Call is connected.

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.

STATUS_CONNECTED_MUTED

public static final int STATUS_CONNECTED_MUTED

Call is connected, but muted.

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.

STATUS_CONNECTING

public static final int STATUS_CONNECTING

Call is currently connecting, but not yet connected.

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.

STATUS_DISCONNECTED

public static final int STATUS_DISCONNECTED

Call is disconnected.

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.

STATUS_HELD

public static final int STATUS_HELD

Call is being held.

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.

Method Detail

getCallId

public int getCallId()

Retrieves this call's ID.

Returns:

ID for this 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.

getDisplayPhoneNumber

public String getDisplayPhoneNumber()

Retrieves this call's number string for display in a UI.

Returns:

Display string for this 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.

getDTMFTones

public String getDTMFTones()

Retrieves this call's current send queue of DTMF tones.

Returns:

List of DTMF tones still to send for this 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.

getElapsedTime

public int getElapsedTime()

Retrieve this call's current elapsed time.

Returns:

Elapsed time for this 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.

getStatus

public int getStatus()

Retrieves this call's current status.

Returns:

One of the STATUS_* values describing the state of this 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.

getStatusString

public String getStatusString()

Retrieves this call's current status as a string for display in a UI.

Returns:

String version of this call's current status.

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.

isOutgoing

public boolean isOutgoing()

Determines if the current call is an outgoing call.

Returns:

True if this call was initiated by this device; otherwise, the call was received and answered by this device.

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.

sendDTMFTone

public boolean sendDTMFTone(char tone)

Adds a DTMF tone to this call's send queue.

Parameters:

tone - DTMF tone to add to this call's send queue.

Returns:

True if tone has been added to this call's send queue; otherwise, false.

Since:

JDE 4.0.2

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.

sendDTMFTones

public boolean sendDTMFTones(String tones)

Adds a number of DTMF tones to this call's send queue.

Parameters:

tones - List of DTMF tones to add to this call's send queue.

Returns:

True if entire list of tones has been added to this call's send queue; otherwise, false.

Since:

JDE 4.0.2

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.