net.rim.blackberry.api.phone.phonelogs
Class PhoneCallLog

java.lang.Object
  net.rim.blackberry.api.phone.phonelogs.CallLog
      net.rim.blackberry.api.phone.phonelogs.PhoneCallLog

public final class PhoneCallLog
extends CallLog

Represents a call log in the message list for a simple phone call.

Unlike a ConferencePhoneCallLog, you can set and change the type of the call log (using this class's TYPE_* values); this changes how the call is presented in the message list.

You cannot have more than one participant in a phone call log. If you want more than one participant you must use a ConferencePhoneCallLog object for the call log.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Field Summary
	static int	TYPE_MISSED_CALL_OPENED Call that was missed and that has been viewed.
	static int	TYPE_MISSED_CALL_UNOPENED Call that was missed and has not been viewed yet.
	static int	TYPE_PLACED_CALL Successfully connected outgoing call.
	static int	TYPE_RECEIVED_CALL Incoming call that was successfully received.

Fields inherited from class net.rim.blackberry.api.phone.phonelogs.CallLog

STATUS_AUTHENTICATION_FAILURE, STATUS_BUSY, STATUS_CALL_FAILED_TRY_AGAIN, STATUS_CALL_FAIL_DUE_TO_FADING, STATUS_CALL_LOST_DUE_TO_FADING, STATUS_CONGESTION, STATUS_CONNECTION_DENIED, STATUS_EMERGENCY_CALLS_ONLY, STATUS_FDN_MISMATCH, STATUS_GENERAL_ERROR, STATUS_HOLD_ERROR, STATUS_INCOMING_CALL_BARRED, STATUS_MAINTENANCE_REQUIRED, STATUS_NORMAL, STATUS_NUMBER_UNOBTAINABLE, STATUS_OUTGOING_CALLS_BARRED, STATUS_PATH_UNAVAILABLE, STATUS_SERVICE_NOT_AVAILABLE

Constructor Summary
	PhoneCallLog(Date date, int callType, int callDuration, int callStatus, PhoneCallLogID participant, String notes) Creates a new phone call log.

Method Summary
	PhoneCallLogID	getParticipant() Retrieves the participant for this call.
	int	getType() Retrieves this call's type.
	void	setParticipant(PhoneCallLogID participant) Sets the participant for this call.
	void	setType(int callType) Sets this call's type.

Methods inherited from class net.rim.blackberry.api.phone.phonelogs.CallLog

getDate, getDuration, getNotes, getStatus, setDate, setDuration, setNotes, setStatus

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_RECEIVED_CALL

public static final int TYPE_RECEIVED_CALL

Incoming call that was successfully received.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

TYPE_PLACED_CALL

public static final int TYPE_PLACED_CALL

Successfully connected outgoing call.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

TYPE_MISSED_CALL_UNOPENED

public static final int TYPE_MISSED_CALL_UNOPENED

Call that was missed and has not been viewed yet.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

TYPE_MISSED_CALL_OPENED

public static final int TYPE_MISSED_CALL_OPENED

Call that was missed and that has been viewed.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Constructor Detail

PhoneCallLog

public PhoneCallLog(Date date,
                    int callType,
                    int callDuration,
                    int callStatus,
                    PhoneCallLogID participant,
                    String notes)

Creates a new phone call log.

Parameters:

date - Date for this call.

callType - Type of this call; one of the TYPE_* values.

callDuration - Duration of this call in seconds.

callStatus - Status of this call; one of the STATUS_* values inherited from CallLog.

participant - Participant in this call.

notes - Any notes associated with this call.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Method Detail

getParticipant

public PhoneCallLogID getParticipant()

Retrieves the participant for this call.

The participant information is presented both in the message list and when the log is opened for viewing.

Returns:

Participant for this call.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

setType

public void setType(int callType)

Sets this call's type.

Parameters:

callType - New type for this call; must be one of the four PhoneCallLog.TYPE_* constants.

Throws:

IllegalArgumentException - if the input callType is not one of the four PhoneCallLog.TYPE_* constants.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

getType

public int getType()

Retrieves this call's type.

Returns:

Type for this call; one of the TYPE_* values.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

setParticipant

public void setParticipant(PhoneCallLogID participant)

Sets the participant for this call.

The participant information is presented both in the message list and when the log is opened for viewing.

Parameters:

participant - New participant for this call.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0