Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
CONFIDENTIAL
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.spectel.bcapi
Interface Conference

All Superinterfaces:
GenericConference
public interface Conference
extends GenericConference

This interface represents a user conference room. It allows the application to control common conference functions and access the Participant interface for each conference participant.
 
The Conference interface is obtained from a Bridge object.

See Also:
Bridge, Participant

Field Summary
static java.lang.String ACCOUNT_NUM
          The account number assigned to the conference.
static java.lang.String APP_FLAGS
          Indicates applications currently running in the conference.
static java.lang.String AUTO_EXTEND_PARTICIPANTS
          Indicates whether or not the maximum number of participants set for this conference may be exceeded with further dial-outs or dial-ins.
static java.lang.String AUX1
          The first of two auxiliary fields that can hold up to 20 bytes of character data.
static java.lang.String AUX2
          One of two auxiliary fields that can hold up to 20 bytes of character data.
static java.lang.String BILLING_CONFID
          The billing identifier used to generate the CODR, which is used for tracking and billing after the conference has completed.
static java.lang.String BILLING_ID
          The unique internal billing identifier used to identify this conference during the active life of the conference.
static java.lang.String CALL_FLOW
          The call flow used by the conference: DEFAULT (SPECTEL) or FLEX.
static java.lang.Integer CALL_FLOW_CRYSTAL
          State (value = 2) to indicate the call flow is of type Crystal.
static java.lang.Integer CALL_FLOW_DEFAULT
          State (value = 0) to indicate the call flow is of type DEFAULT (formerly called SPECTEL).
static java.lang.Integer CALL_FLOW_FLEX
          State (value = 1) to indicate the call flow is of type Flex.
static java.lang.Integer CALL_FLOW_SPECTEL
          State (value = 0) to indicate the call flow is of type DEFAULT (formerly called SPECTEL).
static java.lang.String CONF_NAME
          The name of the conference.
static java.lang.String CONF_TYPE
          The conference type: normal, subconference, or intercept.
static java.lang.String CONFERENCE_ID
          The identifier for the conference.
static java.lang.String CONFIRM_NUM
          The unique confirmation number of the conference.
static java.lang.Integer CONFTYPE_INTERCEPT
          State (value = 2) to indicate the conference is of type intercept.
static java.lang.Integer CONFTYPE_INTERCEPT_NOCDR
          State (value = 4) to indicate the conference is of type intercept without CDR record.
static java.lang.Integer CONFTYPE_NORMAL
          State (value = 0) to indicate the conference is of type normal.
static java.lang.Integer CONFTYPE_OPER_ASSIST
          State (value = 3) to indicate the conference is of type timed operator assistance.
static java.lang.Integer CONFTYPE_SUBCONF
          State (value = 1) to indicate the conference is of type subconference.
static java.lang.String CROSS_REFERENCE
          The unique identifier associated with a conference when it is started.
static java.lang.String DIAL_LIST
          The dial list of participants identified at schedule time.
static java.lang.String ENTRY_TONEVAL
          The value of the entry notification : OFF, SYSTEM, TONE, MESSAGE or BOTH tone and message.
static java.lang.String EXIT_TONEVAL
          The value of the exit notification : OFF, SYSTEM, TONE, MESSAGE or BOTH tone and message.
static java.lang.String FLEX_MODERATOR_CODE
          The flex moderator code is used for conference plus to allow a moderator to enter a flex conference with just entering this code without having to enter participant code first.
static java.lang.String GLOBAL_ID
          Reports the ID for a global conference.
static java.lang.Byte HOLD_M1
          Hold state parameter for dial commands.
static java.lang.Byte HOLD_M2
          Hold state parameter for dial commands.
static java.lang.Byte HOLD_M3
          Hold state parameter for dial commands.
static java.lang.Byte HOLD_M4
          Hold state parameter for dial commands.
static java.lang.Byte HOLD_NO_MUSIC
          Hold state parameter for dial commands.
static java.lang.String IN_SERVICE
          Determines if the conference is active or "in service".
static java.lang.String IS_CONF_VIEW
          Determines if the Conference Viewer application has been scheduled for the conference.
static java.lang.String IS_DEMAND
          Determines if this conference is a demand conference.
static java.lang.String IS_DIALOUT_BLOCKED
          Determines whether a moderator may manually dial out (ODO) from this conference.
static java.lang.String IS_ENTRY_ON
          Determines if the conference has entry tones enabled.
static java.lang.String IS_EXIT_ON
          Determines if the conference has exit tones enabled.
static java.lang.String IS_GAIN_ON
          Determines if the conference has Gain enabled.
static java.lang.String IS_GLOBAL_CONF
          Indicates whether the conference is a global conference.
static java.lang.String IS_HELP_REQ
          Determines if the conference has requested help.
static java.lang.String IS_HELP_REQ_ALLOWED
          Indicates whether or not help requests are allowed.
static java.lang.String IS_LEADER_PIN
          Always return false for sFlow conferences.
static java.lang.String IS_LECTURE_ON
          Determines if the conference is in Lecture mode.
static java.lang.String IS_LOCKED
          Determines if the conference is secured and locked.
static java.lang.String IS_MOD_HANGUP
          Determines if moderator hangup is enabled.
static java.lang.String IS_MUSIC_ON
          Determines if music is turned on for the conference.
static java.lang.String IS_MUTEALL_ON
          Determines if the conference is in silent mode.
static java.lang.String IS_POLLING_ON
          The conference is in Polling mode when this flag is set to true.
static java.lang.String IS_QA_ON
          Determines if the conference is in Q&A (Question and Answer) mode.
static java.lang.String IS_SECURITY_ALLOWED
          Determines whether security is allowed in this conference.
static java.lang.String IS_TUI_DIAL_OUT_ALLOWED
          Indicates whether or not a TUI should allow dial-outs.
static int MAX_INTERCEPTS
          Maximum number of simultaneous intercept conferences allowed from a single user conference.
static java.lang.String MAX_PARTS
          The maximum number of participants normally allowed in the conference.
static int MAX_PROMPTSETS
          The maximum value for the range of prompt sets available for the conference.
static java.lang.String MAX_SUB_PARTS
          The maximum number of participants allowed in the subconference.
static int MAX_SUBCONFS
          Maximum number of simultaneous sub-conferences allowed from a single user conference.
static java.lang.String MODERATOR_CODE
          The moderator code is the identifier used by moderators to enter the conference.
static java.lang.String MUSIC_SRC
          Identifies the music source attached to the conference when IS_MUSIC_ON is true.
static java.lang.Integer MUSIC_SRC_M1
          Source (value = 1) indicates music channel 1 is attached to the conference.
static java.lang.Integer MUSIC_SRC_M2
          Source (value = 2) indicates music channel 2 is attached to the conference.
static java.lang.Integer MUSIC_SRC_M3
          Source (value = 3) indicates music channel 3 is attached to the conference.
static java.lang.Integer MUSIC_SRC_M4
          Source (value = 4) indicates music channel 4 is attached to the conference.
static java.lang.Integer MUSIC_SRC_OFF
          Source (value = 0) indicates no music channel is attached to the conference.
static java.lang.Byte NO_HOLD
          Hold state parameter for dial commands.
static java.lang.String NRP_MODE
          The Name/Record playback mode: OFF, INDIVIDUAL, CONFERENCE, or OPERATOR_ONLY.
static java.lang.Integer NRPMODE_CONFERENCE
          State (value = 2) to indicate the system will play a recording to the conference.
static java.lang.Integer NRPMODE_INDIVIDUAL
          State (value = 1) to indicate the system will play a recording only to the individual.
static java.lang.Integer NRPMODE_OFF
          State (value = 0) to indicate the system will not play any NRP recording.
static java.lang.Integer NRPMODE_OPERATOR_ONLY
          State (value = 3) to indicate the system will play a recording to the operator.
static java.lang.String PARTICIPANT_CODE
          The participant code (also called conferee code) is the personal identifier used by non-moderators to enter the conference.
static java.lang.String PLAYBACK_STATE_AUX
          Reports the auxiliary playback state of the conference.
static java.lang.String PLAYBACK_STATE_ONBRIDGE
          Reports the on-bridge playback state of the conference.
static java.lang.String PROMPT_SET
          The prompt set used by the conference: 1 - MAX_PROMPTSETS
 
This parameter is read-only and can be accessed via the getParameter() method.
static java.lang.String QA_NEXT
          The Participant ID of the next participant in the QA queue waiting to ask a question.
static java.lang.String QA_QUESTIONER
          The Participant ID of the participant, in the QA queue, who is currently asking a question.
static java.lang.Integer REC_MODE_DEFAULT
          Mode (value = 0) indicates conference is using the bridge setting.
static java.lang.Integer REC_MODE_DISABLED
          Mode (value = 1) indicates conference has recording disabled.
static java.lang.Integer REC_MODE_OFFBRIDGE
          Mode (value = 3) indicates conference is scheduled for off-bridge recording.
static java.lang.Integer REC_MODE_ONBRIDGE
          Mode (value = 2) indicates conference is scheduled for on-bridge recording.
static java.lang.Integer REC_STATE_PAUSED
          State (value = 3) to indicate recording is paused.
static java.lang.Integer REC_STATE_PLAYBACK
          State (value = 5) to indicate recording is being played back.
static java.lang.Integer REC_STATE_RECORDING
          State (value = 2) to indicate recording is active.
static java.lang.Integer REC_STATE_STOPPED
          State (value = 1) to indicate recording is stopped.
static java.lang.Integer REC_STATE_STOPPING
          State (value = 4) to indicate recording is stopping.
static java.lang.String RECORD_STATE
          Deprecated. The following parameters should be used it its place: RECORD_STATE_ONBRIDGE, PLAYBACK_STATE_ONBRIDGE, RECORD_STATE_OFFBRIDGE, RECORD_STATE_AUX, PLAYBACK_STATE_AUX
static java.lang.String RECORD_STATE_AUX
          Reports the auxiliary recording state of the conference.
static java.lang.String RECORD_STATE_OFFBRIDGE
          Reports the off-bridge recording state of the conference.
static java.lang.String RECORD_STATE_ONBRIDGE
          Reports the on-bridge recording state of the conference.
static java.lang.String RECORDING_MODE
          The scheduled recording mode for the conference.
static java.lang.String RECPLAY_FILENAME
          The file name of the last conference recording or playback, or an empty string if neither of those actions was previously performed.
static java.lang.String SCHED_END_DAY
          The scheduled end day of the conference.
static java.lang.String SCHED_END_MONTH
          The scheduled end month of the conference.
static java.lang.String SCHED_END_TIME
          The scheduled end time, in military time, of the conference.
static java.lang.String SCHED_END_YEAR
          The scheduled end year of the conference.
static java.lang.String SCHED_START_DAY
          The scheduled start day (date) of the conference.
static java.lang.String SCHED_START_MONTH
          The scheduled start month of the conference.
static java.lang.String SCHED_START_TIME
          The scheduled start time, in military time, of the conference.
static java.lang.String SCHED_START_YEAR
          The scheduled start year of the conference.
static java.lang.String SUBCONF_INDEX
          Identifies the sub-conference index of this conference.
static java.lang.Integer TONEVAL_BOTH
          State (value = 4) to indicate the system will play both a tone and a message to the conference.
static java.lang.Integer TONEVAL_MESSAGE
          State (value = 3) to indicate the system will play a message to the conference.
static java.lang.Integer TONEVAL_OFF
          State (value = 0) to indicate the system will not play any entry/exit notification to the conference.
static java.lang.Integer TONEVAL_SYS
          State (value = 1) to indicate the system will play the conference entry/exit setting to the conference.
static java.lang.Integer TONEVAL_TONE
          State (value = 2) to indicate the system will play a tone to the conference.
 
Fields inherited from interface com.spectel.bcapi.GenericConference
PART_COUNT, RESERVATION_GROUP
 
Method Summary
 void addToSubConf(java.lang.String participantId)
          Adds the desired participant to the sub-conference.
 void addToSubConf(java.lang.String participantId, java.lang.Integer subConfIndex)
          Adds the desired participant to the sub-conference.
 void cancelOperatorRequest()
          Cancel an operator assistance request for this conference.
 void clearPollingResults()
          Clears all votes tallied during a Polling session for the conference.
 void closeConference()
          Hangup all participants and close this conference
 void continuePlayback()
          Continue playback for this conference.
 void continueRecording()
          Continue recording for this conference.
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, boolean dialModerator)
          Dial a new participant out from the bridge
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, boolean dialModerator, java.lang.String interceptorID)
          Dial a new participant out from the bridge and intercept the dialed line with an existing participant.
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator)
          Dial a new participant out from the bridge using a specific port group.
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator, byte holdState, java.util.Hashtable optionalParams)
          Quiet Dial wihout intercept.
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator, java.util.Hashtable optional)
          Dial a new participant out from the bridge.
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator, java.lang.String interceptorID)
          Dial a new participant out from the bridge using a specific port group and intercept the dialed line with an existing participant.
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator, java.lang.String interceptorID, byte holdState, java.util.Hashtable optional)
          Quiet Dial with intercept.
 Participant dial(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator, java.lang.String interceptorID, java.util.Hashtable optional)
          Dial a new participant out from the bridge and intercept the dialed line with an existing participant.
 Participant dialWithRestrictions(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator, java.lang.String interceptorID)
          Dial a new participant out from the bridge using a specific port group and intercept the dialed line with an existing participant.
 Participant dialWithRestrictions(java.lang.String name, java.lang.String company, java.lang.String phoneNumber, java.lang.String portGroup, boolean dialModerator, java.lang.String interceptorID, byte holdState)
          Quiet Dial with restriction.
 void disableModeratorHangup()
          Allow this conference to continue when the last moderator disconnects.
 void disableMusic()
          Turns off music for this conference.
 void enableModeratorHangup()
          Set this conference to end when the last moderator disconnects.
 void enableMusic()
          Turns on music for this conference, using the default music source.
 void enableMusic(java.lang.Integer musicSource)
          Turns on music for this conference using a specific music source.
 java.util.Vector getActiveSpeakerIds()
          Get participant ids of active speakers during a Q&A session.
 java.util.Vector getChildConferenceIds()
          Get the IDs of subconferences or intercept conferences currently associated with this conference.
 java.util.Vector getLocalParticipantIds()
          Get the IDs of participants, including moderators, currently in this conference.
 java.lang.String getParentConferenceId()
          Get the ID of the parent conference to this child conference.
 java.util.Vector getQAParticipantIds()
          Returns a Vector of participants currently involved in a Q&A session for the conference, as String objects of participant Id.
 java.util.Vector getQAParticipantIds(boolean includeQA, boolean includeMods, boolean includeHelp)
          Returns the line number list of particpants currently in a QA session.
 java.util.Vector getSubConfParticipantIds()
          Returns a Vector of participants, as String objects of participant Id, currently involved in a subconference for the conference.
 boolean inService()
          Is this conference in service?
 void lock()
          Secure the conference.
 void pausePlayback()
          Pause playback for this conference.
 void pauseRecording()
          Pause recording for this conference.
 void playParticipantInfo(java.lang.String srcPartId, java.lang.String tgtPartId)
          Play the line info of the source participant to the target participant.
 void playRoster(java.lang.String tgtPartId)
          Depending on the conference's NRP setting, this action will play the total number of participants if this was not scheduled, or the recorded names of the participants if it was scheduled.
 void removeFromSubConf(java.lang.String participantId)
          Removes the desired participant from the subconference to the parent conference.
 void requestOperator()
          Request an operator's assistance on this conference.
 void requestOperator(boolean obeyRestrictions)
          Request an operator's assistance on this conference if such requests are allowed.
 void setParameter(java.lang.String key, java.lang.String value)
          Set the parameter identified with the given key with the given value.
 void setParameters(java.util.Hashtable param)
          Set parameters given in the hashtable.
 void setPromptSet(java.lang.Integer promptSet)
          Set the prompt set for the conference.
 void setSecurityAllowed(boolean allowSecurity)
          Allow or forbid securing the conference via Conference.lock() or moderator TUI.
 void startLecture()
          Enables conference lecture mode, so only moderator participants will be audible.
 void startLecture(boolean obeyRestrictions)
          Enables conference lecture mode if a moderator is allowed to do so.
 void startMuteAll()
          Turns MuteAll mode on for the conference, muting all non-moderator participants in a way that they can still unmute themselves.
 void startMuteAll(short moderatorId)
          Turns MuteAll mode on for the conference, muting all participants except the moderator passed in in a way that they can still unmute themselves.
 void startPlayback(java.lang.String fileName)
          Starts the playback of a recording specified by the file name.
 void startPlayback(java.lang.String fileName, boolean asModerator)
          Starts the playback of a recording specified by the file name, optionally as a moderator, meaning that a moderator using the TUI or the API using moderator access can stop the playback.
 void startPolling()
          Starts a Polling session for the conference.
 void startQA()
          Starts a Q&A session for the conference.
 void startRecording()
          Start recording for this conference.
 void startRecording(boolean asModerator)
          Starts the recording of this conference, optionally with moderator privileges.
 void startRecording(java.lang.String fileName)
          Starts the recording of this conference.
 void startRecording(java.lang.String fileName, boolean asModerator)
          Starts the recording of this conference, optionally with moderator privileges.
 void stopLecture()
          Disables the lecture mode of the conference, allowing non-moderator participants to be heard.
 void stopMuteAll()
          Turns MuteAll mode off for the conference, unmuting all self-muted participants.
 void stopPlayback()
          Stops the playback of a recording.
 void stopPlayback(boolean asModerator)
          Stops the playback of a recording, optionally as a moderator, meaning that this will only stop playbacks initiated by a moderator.
 void stopPolling()
          Stops a Polling session for the conference.
 void stopQA()
          Stops the Q&A session for the conference.
 void stopRecording()
          Stop recording for this conference.
 void stopRecording(boolean asModerator)
          Stop recording for this conference, optionally only if the current recording was initiated by a moderator.
 void stopSubConference()
          Stops the subconference for this conference by removing all participants from the subconference.
 void stopSubConference(java.lang.Integer subConfIndex)
          Stops the sub-conference with subConfIndex for this conference.
 void unLock()
          Unsecure the conference.
 java.util.Hashtable viewPollingResults()
          Returns a Hashtable containing all votes tallied during a Polling session for the conference.
 
Methods inherited from interface com.spectel.bcapi.GenericConference
deRegister, getParameter, getParameters, getParticipant, getParticipantIds, logoff, register, setAsynchronous, setSynchronous
 

Field Detail

CONF_NAME

static final java.lang.String CONF_NAME
The name of the conference. The parameter "CONF_NAME" can be set with the setParameter() method.
 
The type of this parameter is String. Its maximum settable length is 60 characters for bridges of version 3.4 and later. For bridges of version 3.3 and earlier, its maximum settable length is 12 characters.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

AUX1

static final java.lang.String AUX1
The first of two auxiliary fields that can hold up to 20 bytes of character data. The parameter "AUX1" can be set with the setParameter() method.
 
The type of this parameter is String. Its maximum settable length is 20 characters.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

AUX2

static final java.lang.String AUX2
One of two auxiliary fields that can hold up to 20 bytes of character data. The parameter "AUX2" can be set via the setParameter() method.
 
The type of this parameter is String. Its maximum settable length is 20 characters.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

IS_POLLING_ON

static final java.lang.String IS_POLLING_ON
The conference is in Polling mode when this flag is set to true. Use the startPolling() and stopPolling() methods to turn polling on or off. The parameter "IS_POLLING_ON" is read-only and is accessable via the getParameter() method.
 
The type of this parameter is Boolean.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

IN_SERVICE

static final java.lang.String IN_SERVICE
Determines if the conference is active or "in service". Use this parameter to determine if the conference has started or ended. Boolean.TRUE when the conference is active; Boolean.FALSE otherwise. Also Boolean.FALSE when the application is not connected to the bridge. The parameter "IN_SERVICE" is read-only and is accessable via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

IS_LOCKED

static final java.lang.String IS_LOCKED
Determines if the conference is secured and locked. In this state, new participants can not enter the conference until it is unlocked via the unLock() method. Returns true when the conference is secured and locked; false otherwise. The parameter "IS_LOCKED" is read-only and is accessable via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

IS_ENTRY_ON

static final java.lang.String IS_ENTRY_ON
Determines if the conference has entry tones enabled. If entry tones are enabled, then whenever a participant enters the conference a system tone, system message, or both are played to the conference. Returns true when entry tones are enabled; false otherwise. The parameter "IS_ENTRY_ON" is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

IS_EXIT_ON

static final java.lang.String IS_EXIT_ON
Determines if the conference has exit tones enabled. If exit tones are enabled, then whenever a participant exits the conference a system tone, system message, or both are played to the conference. Returns true when exit tones are enabled; false otherwise. The parameter "IS_EXIT_ON" is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

ENTRY_TONEVAL

static final java.lang.String ENTRY_TONEVAL
The value of the entry notification : OFF, SYSTEM, TONE, MESSAGE or BOTH tone and message.
 
The parameter "ENTRY_TONEVAL" can be accessed via the getParameter() method and set with the setParameter() method.
 
The type of this parameter is Integer.

See Also:
TONEVAL_OFF, TONEVAL_SYS, TONEVAL_TONE, TONEVAL_MESSAGE, TONEVAL_BOTH, Constant Field Values

EXIT_TONEVAL

static final java.lang.String EXIT_TONEVAL
The value of the exit notification : OFF, SYSTEM, TONE, MESSAGE or BOTH tone and message.
 
The parameter "EXIT_TONEVAL" can be accessed via the getParameter() method and set with the setParameter() method.
 
The type of this parameter is Integer.

See Also:
TONEVAL_OFF, TONEVAL_SYS, TONEVAL_TONE, TONEVAL_MESSAGE, TONEVAL_BOTH, Constant Field Values

IS_GAIN_ON

static final java.lang.String IS_GAIN_ON
Determines if the conference has Gain enabled. When Gain is turned on, the bridge will attenuate participant audio, either increasing signal strength, or reducing it. This will equalize the audio heard by all members of the conference. When Gain is turned off, the participants will hear the audio as the carrier provides it. Returns true when Gain is enabled; false otherwise.
 
The type of this parameter is Boolean.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

IS_HELP_REQ

static final java.lang.String IS_HELP_REQ
Determines if the conference has requested help. This parameter is read-only and can be accessed via the getParameter() method. Returns true when help is required; false otherwise.
 
The type of this parameter is Boolean.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
Constant Field Values

QA_QUESTIONER

static final java.lang.String QA_QUESTIONER
The Participant ID of the participant, in the QA queue, who is currently asking a question. When the conference is in QA mode, participants may use DTMF commands to indicate to the moderator that they would like to ask a question. The "QA_QUESTIONER" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.
 
This parameter is only available on the Avaya 7000 Bridge.

See Also:
Constant Field Values

QA_NEXT

static final java.lang.String QA_NEXT
The Participant ID of the next participant in the QA queue waiting to ask a question. The "QA_NEXT" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.
 
This parameter is only available on the Avaya 7000 Bridge.

See Also:
Constant Field Values

IS_QA_ON

static final java.lang.String IS_QA_ON
Determines if the conference is in Q&A (Question and Answer) mode. When the conference is in Q&A mode, only moderators and a single non-moderator participant (the questioner) are not muted. The "IS_QA_ON" parameter is read-only and can be accessed via the getParameter() method. Returns true when the conference is in Q&A mode; false otherwise.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

IS_LECTURE_ON

static final java.lang.String IS_LECTURE_ON
Determines if the conference is in Lecture mode. When the conference is in lecture mode, all lines except moderator lines are muted, and can not unmute their own lines. The "IS_LECTURE_ON" parameter is read-only and can be accessed via the getParameter() method. True when the conference is lectured; false otherwise.
 
The type of this parameter is Boolean.
 
Use the startLecture() and stopLecture() methods to enable or disable lecture mode.
 
This parameter is only available on the Avaya 700/780 Bridge.

See Also:
startLecture(), stopLecture(), Constant Field Values

IS_MUTEALL_ON

static final java.lang.String IS_MUTEALL_ON
Determines if the conference is in silent mode. When a conference is in silent mode, all non-moderator lines in entering the conference are self-muted. Participants can use DTMF to unmute their line. True when the conference is in silent mode; false otherwise. Note, MuteAll or silent mode is only available on CALL_FLOW_FLEX and CALL_FLOW_CRYSTAL conferences.
 
The type of this parameter is Boolean. The "IS_MUTEALL_ON" parameter is read-only and can be accessed via the getParameter() method.
 
Use the startMuteAll() and stopMuteAll() methods to enable or disable silent mode.
 
This parameter is only available on the Avaya 700/780 and Crystal Bridge.

Since:
1.1
See Also:
startMuteAll(), stopMuteAll(), CALL_FLOW_FLEX, CALL_FLOW_CRYSTAL, Constant Field Values

IS_TUI_DIAL_OUT_ALLOWED

static final java.lang.String IS_TUI_DIAL_OUT_ALLOWED
Indicates whether or not a TUI should allow dial-outs. True if dial-outs are allowed; false otherwise. Note that this parameter does not take the current and maximum numbers of participants for this conference into account - for that, see PART_COUNT, MAX_PARTS, and AUTO_EXTEND_PARTICIPANTS.
 
The type of this parameter is Boolean. The "IS_TUI_DIAL_OUT_ALLOWED" parameter is read-only and can be accessed via the getParameter() method.
 
This parameter is only available on the Avaya 700/780 Bridge.

Since:
1.2
See Also:
GenericConference.PART_COUNT, MAX_PARTS, AUTO_EXTEND_PARTICIPANTS, Constant Field Values

AUTO_EXTEND_PARTICIPANTS

static final java.lang.String AUTO_EXTEND_PARTICIPANTS
Indicates whether or not the maximum number of participants set for this conference may be exceeded with further dial-outs or dial-ins. If "AUTO_EXTEND_PARTICIPANTS" is FALSE, the number of participants is restricted to MAX_PARTS, and when PART_COUNT has reached MAX_PARTS, new participants can not dial in, or be dialed out via the dialWithRestrictions() method, or moderator TUI.
 
If the Bridge.AUTO_EXTEND_PORTS parameter is Bridge.AUTO_EXTEND_PORTS_OFF, MAX_PARTS may not be exceeded regardless of "AUTO_EXTEND_PARTICIPANTS".
 
Note: The value of MAX_PARTS is set to 0 for ad-hoc conferences (i.e., conferences opened without a schedule), but does not restrict dialing out. Similarly, for ad-hoc conferences, AUTO_EXTEND_PARTICIPANTS is FALSE, but does not restrict dialing out.
 
The type of this parameter is Boolean. The "AUTO_EXTEND_PARTICIPANTS" parameter is read-only and can be accessed via the getParameter() method.
 
This parameter is only available on the Avaya 700/780 Bridge.

Since:
1.4
See Also:
MAX_PARTS, GenericConference.PART_COUNT, Bridge.AUTO_EXTEND_PORTS, Constant Field Values

MODERATOR_CODE

static final java.lang.String MODERATOR_CODE
The moderator code is the identifier used by moderators to enter the conference. The "MODERATOR_CODE" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.

See Also:
Constant Field Values

FLEX_MODERATOR_CODE

static final java.lang.String FLEX_MODERATOR_CODE
The flex moderator code is used for conference plus to allow a moderator to enter a flex conference with just entering this code without having to enter participant code first. The "FLEX_MODERATOR_CODE" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String. For flexFlow conferences that have been scheduled on a conferencePlus bridge this will hold the unique moderator code that can be used to enter the conference directly as a moderator.

Since:
S6200 5.0 BCAPI-1.6

S6100 NOT SUPPORTED

See Also:
Constant Field Values

IS_LEADER_PIN

static final java.lang.String IS_LEADER_PIN
Always return false for sFlow conferences. For flexFlow conferences returns true if the conference does not have a unique flex moderator code. Otherwise it return false. This "IS_LEADER_PIN" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

Since:
S6200 5.0 BCAPI-1.6

S6100 NOT SUPPORTED

See Also:
Constant Field Values

PARTICIPANT_CODE

static final java.lang.String PARTICIPANT_CODE
The participant code (also called conferee code) is the personal identifier used by non-moderators to enter the conference. This "PARTICIPANT_CODE" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.

See Also:
Constant Field Values

CONFIRM_NUM

static final java.lang.String CONFIRM_NUM
The unique confirmation number of the conference. This value is defined at schedule time. The "CONFIRM_NUM" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.
 
This parameter is only available on the Avaya 700/780 Bridge

See Also:
Constant Field Values

CONFERENCE_ID

static final java.lang.String CONFERENCE_ID
The identifier for the conference. This value is unique for each active conference on a particular bridge.
 
The "CONFERENCE_ID" parameter is read-only and can be accessed via the getParameter() method. This parameter can be used as the key under the Bridge.getConference() method.
 
The type of this parameter is String.

See Also:
Constant Field Values

BILLING_ID

static final java.lang.String BILLING_ID
The unique internal billing identifier used to identify this conference during the active life of the conference. BILLING_ID is considered a secondary billing id.
 
The "BILLING_ID" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.

See Also:
Constant Field Values

BILLING_CONFID

static final java.lang.String BILLING_CONFID
The billing identifier used to generate the CODR, which is used for tracking and billing after the conference has completed. The parameter "BILLING_CONFID" can be set with the setParameter() method.
 
The type of this parameter is String. Its maximum settable length is 60 characters for bridges of version 3.4 and later. For bridges of version 3.3 and earlier, its maximum settable length is 12 characters.
 
This parameter is only available on the Avaya 700/780 Bridge. It maps to the Conference Id in BridgeTalk.

See Also:
Constant Field Values

IS_DEMAND

static final java.lang.String IS_DEMAND
Determines if this conference is a demand conference. Returns true if the conference is a demand conference; false otherwise.
 
The "IS_DEMAND" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

RECORD_STATE

static final java.lang.String RECORD_STATE
Deprecated. The following parameters should be used it its place: RECORD_STATE_ONBRIDGE, PLAYBACK_STATE_ONBRIDGE, RECORD_STATE_OFFBRIDGE, RECORD_STATE_AUX, PLAYBACK_STATE_AUX
Reports the recording or playback state of the conference.
 
Modify the "RECORD_STATE" parameter via the startRecording(), stopRecording(), pauseRecording(), continueRecording(), startPlayback(), stopPlayback(), pausePlayback() and continuePlayback() methods.
 
The type of this parameter is Integer.
 

See Also:
REC_STATE_STOPPED, REC_STATE_RECORDING, REC_STATE_PAUSED, REC_STATE_STOPPING, REC_STATE_PLAYBACK, Constant Field Values

RECORD_STATE_ONBRIDGE

static final java.lang.String RECORD_STATE_ONBRIDGE
Reports the on-bridge recording state of the conference.
 
Modify the "RECORD_STATE_ONBRIDGE" parameter via the startRecording(), continueRecording(), stopRecording() and pauseRecording() methods.
 
The type of this parameter is Integer.
 

Since:
1.2
See Also:
REC_STATE_STOPPED, REC_STATE_RECORDING, REC_STATE_PAUSED, Constant Field Values

PLAYBACK_STATE_ONBRIDGE

static final java.lang.String PLAYBACK_STATE_ONBRIDGE
Reports the on-bridge playback state of the conference.
 
Modify the "PLAYBACK_STATE_ONBRIDGE" parameter via the startPlayback(), stopPlayback(), pausePlayback() and continuePlayback() methods.
 
The type of this parameter is Integer.
 

Since:
1.2
See Also:
REC_STATE_STOPPED, REC_STATE_PLAYBACK, REC_STATE_PAUSED, Constant Field Values

RECORD_STATE_OFFBRIDGE

static final java.lang.String RECORD_STATE_OFFBRIDGE
Reports the off-bridge recording state of the conference.
 
Modify the "RECORD_STATE_OFFBRIDGE" parameter via the startRecording() and stopRecording() methods.
 
The type of this parameter is Integer.
 

Since:
1.2
See Also:
REC_STATE_STOPPED, REC_STATE_RECORDING, REC_STATE_PAUSED, Constant Field Values

RECORD_STATE_AUX

static final java.lang.String RECORD_STATE_AUX
Reports the auxiliary recording state of the conference.
 
The type of this parameter is Integer.
 

Since:
1.2
See Also:
REC_STATE_STOPPED, REC_STATE_RECORDING, REC_STATE_PAUSED, Constant Field Values

PLAYBACK_STATE_AUX

static final java.lang.String PLAYBACK_STATE_AUX
Reports the auxiliary playback state of the conference.
 
The type of this parameter is Integer.
 

Since:
1.2
See Also:
REC_STATE_STOPPED, REC_STATE_PLAYBACK, REC_STATE_PAUSED, Constant Field Values

RECORDING_MODE

static final java.lang.String RECORDING_MODE
The scheduled recording mode for the conference.
 
The "RECORDING_MODE" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.
 

Since:
1.2
See Also:
REC_MODE_DEFAULT, REC_MODE_DISABLED, REC_MODE_ONBRIDGE, REC_MODE_OFFBRIDGE, Constant Field Values

MAX_PARTS

static final java.lang.String MAX_PARTS
The maximum number of participants normally allowed in the conference. When the AUTO_EXTEND_PARTICIPANTS flag is FALSE, or when the Bridge.AUTO_EXTEND_PORTS field is Bridge.AUTO_EXTEND_PORTS_OFF, "MAX_PARTS" is equal to the greatest number of participants allowed to dial into the conference. Moderators, or the dialWithRestrictions() method can not dial out of this conference when the number of participants in conference (PART_COUNT) equals or exceeds the value of "MAX_PARTS".

Note: The value of "MAX_PARTS" is set to 0 for ad-hoc conferences (i.e., conferences opened without a schedule), but does not restrict dialing out. Similarly, for ad-hoc conferences, AUTO_EXTEND_PARTICIPANTS is FALSE, but does not restrict dialing out.

The "MAX_PARTS" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
AUTO_EXTEND_PARTICIPANTS, Bridge.AUTO_EXTEND_PORTS, GenericConference.PART_COUNT, dialWithRestrictions(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, java.lang.String), Constant Field Values

MAX_SUB_PARTS

static final java.lang.String MAX_SUB_PARTS
The maximum number of participants allowed in the subconference.
 
The "MAX_SUB_PARTS" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.
 
This parameter is only available on the Avaya 7000 Bridge.

See Also:
Constant Field Values

CONF_TYPE

static final java.lang.String CONF_TYPE
The conference type: normal, subconference, or intercept.
 
The "CONF_TYPE" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
CONFTYPE_NORMAL, CONFTYPE_SUBCONF, CONFTYPE_INTERCEPT, Constant Field Values

SUBCONF_INDEX

static final java.lang.String SUBCONF_INDEX
Identifies the sub-conference index of this conference. The legal range of values is [0, MAX_SUBCONFS] where 0 means that this conference is not the child of another user conference. Otherwise, this parameter uniquely identifies the conference in the set of sub-conferences for the parent conference.
 
The "SUBCONF_INDEX" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

Since:
1.1
See Also:
Constant Field Values

MUSIC_SRC

static final java.lang.String MUSIC_SRC
Identifies the music source attached to the conference when IS_MUSIC_ON is true.
 
The "MUSIC_SRC" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
IS_MUSIC_ON, MUSIC_SRC_OFF, MUSIC_SRC_M1, MUSIC_SRC_M2, MUSIC_SRC_M3, MUSIC_SRC_M4, Constant Field Values

IS_MUSIC_ON

static final java.lang.String IS_MUSIC_ON
Determines if music is turned on for the conference. Returns true when music is turned on; false otherwise.
 
The "IS_MUSIC_ON" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
MUSIC_SRC, Constant Field Values

GLOBAL_ID

static final java.lang.String GLOBAL_ID
Reports the ID for a global conference. This parameter is only generated when the conference is scheduled as global. Returns a string when the conference is scheduled as global; otherwise this field is empty.
 
This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.

See Also:
Constant Field Values

NRP_MODE

static final java.lang.String NRP_MODE
The Name/Record playback mode: OFF, INDIVIDUAL, CONFERENCE, or OPERATOR_ONLY.
 
This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
NRPMODE_OFF, NRPMODE_INDIVIDUAL, NRPMODE_CONFERENCE, NRPMODE_OPERATOR_ONLY, Constant Field Values

RECPLAY_FILENAME

static final java.lang.String RECPLAY_FILENAME
The file name of the last conference recording or playback, or an empty string if neither of those actions was previously performed. For off-bridge recording, this value is always an empty string. This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.
 
This parameter is only available on the Avaya 700/780 Bridge.

Since:
1.1
See Also:
startRecording(), startPlayback(java.lang.String), Constant Field Values

IS_MOD_HANGUP

static final java.lang.String IS_MOD_HANGUP
Determines if moderator hangup is enabled. Returns true when moderator hangup is enabled; false otherwise.
 
This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

IS_GLOBAL_CONF

static final java.lang.String IS_GLOBAL_CONF
Indicates whether the conference is a global conference. Returns true when the conference is global; false otherwise.
 
This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

IS_SECURITY_ALLOWED

static final java.lang.String IS_SECURITY_ALLOWED
Determines whether security is allowed in this conference. The lock() and unLock() methods are only supported in conferences where security is allowed. Returns true when the security is allowed in this conference; false otherwise.
 
The "IS_SECURITY_ALLOWED" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

IS_CONF_VIEW

static final java.lang.String IS_CONF_VIEW
Determines if the Conference Viewer application has been scheduled for the conference. Returns true when the Conference Viewer application is scheduled for this conference; false otherwise.
 
This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

See Also:
Constant Field Values

IS_DIALOUT_BLOCKED

static final java.lang.String IS_DIALOUT_BLOCKED
Determines whether a moderator may manually dial out (ODO) from this conference. Returns true when dialout is not allowed from this conference; false otherwise.
 
The "IS_DIALOUT_BLOCKED" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.

Since:
1.1
See Also:
Constant Field Values

CROSS_REFERENCE

static final java.lang.String CROSS_REFERENCE
The unique identifier associated with a conference when it is started. It is used to associate intercept or sub-conferences with a parent conference.
 
The "CROSS_REFERENCE" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.
 
This parameter is only available on the Avaya 700/780 Bridge

See Also:
Constant Field Values

DIAL_LIST

static final java.lang.String DIAL_LIST
The dial list of participants identified at schedule time. This parameter can be used to retrieve the contents of the dial list to perform various dialing functionality.
 
The "DIAL_LIST" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.

See Also:
Constant Field Values

SCHED_START_TIME

static final java.lang.String SCHED_START_TIME
The scheduled start time, in military time, of the conference. For example 1 AM is returned as "100".
 
The "SCHED_START_TIME" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

SCHED_END_TIME

static final java.lang.String SCHED_END_TIME
The scheduled end time, in military time, of the conference. For example 1 AM is returned as "100".
 
The "SCHED_END_TIME" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

SCHED_START_MONTH

static final java.lang.String SCHED_START_MONTH
The scheduled start month of the conference. Returns an integer corresponding to the month. For example, 1 is January, 2 is February, ...and 12 is December.
 
The "SCHED_START_MONTH" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

SCHED_START_DAY

static final java.lang.String SCHED_START_DAY
The scheduled start day (date) of the conference. Returns a value that maps to the correct day. For example, when 12 is returned, this maps to the 12th day of the month.
 
The "SCHED_START_DAY" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

SCHED_START_YEAR

static final java.lang.String SCHED_START_YEAR
The scheduled start year of the conference. Returns a value that is offset from 1900. In otherwords, add 1900 to the returned value to get the year. For example, if 100 is returned, the year is 2000 (1900 + 100 = 2000).
 
The "SCHED_START_YEAR" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

SCHED_END_MONTH

static final java.lang.String SCHED_END_MONTH
The scheduled end month of the conference. Returns an integer corresponding to the month. For example, 1 is January, 2 is February, ...and 12 is December.
 
The "SCHED_END_MONTH" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

SCHED_END_DAY

static final java.lang.String SCHED_END_DAY
The scheduled end day of the conference. Returns a value that maps to the correct day. For example, when 12 is returned, this maps to the 12th day of the month.
 
The "SCHED_END_DAY" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

SCHED_END_YEAR

static final java.lang.String SCHED_END_YEAR
The scheduled end year of the conference. Returns a value that is offset from 1900. In otherwords, add 1900 to the returned value to get the year. For example, if 100 is returned, the year is 2000 (1900 + 100 = 2000).
 
The "SCHED_END_YEAR" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

See Also:
Constant Field Values

APP_FLAGS

static final java.lang.String APP_FLAGS
Indicates applications currently running in the conference. The "APP_FLAGS" parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Byte.

See Also:
Constant Field Values

CALL_FLOW

static final java.lang.String CALL_FLOW
The call flow used by the conference: DEFAULT (SPECTEL) or FLEX.
 
This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

Since:
1.1
See Also:
CALL_FLOW_SPECTEL, CALL_FLOW_DEFAULT, CALL_FLOW_CRYSTAL, CALL_FLOW_FLEX, Constant Field Values

PROMPT_SET

static final java.lang.String PROMPT_SET
The prompt set used by the conference: 1 - MAX_PROMPTSETS
 
This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Integer.

Since:
1.1
See Also:
MAX_PROMPTSETS, Participant.PROMPT_SET, Participant.MAX_PROMPTSETS, Constant Field Values

ACCOUNT_NUM

static final java.lang.String ACCOUNT_NUM
The account number assigned to the conference. This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is String.
 
This parameter is only available on the Avaya 700/780 Bridge.

Since:
1.2
See Also:
Constant Field Values

IS_HELP_REQ_ALLOWED

static final java.lang.String IS_HELP_REQ_ALLOWED
Indicates whether or not help requests are allowed. Returns true when requesting help is allowed; false otherwise. This parameter is read-only and can be accessed via the getParameter() method.
 
The type of this parameter is Boolean.
 
This parameter is only available on the Avaya 700/780 Bridge.

Since:
1.3
See Also:
Constant Field Values

REC_STATE_STOPPED

static final java.lang.Integer REC_STATE_STOPPED
State (value = 1) to indicate recording is stopped.

REC_STATE_RECORDING

static final java.lang.Integer REC_STATE_RECORDING
State (value = 2) to indicate recording is active.

REC_STATE_PAUSED

static final java.lang.Integer REC_STATE_PAUSED
State (value = 3) to indicate recording is paused.

REC_STATE_STOPPING

static final java.lang.Integer REC_STATE_STOPPING
State (value = 4) to indicate recording is stopping.

REC_STATE_PLAYBACK

static final java.lang.Integer REC_STATE_PLAYBACK
State (value = 5) to indicate recording is being played back.

REC_MODE_DEFAULT

static final java.lang.Integer REC_MODE_DEFAULT
Mode (value = 0) indicates conference is using the bridge setting. This specific value will only show up for ad-hoc conferences, and conference rooms not in service. Conferences that were scheduled with the system default recording mode will display either REC_MODE_ONBRIDGE or REC_MODE_OFFBRIDGE, depending on the bridge setting.

Since:
1.2
See Also:
RECORDING_MODE, REC_MODE_ONBRIDGE, REC_MODE_OFFBRIDGE

REC_MODE_DISABLED

static final java.lang.Integer REC_MODE_DISABLED
Mode (value = 1) indicates conference has recording disabled.

Since:
1.2
See Also:
RECORDING_MODE

REC_MODE_ONBRIDGE

static final java.lang.Integer REC_MODE_ONBRIDGE
Mode (value = 2) indicates conference is scheduled for on-bridge recording.

Since:
1.2
See Also:
RECORDING_MODE

REC_MODE_OFFBRIDGE

static final java.lang.Integer REC_MODE_OFFBRIDGE
Mode (value = 3) indicates conference is scheduled for off-bridge recording. Note that if the bridge is set for on-bridge recording, and the conference is set for off-bridge recording, actual recording will be performed on-bridge.

Since:
1.2
See Also:
RECORDING_MODE

NRPMODE_OFF

static final java.lang.Integer NRPMODE_OFF
State (value = 0) to indicate the system will not play any NRP recording.

NRPMODE_INDIVIDUAL

static final java.lang.Integer NRPMODE_INDIVIDUAL
State (value = 1) to indicate the system will play a recording only to the individual.

NRPMODE_CONFERENCE

static final java.lang.Integer NRPMODE_CONFERENCE
State (value = 2) to indicate the system will play a recording to the conference.

NRPMODE_OPERATOR_ONLY

static final java.lang.Integer NRPMODE_OPERATOR_ONLY
State (value = 3) to indicate the system will play a recording to the operator.

CONFTYPE_NORMAL

static final java.lang.Integer CONFTYPE_NORMAL
State (value = 0) to indicate the conference is of type normal.

CONFTYPE_SUBCONF

static final java.lang.Integer CONFTYPE_SUBCONF
State (value = 1) to indicate the conference is of type subconference.

CONFTYPE_INTERCEPT

static final java.lang.Integer CONFTYPE_INTERCEPT
State (value = 2) to indicate the conference is of type intercept.

CONFTYPE_OPER_ASSIST

static final java.lang.Integer CONFTYPE_OPER_ASSIST
State (value = 3) to indicate the conference is of type timed operator assistance.

Since:
CMAPI 1.3, Bridge 4.0

CONFTYPE_INTERCEPT_NOCDR

static final java.lang.Integer CONFTYPE_INTERCEPT_NOCDR
State (value = 4) to indicate the conference is of type intercept without CDR record.

Since:
CMAPI 1.3, Bridge 4.0

MUSIC_SRC_OFF

static final java.lang.Integer MUSIC_SRC_OFF
Source (value = 0) indicates no music channel is attached to the conference.

MUSIC_SRC_M1

static final java.lang.Integer MUSIC_SRC_M1
Source (value = 1) indicates music channel 1 is attached to the conference.

MUSIC_SRC_M2

static final java.lang.Integer MUSIC_SRC_M2
Source (value = 2) indicates music channel 2 is attached to the conference.

MUSIC_SRC_M3

static final java.lang.Integer MUSIC_SRC_M3
Source (value = 3) indicates music channel 3 is attached to the conference.

MUSIC_SRC_M4

static final java.lang.Integer MUSIC_SRC_M4
Source (value = 4) indicates music channel 4 is attached to the conference.

NO_HOLD

static final java.lang.Byte NO_HOLD
Hold state parameter for dial commands. NO_HOLD is the default.

HOLD_M1

static final java.lang.Byte HOLD_M1
Hold state parameter for dial commands.

HOLD_M2

static final java.lang.Byte HOLD_M2
Hold state parameter for dial commands.

HOLD_M3

static final java.lang.Byte HOLD_M3
Hold state parameter for dial commands.

HOLD_M4

static final java.lang.Byte HOLD_M4
Hold state parameter for dial commands.

HOLD_NO_MUSIC

static final java.lang.Byte HOLD_NO_MUSIC
Hold state parameter for dial commands.

TONEVAL_OFF

static final java.lang.Integer TONEVAL_OFF
State (value = 0) to indicate the system will not play any entry/exit notification to the conference.

TONEVAL_SYS

static final java.lang.Integer TONEVAL_SYS
State (value = 1) to indicate the system will play the conference entry/exit setting to the conference.

TONEVAL_TONE

static final java.lang.Integer TONEVAL_TONE
State (value = 2) to indicate the system will play a tone to the conference.

TONEVAL_MESSAGE

static final java.lang.Integer TONEVAL_MESSAGE
State (value = 3) to indicate the system will play a message to the conference.

TONEVAL_BOTH

static final java.lang.Integer TONEVAL_BOTH
State (value = 4) to indicate the system will play both a tone and a message to the conference.

MAX_INTERCEPTS

static final int MAX_INTERCEPTS
Maximum number of simultaneous intercept conferences allowed from a single user conference.

See Also:
CONF_TYPE, dial(String,String,String,boolean,String), Constant Field Values

MAX_SUBCONFS

static final int MAX_SUBCONFS
Maximum number of simultaneous sub-conferences allowed from a single user conference.

Since:
1.1
See Also:
CONF_TYPE, addToSubConf(String), addToSubConf(String,Integer), Constant Field Values

MAX_PROMPTSETS

static final int MAX_PROMPTSETS
The maximum value for the range of prompt sets available for the conference.

Since:
1.1
See Also:
PROMPT_SET, Participant.PROMPT_SET, Participant.MAX_PROMPTSETS, Constant Field Values

CALL_FLOW_DEFAULT

static final java.lang.Integer CALL_FLOW_DEFAULT
State (value = 0) to indicate the call flow is of type DEFAULT (formerly called SPECTEL).

Since:
1.4
See Also:
CALL_FLOW

CALL_FLOW_SPECTEL

static final java.lang.Integer CALL_FLOW_SPECTEL
State (value = 0) to indicate the call flow is of type DEFAULT (formerly called SPECTEL).

Since:
1.1
See Also:
CALL_FLOW

CALL_FLOW_FLEX

static final java.lang.Integer CALL_FLOW_FLEX
State (value = 1) to indicate the call flow is of type Flex.

Since:
1.1
See Also:
CALL_FLOW

CALL_FLOW_CRYSTAL

static final java.lang.Integer CALL_FLOW_CRYSTAL
State (value = 2) to indicate the call flow is of type Crystal.

Since:
2.0
See Also:
CALL_FLOW
Method Detail

setParameter

void setParameter(java.lang.String key,
                  java.lang.String value)
                  throws BridgeException
Set the parameter identified with the given key with the given value. For a parameter value of String size longer than the parameter's documented maximum length, the String will be truncated to its maximum length when it is set.

Parameters:
key - The String value identifying the desired parameter.
value - The new object value for the parameter.
Throws:
BridgeException - thrown if there are errors while sending the request for change to the bridge.

setParameters

void setParameters(java.util.Hashtable param)
                   throws BridgeException
Set parameters given in the hashtable. For parameters whose values are of type String, if the value's String size is longer than the parameter's documented maximum length, the value will be truncated to its maximum length when it is set.

Parameters:
param - Hashtable defined param-value pairs to set.
Throws:
BridgeException - thrown if there are errors while sending the request for change to the bridge.

setPromptSet

void setPromptSet(java.lang.Integer promptSet)
                  throws BridgeException
Set the prompt set for the conference. The promptSet should be within the range [1, MAX_PROMPTSETS].

Parameters:
promptSet - The desired prompt set for the conference.
Throws:
BridgeException - thrown if there are errors while sending the request for change to the bridge. An exception will also be thrown if promptSet is null or it is not in the range [1, MAX_PROMPTSETS].
Since:
1.1
See Also:
PROMPT_SET, MAX_PROMPTSETS

getLocalParticipantIds

java.util.Vector getLocalParticipantIds()
Get the IDs of participants, including moderators, currently in this conference. It does not include participants in any associated subconference or associated intercept conference.
 
This returned Vector is new each time, not shared with other callers, modifying it does not change future calls.

Returns:
list of the participant IDs or an empty vector if the list is empty or uninitialized.
Since:
1.1

getChildConferenceIds

java.util.Vector getChildConferenceIds()
Get the IDs of subconferences or intercept conferences currently associated with this conference.
 
This returned Vector is new each time, not shared with other callers, modifying it does not change future calls.

Returns:
list of the conference IDs or an empty vector if the list is empty or uninitialized.
Since:
1.1
See Also:
getParentConferenceId()

getParentConferenceId

java.lang.String getParentConferenceId()
Get the ID of the parent conference to this child conference. This conference will be considered a child conference if it has a parent.

Returns:
The conference ID of the parent to this conference. It returns the conference ID of this conference if it does not have a parent.
Since:
1.1
See Also:
getChildConferenceIds()

startLecture

void startLecture()
                  throws BridgeException
Enables conference lecture mode, so only moderator participants will be audible. This causes an event of type CONFERENCE_EVENT. It also causes an event of type PARTICIPANT_EVENT for all non-moderator participants in the conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

startLecture

void startLecture(boolean obeyRestrictions)
                  throws BridgeException
Enables conference lecture mode if a moderator is allowed to do so. If successful, only moderator participants will be audible. This causes an event of type CONFERENCE_EVENT. It also causes an event of type PARTICIPANT_EVENT for all non-moderator participants in the conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
obeyRestrictions - if true a BridgeException will be thrown if a moderator is not allowed to enable lecture mode.
Throws:
BridgeException - Thrown if obeyRestrictions is true and a moderator is not allowed to enable lecture mode, or if there is an internal error while sending the request for change to the bridge.
Since:
1.4
See Also:
Bridge.IS_MOD_LECTURE_ALLOWED

stopLecture

void stopLecture()
                 throws BridgeException
Disables the lecture mode of the conference, allowing non-moderator participants to be heard. This causes an event of type CONFERENCE_EVENT. It also causes an event of type PARTICIPANT_EVENT for all non-moderator participants in the conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

startMuteAll

void startMuteAll()
                  throws BridgeException
Turns MuteAll mode on for the conference, muting all non-moderator participants in a way that they can still unmute themselves. MuteAll can be turned on several times in sequence, each time muting all non-moderator participants that unmuted in the meantime. Note, MuteAll mode is only available on CALL_FLOW_FLEX conferences and this method will fail silently when called on any other type of conferences but CALL_FLOW_FLEX conferences.

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.1
See Also:
CALL_FLOW_FLEX, stopMuteAll(), IS_MUTEALL_ON

startMuteAll

void startMuteAll(short moderatorId)
                  throws BridgeException
Turns MuteAll mode on for the conference, muting all participants except the moderator passed in in a way that they can still unmute themselves. MuteAll can be turned on several times in sequence, each time muting all participants except the moderator passed in that unmuted in the meantime. Note, this flavor of MuteAll is supported for all call flows.

Parameters:
moderatorId - The moderator who is starting muteAll, and as such will not be muted.
Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.1
See Also:
stopMuteAll(), IS_MUTEALL_ON

stopMuteAll

void stopMuteAll()
                 throws BridgeException
Turns MuteAll mode off for the conference, unmuting all self-muted participants.

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.1
See Also:
startMuteAll(), IS_MUTEALL_ON

startQA

void startQA()
             throws BridgeException
Starts a Q&A session for the conference. When the conference is in Q&A mode, only moderators and a single non-moderator participant (the questioner) may speak. All other non-moderator participants are muted and may not unmute themselves.
 
This causes an event of type CONFERENCE_EVENT. An event of type PARTICIPANT_EVENT will be generated for any participants in the conference who are not moderators and who are not already muted. Another event of type PARTICIPANT_EVENT will be generated for any participant partaking in the Q&A session.

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

stopQA

void stopQA()
            throws BridgeException
Stops the Q&A session for the conference. This causes an event of type CONFERENCE_EVENT. An event of type PARTICIPANT_EVENT will be generated for any non-moderator participants in the conference, who were unmuted prior to the start of the QA session.

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

getQAParticipantIds

java.util.Vector getQAParticipantIds()
                                     throws BridgeException
Returns a Vector of participants currently involved in a Q&A session for the conference, as String objects of participant Id. This Vector will include all the moderators, participants asking to be recognized, and participants asking for operator assistance.
 
This returned Vector is new each time, not shared with other callers, modifying it does not change future calls.

Returns:
The ids of the participants involved in the conference Q&A session.
Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
See Also:
Participant.IS_IN_QA, Participant.IS_HELP_REQ

getQAParticipantIds

java.util.Vector getQAParticipantIds(boolean includeQA,
                                     boolean includeMods,
                                     boolean includeHelp)
                                     throws BridgeException
Returns the line number list of particpants currently in a QA session.

Parameters:
includeQA - If true, include the participants who are currently participating in the Q&A session. These participants will have IS_IN_QA equal to true.
includeMods - If true, include the moderators.
includeHelp - If true, include the participants that are requesting help.
Returns:
Participant line number list currently in QA. Depending on the flags, can be a mix of participant ids.
Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

startPolling

void startPolling()
                  throws BridgeException
Starts a Polling session for the conference. This causes an event of type CONFERENCE_EVENT. It also causes an event of type PARTICIPANT_EVENT for all participants in the conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

stopPolling

void stopPolling()
                 throws BridgeException
Stops a Polling session for the conference. This causes an event of type CONFERENCE_EVENT. It also causes an event of type PARTICIPANT_EVENT for all participants in the conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

clearPollingResults

void clearPollingResults()
                         throws BridgeException
Clears all votes tallied during a Polling session for the conference. This causes an event of type PARTICIPANT_EVENT for every participant taking part in the polling session.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

viewPollingResults

java.util.Hashtable viewPollingResults()
                                       throws BridgeException
Returns a Hashtable containing all votes tallied during a Polling session for the conference. The votes are stored with the same unique identifier used when adding a participant to the conference. Values range between 0-9, where 0 suggests that the participant abstained from voting. This returned Hashtable is new each time, and not shared with other callers; modifying it does not change future calls.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Returns:
A hashtable of string pairs representing the votes of each participant.
Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

inService

boolean inService()
Is this conference in service?

Returns:
Is this conference in service?

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 boolean dialModerator)
                 throws BridgeException
Dial a new participant out from the bridge

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
dialModerator - is this participant to have moderator control?
Returns:
Participant dialed or null.
Throws:
BridgeException - if there is a problem with the operation

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 java.lang.String portGroup,
                 boolean dialModerator)
                 throws BridgeException
Dial a new participant out from the bridge using a specific port group.

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
Returns:
Participant dialed or null.
Throws:
BridgeException - if there is a problem with the operation, or if portGroup is an invalid port group name.
Since:
1.2

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 java.lang.String portGroup,
                 boolean dialModerator,
                 java.util.Hashtable optional)
                 throws BridgeException
Dial a new participant out from the bridge. The optional Hashtable is not used for the S700 series bridges.

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
optional - Hashtable of optional parameters
Returns:
Participant dialed or null if asynchronous is set or if we are already waiting for an answer on this number.
Throws:
BridgeException - if there is a problem with the operation, or if portGroup is an invalid port group name.
Since:
1.2

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 java.lang.String portGroup,
                 boolean dialModerator,
                 byte holdState,
                 java.util.Hashtable optionalParams)
                 throws BridgeException
Quiet Dial wihout intercept. Dial a new participant out from the bridge specifying the hold state. The optional Hashtable is not used for the S700 series bridges.

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
holdState - specifies the hold state of the new participant (0-5)
optionalParams - Hashtable of optional parameters
Returns:
Participant dialed or null if asynchronous is set or if we are already waiting for an answer on this number.
Throws:
BridgeException - if there is a problem with the operation, or if portGroup is an invalid port group name.

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 boolean dialModerator,
                 java.lang.String interceptorID)
                 throws BridgeException
Dial a new participant out from the bridge and intercept the dialed line with an existing participant.

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
dialModerator - is this participant to have moderator control?
interceptorID - the ID of the participant with which to intercept the dialed line.
Returns:
Participant dialed
Throws:
BridgeException - if there is a problem with the operation, if this conference is an intercept conference, or if participantID is an invalid participant ID (including null).

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 java.lang.String portGroup,
                 boolean dialModerator,
                 java.lang.String interceptorID)
                 throws BridgeException
Dial a new participant out from the bridge using a specific port group and intercept the dialed line with an existing participant.

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
interceptorID - the ID of the participant with which to intercept the dialed line.
Returns:
Participant dialed
Throws:
BridgeException - if there is a problem with the operation, if portGroup is an invalid port group name, if this conference is an intercept conference, or if participantID is an invalid participant ID (including null).
Since:
1.2

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 java.lang.String portGroup,
                 boolean dialModerator,
                 java.lang.String interceptorID,
                 byte holdState,
                 java.util.Hashtable optional)
                 throws BridgeException
Quiet Dial with intercept. Dial a new participant out from the bridge using a specific port group and intercept the dialed line with an existing participant. Specify hold state of the new participant.

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
interceptorID - the ID of the participant with which to intercept the dialed line. *@param holdState specifies the hold state of the new participant (0-5)
holdState - the hold state to dial the participant into.
optional - Hashtable of optional parameters
Returns:
Participant dialed
Throws:
BridgeException - if there is a problem with the operation, if portGroup is an invalid port group name, if this conference is an intercept conference, or if participantID is an invalid participant ID (including null).

dialWithRestrictions

Participant dialWithRestrictions(java.lang.String name,
                                 java.lang.String company,
                                 java.lang.String phoneNumber,
                                 java.lang.String portGroup,
                                 boolean dialModerator,
                                 java.lang.String interceptorID)
                                 throws BridgeException
Dial a new participant out from the bridge using a specific port group and intercept the dialed line with an existing participant. This method simulates dialing from a TUI, as it carries the same restrictions of a TUI. Namely, IS_TUI_DIAL_OUT_ALLOWED must be TRUE, and this conference must have fewer than its maximum number of participants allowed, unless this restriction does not hold (see AUTO_EXTEND_PARTICIPANTS) or the maximum number of participants is equal to 0 (0 is the default value of MAX_PARTS for ad-hoc conferences and in that case, e.g MAX_PARTS=0, dialWithRestrictions() must behave as the basic dial(), and allow participants to be dialed-out from the ad-hoc conference).

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
interceptorID - the ID of the participant with which to intercept the dialed line.
Returns:
Participant dialed
Throws:
BridgeException - if there is a problem with the operation, if portGroup is an invalid port group name, if this conference is an intercept conference, if dial-outs are not allowed in this conference, or if the conference has reached its maximum capacity and cannot exceed it.
Since:
1.4
See Also:
IS_TUI_DIAL_OUT_ALLOWED, AUTO_EXTEND_PARTICIPANTS, MAX_PARTS, dial(java.lang.String, java.lang.String, java.lang.String, boolean)

dialWithRestrictions

Participant dialWithRestrictions(java.lang.String name,
                                 java.lang.String company,
                                 java.lang.String phoneNumber,
                                 java.lang.String portGroup,
                                 boolean dialModerator,
                                 java.lang.String interceptorID,
                                 byte holdState)
                                 throws BridgeException
Quiet Dial with restriction. Dial a new participant out from the bridge using a specific port group and intercept the dialed line with an existing participant. This method simulates dialing from a TUI, as it carries the same restrictions of a TUI. Namely, IS_TUI_DIAL_OUT_ALLOWED must be TRUE, and this conference must have fewer than its maximum number of participants allowed, unless this restriction does not hold (see AUTO_EXTEND_PARTICIPANTS) or the maximum number of participants is equal to 0 (0 is the default value of MAX_PARTS for ad-hoc conferences and in that case, e.g MAX_PARTS=0, dialWithRestrictions() must behave as the basic dial(), and allow participants to be dialed-out from the ad-hoc conference).

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
interceptorID - the ID of the participant with which to intercept the dialed line.
holdState - specifies the hold state of the new participant (0-5)
Returns:
Participant dialed
Throws:
BridgeException - if there is a problem with the operation, if portGroup is an invalid port group name, if this conference is an intercept conference, if dial-outs are not allowed in this conference, or if the conference has reached its maximum capacity and cannot exceed it.
See Also:
IS_TUI_DIAL_OUT_ALLOWED, AUTO_EXTEND_PARTICIPANTS, MAX_PARTS, dial(java.lang.String, java.lang.String, java.lang.String, boolean)

dial

Participant dial(java.lang.String name,
                 java.lang.String company,
                 java.lang.String phoneNumber,
                 java.lang.String portGroup,
                 boolean dialModerator,
                 java.lang.String interceptorID,
                 java.util.Hashtable optional)
                 throws BridgeException
Dial a new participant out from the bridge and intercept the dialed line with an existing participant. The optional Hashtable is not used for the S700 series bridges.

Parameters:
name - the participant's name
company - the company for this participant
phoneNumber - the phone number to dial
portGroup - the port group on the bridge to dial out from (null to have the bridge choose)
dialModerator - is this participant to have moderator control?
interceptorID - the ID of the participant with which to intercept the dialed line.
optional - Hashtable of optional parameters
Returns:
Participant dialed
Throws:
BridgeException - if there is a problem with the operation, if portGroup is an invalid port group name, if this conference is an intercept conference, or if interceptorID is an invalid participant ID (including null).
Since:
1.2

lock

void lock()
          throws BridgeException
Secure the conference. In this state, new participants or operators cannot enter the conference until it is unlocked via the unLock() method. Only works if security is allowed on the conference.

Throws:
BridgeException - if API call fails
See Also:
IS_SECURITY_ALLOWED, IS_LOCKED, unLock()

unLock

void unLock()
            throws BridgeException
Unsecure the conference. This allows new participants or operators to enter the conference.

Throws:
BridgeException - if API call fails
See Also:
IS_LOCKED, lock()

setSecurityAllowed

void setSecurityAllowed(boolean allowSecurity)
                        throws BridgeException
Allow or forbid securing the conference via Conference.lock() or moderator TUI.

Parameters:
allowSecurity - Whether to allow securing the conference.
Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.4
See Also:
IS_LOCKED, IS_SECURITY_ALLOWED, lock()

pauseRecording

void pauseRecording()
                    throws BridgeException
Pause recording for this conference.

Throws:
BridgeException - if API call fails
Since:
1.2

continueRecording

void continueRecording()
                       throws BridgeException
Continue recording for this conference.

Throws:
BridgeException - if API call fails
Since:
1.2

pausePlayback

void pausePlayback()
                   throws BridgeException
Pause playback for this conference.

Throws:
BridgeException - if API call fails
Since:
1.2

continuePlayback

void continuePlayback()
                      throws BridgeException
Continue playback for this conference.

Throws:
BridgeException - if API call fails
Since:
1.2

stopRecording

void stopRecording()
                   throws BridgeException
Stop recording for this conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - if API call fails
See Also:
RECORD_STATE

stopRecording

void stopRecording(boolean asModerator)
                   throws BridgeException
Stop recording for this conference, optionally only if the current recording was initiated by a moderator.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
asModerator - true to only stop moderator initiated recordings
Throws:
BridgeException - if asModerator is true and the current recording was not initiated by a moderator, or if the API call otherwise fails
Since:
1.4
See Also:
RECORD_STATE, startRecording(boolean)

startRecording

void startRecording()
                    throws BridgeException
Start recording for this conference. This will not work if the conference is secured, and a moderator will not be able to terminate this recording with DTMF TUI commands.
 
For on-bridge recording, a numerical file name will be automatically generated for the recording using a bridge-side algorithm.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - if the conference is secured (locked), the physical bridge returns an error, or there is a communication failure.
See Also:
RECORD_STATE, RECPLAY_FILENAME

startRecording

void startRecording(java.lang.String fileName)
                    throws BridgeException
Starts the recording of this conference. This will not work if the conference is secured, and a moderator will not be able to terminate this recording with DTMF TUI commands.


 
If external recording is enabled on the bridge, the file name is ignored. With on-bridge recording, the bridge will convert the entry to upper case and truncate the name to eight characters; if null is provided, a numerical file name will be generated using a bridge-side algorithm. The last file name used for either record or playback can be retrieved using the RECPLAY_FILENAME variable.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
fileName - The name of the recorded file for on-bridge recording. If null is passed, a name is auto-generated using a bridge-side algorithm.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request.
See Also:
RECORD_STATE, RECPLAY_FILENAME

startRecording

void startRecording(boolean asModerator)
                    throws BridgeException
Starts the recording of this conference, optionally with moderator privileges. If asModerator is true, any moderator will be able to stop this recording with DTMF TUI commands, and this method will be able to start a recording in a secured conference. If asModerator is false, a moderator will not be able to stop this recording, and this method will not be able to start a recording in a secured conference.
 
For on-bridge recording, a numerical file name will be automatically generated for the recording using a bridge-side algorithm.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
asModerator - if true, any moderator will be able to stop this recording with DTMF TUI commands, and this method will be able to start a recording in a secured conference. If false, a moderator will not be able to stop this recording, and this method will not be able to start a recording in a secured conference.
Throws:
BridgeException - if API call fails.
Since:
1.4
See Also:
RECORD_STATE, RECPLAY_FILENAME, startRecording()

startRecording

void startRecording(java.lang.String fileName,
                    boolean asModerator)
                    throws BridgeException
Starts the recording of this conference, optionally with moderator privileges. If asModerator is true, any moderator will be able to stop this recording with DTMF TUI commands, and this method will be able to start a recording in a secured conference. If asModerator is false, a moderator will not be able to stop this recording, and this method will not be able to start a recording in a secured conference.
 
If external recording is enabled on the bridge, the file name is ignored. With on-bridge recording, the bridge will convert the entry to upper case and truncate the name to eight characters; if null is provided, a numerical file name will be generated using a bridge-side algorithm. The last file name used for either record or playback can be retrieved using the RECPLAY_FILENAME variable.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
asModerator - true to allow moderators to stop this recording, and to allow recording a secured (locked) conference
fileName - The name of the recorded file for on-bridge recording. If null is passed, a name is auto-generated using a bridge-side algorithm.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request.
Since:
1.4
See Also:
RECORD_STATE, RECPLAY_FILENAME, startRecording(String)

startPlayback

void startPlayback(java.lang.String fileName)
                   throws BridgeException
Starts the playback of a recording specified by the file name. A file can not be played while it is being recorded to. The last file name used for either record or playback can be retrieved using the RECPLAY_FILENAME variable.

Parameters:
fileName - The name of the recorded file to playback.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request.
See Also:
RECORD_STATE, RECPLAY_FILENAME

startPlayback

void startPlayback(java.lang.String fileName,
                   boolean asModerator)
                   throws BridgeException
Starts the playback of a recording specified by the file name, optionally as a moderator, meaning that a moderator using the TUI or the API using moderator access can stop the playback. A file can not be played while it is being recorded to. The last file name used for either record or playback can be retrieved using the RECPLAY_FILENAME variable.

Parameters:
fileName - The name of the recorded file to playback.
asModerator - true to allow moderators to stop this playback, false not to allow moderators to stop this playback
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request.
Since:
1.4
See Also:
RECORD_STATE, RECPLAY_FILENAME, stopPlayback(boolean)

stopPlayback

void stopPlayback()
                  throws BridgeException
Stops the playback of a recording.

Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request.
See Also:
RECORD_STATE

stopPlayback

void stopPlayback(boolean asModerator)
                  throws BridgeException
Stops the playback of a recording, optionally as a moderator, meaning that this will only stop playbacks initiated by a moderator.

Parameters:
asModerator - true to only stop playbacks initiated by a moderator
Throws:
BridgeException - if the current playback was initiated by an operator, or if the physical bridge returns an error, indicating a failure on the request.
Since:
1.4
See Also:
RECORD_STATE, startPlayback(String,boolean)

addToSubConf

void addToSubConf(java.lang.String participantId)
                  throws BridgeException
Adds the desired participant to the sub-conference. The sub-conference will be automatically started when the first participant is placed. The sub-conference that will be intialized will sub-conference with index 1.

Parameters:
participantId - The id of the participant to add.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request, or if this conference is already a child of another conference.

addToSubConf

void addToSubConf(java.lang.String participantId,
                  java.lang.Integer subConfIndex)
                  throws BridgeException
Adds the desired participant to the sub-conference. The sub-conference will be automatically started when the first participant is placed into sub-conference of subConfIndex. The valid range of subConfIndex is (1-#MAX_SUBCONFS).

Parameters:
participantId - The id of the participant to add.
subConfIndex - The index of the sub-conference in which to add the participant.
Throws:
BridgeException - If the physical bridge returns an error, indicating a failure on the request, or if this conference is already a child of another conference. Also, if the subConfIndex is outside the range of 1 and #MAX_SUBCONFS.
Since:
1.1

removeFromSubConf

void removeFromSubConf(java.lang.String participantId)
                       throws BridgeException
Removes the desired participant from the subconference to the parent conference. The subconference will be automatically closed when the participant is removed.

Parameters:
participantId - The id of the participant to remove.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request or the method is called on a conference that has no attached subconference.

stopSubConference

void stopSubConference()
                       throws BridgeException
Stops the subconference for this conference by removing all participants from the subconference.

Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request or the method is called on a conference that has no attached subconference.
Since:
1.1

stopSubConference

void stopSubConference(java.lang.Integer subConfIndex)
                       throws BridgeException
Stops the sub-conference with subConfIndex for this conference. All participants of the sub-conference are returned to the parent conference.

Parameters:
subConfIndex - The sub-conference index identifying which sub-conference to stop.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request or the method is called on a conference that has no attached subconference.
Since:
1.1

getSubConfParticipantIds

java.util.Vector getSubConfParticipantIds()
Returns a Vector of participants, as String objects of participant Id, currently involved in a subconference for the conference. This returned Vector is new each time, and not shared with other callers; modifying it does not change future calls.

Returns:
The ids of the participants engaged in the subconference. An empty vector is returned if there is no attached subconference.

playRoster

void playRoster(java.lang.String tgtPartId)
                throws BridgeException
Depending on the conference's NRP setting, this action will play the total number of participants if this was not scheduled, or the recorded names of the participants if it was scheduled.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
tgtPartId - The id of the participant the roster will be played to.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request.

playParticipantInfo

void playParticipantInfo(java.lang.String srcPartId,
                         java.lang.String tgtPartId)
                         throws BridgeException
Play the line info of the source participant to the target participant.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
srcPartId - The source participants ID.
tgtPartId - The target participants ID.
Throws:
BridgeException - if the physical bridge returns an error, indicating a failure on the request.

closeConference

void closeConference()
                     throws BridgeException
Hangup all participants and close this conference

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

requestOperator

void requestOperator()
                     throws BridgeException
Request an operator's assistance on this conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there are no participants in the conference, or there is an internal error while sending the request for change to the bridge.
See Also:
Participant.requestConferenceWideOperator()

requestOperator

void requestOperator(boolean obeyRestrictions)
                     throws BridgeException
Request an operator's assistance on this conference if such requests are allowed.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Parameters:
obeyRestrictions - if true, will throw a BridgeException if the current conference's Conference.IS_HELP_REQ_ALLOWED is Boolean.FALSE. if false, will request an operator's assistance anyway.
Throws:
BridgeException - Thrown if help requests aren't allowed in this conference, if there are no participants in the conference, or there is an internal error while sending the request for change to the bridge.
Since:
1.4
See Also:
Participant.requestConferenceWideOperator(), IS_HELP_REQ_ALLOWED

cancelOperatorRequest

void cancelOperatorRequest()
                           throws BridgeException
Cancel an operator assistance request for this conference.
 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there are no participants in the conference, or if there is an internal error while sending the request for change to the bridge.
See Also:
Participant.cancelConferenceWideOperatorRequest()

enableModeratorHangup

void enableModeratorHangup()
                           throws BridgeException
Set this conference to end when the last moderator disconnects.


 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
See Also:
IS_MOD_HANGUP

disableModeratorHangup

void disableModeratorHangup()
                            throws BridgeException
Allow this conference to continue when the last moderator disconnects.


 
This functionality is only implemented on the Avaya 700/780 Bridge

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
See Also:
IS_MOD_HANGUP

enableMusic

void enableMusic()
                 throws BridgeException
Turns on music for this conference, using the default music source.
 

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.3
See Also:
disableMusic()

enableMusic

void enableMusic(java.lang.Integer musicSource)
                 throws BridgeException
Turns on music for this conference using a specific music source.
 

Parameters:
musicSource - The music source to use
Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.3
See Also:
MUSIC_SRC_M1, MUSIC_SRC_M2, MUSIC_SRC_M3, MUSIC_SRC_M4, disableMusic()

disableMusic

void disableMusic()
                  throws BridgeException
Turns off music for this conference.
 

Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.3
See Also:
enableMusic()

getActiveSpeakerIds

java.util.Vector getActiveSpeakerIds()
                                     throws BridgeException
Get participant ids of active speakers during a Q&A session.
 

Returns:
the participant ids of active speakers during a Q&A session.
Throws:
BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.
Since:
1.1
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
CONFIDENTIAL
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2005-2009 Avaya. All Rights Reserved.