SHOW Signed

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 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
 
Fields inherited from class net.rim.blackberry.api.phone.phonelogs.CallLog
STATUS_AUTHENTICATION_FAILURE, STATUS_BUSY, STATUS_CALL_FAIL_DUE_TO_FADING, STATUS_CALL_FAILED_TRY_AGAIN, 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
 Category: Signed ConferencePhoneCallLog(Date date, int callDuration, int callStatus, PhoneCallLogID caller1, PhoneCallLogID caller2, String notes)
          Creates a new ConferencePhoneCallLog instance.
 
Method Summary
 Category: Signed  void addParticipant(PhoneCallLogID participant)
          Adds a participant to this call.
 Category: Signed  PhoneCallLogID getParticipantAt(int index)
          Retrieves participant in call by index.
 Category: Signed  int numberOfParticipants()
          Retrieves the number of participants in this conference call.
 Category: Signed  void removeParticipantAt(int index)
          Removes participant by index.
 Category: Signed  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.
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

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.
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.

getParticipantAt

public PhoneCallLogID getParticipantAt(int index)
Retrieves participant in call by index.
Parameters:
index - Index of the participant to retrieve, from 0 to (numberOfParticipants() -1).
Returns:
Participant at index, if index is valid.
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.

numberOfParticipants

public int numberOfParticipants()
Retrieves the number of participants in this conference call.
Returns:
Number of participants.
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.

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 (numberOfParticipants() - 1).
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.

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.
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.


Copyright 1999-2007 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.