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

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

public final class ConferencePhoneCallLog
extends CallLog

A log object for a conference call (a call with two or more participants).

Unlike a simple PhoneCallLog, you can add or remove participants from a conference phone-call log as long as there are always at least two other participants involved in the call.

You cannot set a type for a conference phone-call log can with a simple phone-call log, because a conference call should always appear as such in the message list.

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

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
	ConferencePhoneCallLog(Date date, int callDuration, int callStatus, PhoneCallLogID caller1, PhoneCallLogID caller2, String notes) Creates a new ConferencePhoneCallLog instance.

Method Summary
	void	addParticipant(PhoneCallLogID participant) Adds a participant to this call.
	PhoneCallLogID	getParticipantAt(int index) Retrieves participant in call by index.
	int	numberOfParticipants() Retrieves the number of participants in this conference call.
	void	removeParticipantAt(int index) Removes participant by index.
	void	setParticipantAt(int index, PhoneCallLogID participant) Sets participant in call at index.

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

Constructor Detail

ConferencePhoneCallLog

public ConferencePhoneCallLog(Date date,
                              int callDuration,
                              int callStatus,
                              PhoneCallLogID caller1,
                              PhoneCallLogID caller2,
                              String notes)

Creates a new ConferencePhoneCallLog instance.

Parameters:

date - Date for the call.

callDuration - Duration of the call in seconds.

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

caller1 - First participant of the conference call.

caller2 - Second participant of the conference call.

notes - Notes associated with the 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

getParticipantAt

public PhoneCallLogID getParticipantAt(int index)

Retrieves participant in call by index.

Parameters:

index - Index of the participant to retrieve, from 0 to (ConferencePhoneCallLog.numberOfParticipants() -1).

Returns:

Participant at index, if index is valid.

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

setParticipantAt

public void setParticipantAt(int index,
                             PhoneCallLogID participant)

Sets participant in call at index.

Parameters:

index - Index of the participant to change.

participant - New participant for the 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

addParticipant

public void addParticipant(PhoneCallLogID participant)

Adds a participant to this call.

This method appends the new participant to the end of the existing list of participants.

Parameters:

participant - New participant to add to 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

removeParticipantAt

public void removeParticipantAt(int index)

Removes participant by index.

This method only removes the participant if there are already more than two participants in the call log (otherwise the call would not be a conference call).

Parameters:

index - Index for the participant to remove, from 0 to (ConferencePhoneCallLog.numberOfParticipants() - 1).

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

numberOfParticipants

public int numberOfParticipants()

Retrieves the number of participants in this conference call.

Returns:

Number of participants.

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