Participant (BCAPI)

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 Participant

public interface Participant

This interface allows moderator control of Participants in an audio conference.

See Also:: Conference

Field Summary
`static java.lang.String`	`AUX1` An extra field that can be populated by user defined character data.
`static java.lang.String`	`AUX2` An extra field that can be populated by user defined character data.
`static java.lang.String`	`AUX3` An extra field that can be populated by user defined character data.
`static java.lang.String`	`AUXILIARY_CODE` An extra field that can be populated by user defined character data representing a billing code.
`static java.lang.String`	`CALL_START` Time in seconds from 00/00/1970 GMT when the line was seized by the bridge.
`static java.lang.String`	`CALL_TYPE` Identifies the type of call.
`static java.lang.String`	`CALL_TYPE_DIAL_IN` The call type for lines dialed into the bridge.
`static java.lang.String`	`CALL_TYPE_DIAL_OUT_BY_API` The call type for lines dialed out of the bridge by the API or Operator.
`static java.lang.String`	`CALL_TYPE_DIAL_OUT_BY_DTMF` The call type for lines dialed out of the bridge by moderator DTMF commands.
`static java.lang.String`	`CALL_TYPE_LINK_LINE` The call type for lines dialed by an operator and marked as virtual link line to lkink conference rooms.
`static java.lang.String`	`CALL_TYPE_OTHER` A line in a conference that is not defined by the other types.
`static java.lang.String`	`CALL_TYPE_UBLAST` The call type for lines dialed as a result of blast dial from operator or moderator DTMF.
`static java.lang.String`	`CALLER_ID` The CLI digits captured from the incoming call of the participant.
`static java.lang.String`	`CHAN_TYPE` The type of channel the participant is defined by the bridge.
`static java.lang.String`	`COMMENT` An optional field that can be populated with user defined character data.
`static java.lang.String`	`COMPANY` The name of the company associated with this participant.
`static java.lang.String`	`CONF_START` Time in seconds from 00/00/1970 GMT when the participant entered the conference associated with CONFERENCE_ID.
`static java.lang.String`	`CONFERENCE_ID` The conference Id of the conference that the participant is currently in.
`static java.lang.String`	`DNIS_DIGITS` The DDI digits captured from the incoming call of the participant.
`static java.lang.Integer`	`DR_ALARM` The participant has been disconnected due to the trunk going out of service.
`static java.lang.Integer`	`DR_CLPG_TIMEOUT` If configured on the bridge, the participant has been disconnected due to no answer within the configured timeout.
`static java.lang.Integer`	`DR_CONF_SECURED` If configured on the bridge, the participant has been disconnected due to the conference being secured.
`static java.lang.Integer`	`DR_CONF_TIME_EXPIRED` The participant has been disconnected due to the the conference end time being reached.
`static java.lang.Integer`	`DR_CONFEREE_TRANSFER` The participant has been transfered to another conference.
`static java.lang.Integer`	`DR_DNIS_HANGUP` If configured on the bridge, the participant has been disconnected due to the DNIS digits being matched to the call branding table for hang-up.
`static java.lang.Integer`	`DR_DSP_FAILURE` The participant has been disconnected due to a DSP failure signaling an inability to process the line.
`static java.lang.Integer`	`DR_ERROR` The participant has been disconnected due to an error when dialing out.
`static java.lang.Integer`	`DR_FAULT` The participant has been disconnected due to the line being faulted.
`static java.lang.Integer`	`DR_HOOKFLASH_TRANSFER` The participant has been disconnected due to a hook-flash transfer.
`static java.lang.Integer`	`DR_HOT_SWAP` The participant has been disconnected due to the hot-swapping of a telephony card that the participant was using.
`static java.lang.Integer`	`DR_INVALID_SEC_CODE` If configured on the bridge, the participant has been disconnected due to entering an invalid security code on all attempts.
`static java.lang.Integer`	`DR_INVALID_TIME` The participant has been disconnected due to an attempt to enter a conference at the wrong time of day (prior to start of the conference, or after the conference has concluded).
`static java.lang.Integer`	`DR_LINE_TIMEOUT` If configured on the bridge, the participant has been disconnected due to the time limit being reached for the active line.
`static java.lang.Integer`	`DR_MAX_LINES_IN_CONF` If configured on the bridge, the participant has been disconnected due to a maximum number of lines in the conference.
`static java.lang.Integer`	`DR_MOD_HANGUP` If configured on the bridge, the participant has been disconnected due to the last moderator exiting the conference.
`static java.lang.Integer`	`DR_NETWORK_INDICATED` The participant has hungup on the far end.
`static java.lang.Integer`	`DR_NULL` The participant is currently active and not disconnected.
`static java.lang.Integer`	`DR_ODO_HANGUP` The participant has been disconnected due to an aborted ODO attempt by the moderator via DTMF.
`static java.lang.Integer`	`DR_OPERATOR_HANGUP` The participant has been hungup on the near end (by an operator).
`static java.lang.Integer`	`DR_SEC_CODE_TIMEOUT` If configured on the bridge, the participant has been disconnected due to a failure in entering the security code in the time period alloted.
`static java.lang.Integer`	`DR_SINGLE_PERSON_CONF` The participant was alone in the conference for too long.
`static java.lang.Integer`	`DR_SYS_OTHER` The participant has been disconnected and the reason is undefined.
`static java.lang.String`	`FROM_URI` The URI of an incoming line
`static java.lang.String`	`INTERCEPTED_WITH` The unique id associated with the currently intercepted participant.
`static java.lang.String`	`IS_BACKPATH` Identifies whether the participant is waiting for an interceptor to answer on the backpath.
`static java.lang.String`	`IS_HELD` Indicates that this line is individually "on hold", in other words is muted and cannot speak to or hear any of the rest of the conference.
`static java.lang.String`	`IS_HELP_REQ` Identifies if the participant has requested help.
`static java.lang.String`	`IS_IN_POLL` Identifies if the participant is participating in a Polling session.
`static java.lang.String`	`IS_IN_QA` Identifies when a participant is trying to ask a question in a Q&A (Question and Answer) session.
`static java.lang.String`	`IS_IN_SUBCONF` Identifies if the line is currently in a subconference.
`static java.lang.String`	`IS_INCOMING` Identifies whether the participant dialed into the bridge, not out from the bridge.
`static java.lang.String`	`IS_MODERATOR` Determines if this participant is a moderator.
`static java.lang.String`	`IS_MUTED` Identifies if this participant is muted.
`static java.lang.String`	`IS_OPER_MUTED` Identifies if this participant has operator mute applied.
`static java.lang.String`	`IS_OPERATOR` Determines if this participant is an operator.
`static java.lang.String`	`IS_RECORDING_LINE` Indicates that this line (or the participant obj) is a recording line for a conference.
`static java.lang.String`	`IS_SELF_MUTED` Identifies if this participant has applied a self-mute.
`static java.lang.String`	`IS_TALKING` Determines if this participant is currently speaking.
`static java.lang.String`	`IS_VLL` Determines if this participant is a Virtual Link Line (VLL).
`static int`	`MAX_PROMPTSETS` The maximum value for the range of prompt sets available for the participant.
`static java.lang.String`	`NAME` The name of the participant.
`static java.lang.String`	`PAC_DIGITS` PlayAdnCollect digits collected associated with this line
`static java.lang.Integer`	`PAC_EVENT_CANCELED` PAC_STATUS values
`static java.lang.Integer`	`PAC_EVENT_MATCH` PAC_STATUS values
`static java.lang.Integer`	`PAC_EVENT_MAX_EXCEEDED` PAC_STATUS values
`static java.lang.Integer`	`PAC_EVENT_MIN_NOT_MET` PAC_STATUS values
`static java.lang.Integer`	`PAC_EVENT_NO_MATCH` PAC_STATUS value
`static java.lang.Integer`	`PAC_EVENT_TIMEOUT` PAC_STATUS values
`static java.lang.String`	`PAC_STATUS` PlayAndCollect status associated with this line
`static java.lang.String`	`PARTICIPANT_ID` The unique identifier of this participant.
`static java.lang.String`	`PHONE_NUM` The phone number of the participant.
`static java.lang.String`	`PINCODE` The security id associated with this participant.
`static java.lang.String`	`PROMPT_SET` The prompt set used by the participant: 1 - `MAX_PROMPTSETS`, or 0 if the first update for this value has not yet been received by the bridge.
`static java.lang.String`	`QA_NEXT` The unique id associated with the next participant in the QA queue.
`static java.lang.String`	`QA_PRIORITY` The priority assigned to the participant during Q&A (Question and Answer) sessions.
`static java.lang.String`	`QAPRIORITY_EXCLUDED` The participant will be excluded from the Q&A session for the conference.
`static java.lang.String`	`QAPRIORITY_NORMAL` The participant may be included in the Q&A session for the conference.
`static java.lang.String`	`QAPRIORITY_TOP` The participant will be included in the Q&A session for the conference above any participants with a priority of QAPRIORITY_NORMAL.
`static java.lang.String`	`STATE` The current state of the participant.
`static java.lang.Integer`	`STATE_BEING_DIALED` Conferee state (value = 4) while outgoing call is awaiting answer.
`static java.lang.Integer`	`STATE_FREE` Conferee state (value = 1) after leaving conference.
`static java.lang.Integer`	`STATE_FULL_DUPLEX` Conferee state (value = 2) while in conference.
`static java.lang.Integer`	`STATE_IN_ANNUNCIATION` Conferee state (value = 5) while being played a message.
`static java.lang.Integer`	`STATE_INTERCEPTEE` Conferee state (value = 8) for normal caller intercepted with a moderator.
`static java.lang.Integer`	`STATE_INTERCEPTOR` Conferee state (value = 7) for a moderator intercepting another caller.
`static java.lang.Integer`	`STATE_ON_HOLD` Conferee state (value = 3) while on hold.
`static java.lang.Integer`	`STATE_WAITING_ON_INTERCEPT` Conferee state (value = 6) for moderator connected to backpath of dialed caller listening to call progress.
`static java.lang.String`	`TO_URI` The URI of an out going line
`static java.lang.String`	`WEB_ID` WebId associated with this line

Method Summary
`void`	`askQuestionOnQAChan()`
`void`	`cancelConferenceWideOperatorRequest()` Cancel the previous conference-wide operator help request for this participant.
`void`	`cancelOperatorRequest()` Cancel the previous individual operator help request for this participant.
`void`	`deRegister(BridgeListener listener)` Remove a listener from the Participant.
`void`	`disconnect()` Disconnect a Participant.
`java.lang.Integer`	`getDisconnectReason()` Retrieve the reason the participant was disconnected.
`java.lang.Object`	`getParameter(java.lang.String key)` Get the parameter defined by the given key string.
`java.util.Hashtable`	`getParameters()` Gets a Hashtable containing the current state of the Participant object.
`int`	`getPollingVote()` Returns a polling vote for this participant during a Polling session.
`void`	`hold()` Place a Participant on hold.
`void`	`hold(java.lang.Integer musicSource)` Place a participant on hold with the given music source.
`void`	`holdOff()` Take a participant off hold.
`void`	`intercept(java.lang.String participantID)` Intercept another Participant.
`void`	`interceptOff()` Return this participant and the participant with which it it is intercepted to the conference.
`boolean`	`isConnected()` Identifies whether this participant is either a member of a conference, or is otherwise active on the bridge.
`void`	`makeModerator(boolean toModerator)` Set the Participant to and from moderator status.
`void`	`moveQaPosition(int amount)` Move the Q&A position of this participant in the Q&A queue.
`void`	`moveQaPosition(int amount, boolean includeHelp, boolean includeMods, boolean includeQs)` Move the Q&A position of this participant in the Q&A queue.Depending on the provided filters, the participant will be moved relative to the moderators and help requests.
`void`	`mute()` Mute a Participant.
`void`	`operatorMute()` Applies operator mute to the Participant.
`void`	`operatorUnMute()` Removes operator mute from the Participant.
`void`	`placeInConference(java.lang.String conferenceId)` Place this participant into a conference.
`void`	`playAndCollect(short promptNo, short promptSet)` Play a prompt to a participant asking them to enter a dtmf.
`void`	`playAndCollect(short promptNo, short promptSet, byte minDigits, byte maxDigits)` Play a prompt to a participant asking them to enter a dtmf.
`void`	`playAndCollect(short promptNo, short promptSet, java.lang.String dtmfToMatch)` Play a prompt to a participant asking them to enter a dtmf.
`void`	`playAnnunciator(int msgNum)` Plays an annunciator message to this line.
`void`	`register(BridgeListener listener)` Register a listener for all events received by this Participant.
`void`	`removeFromQa()` Remove this participant from the Q&A queue (without accessing the line).
`void`	`requestConferenceWideOperator()` Request conference-wide operator help for the individual participant.
`void`	`requestConferenceWideOperator(boolean obeyRestrictions)` Request conference-wide operator help for the individual participant if such requests are allowed.
`void`	`requestOperator()` Request individual operator help for the specific participant.
`void`	`requestOperator(boolean obeyRestrictions)` Request an operator's assistance on this participant only if such requests are allowed.
`void`	`resumeQAChan()` Put the participant back into QA after they asked their question.
`void`	`selfMute()` Applies a self-mute to the Participant.
`void`	`selfUnMute()` Removes a self-mute from the Participant.
`void`	`sendDTMF(java.lang.String digits, boolean append)` Dials input DTMF string on the (presumably) already connected line.
`void`	`setAsynchronous()` Do not wait for command completion.
`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 parameters)` Set the parameters with the given hashtable.
`void`	`setPromptSet(java.lang.Integer promptSet)` Set the prompt set for the participant.
`void`	`setQaPriority(java.lang.String priority)` Set the Q&A priority for this participant.
`void`	`setSynchronous(long timeout)` Sets how long we should wait for command completion.
`void`	`toggle()` Toggle a Participant to or from a sub-conference.
`void`	`transferToConference(java.lang.String conferenceId)` Transfer this participant into the conference identified by conferenceId.
`void`	`unMute()` Un-mute a Participant.

Field Detail

NAME

static final java.lang.String NAME

The name of the participant. The "NAME" parameter can be modified using the setParameter() method. The setParameter() method is not available for the Conference Viewer DTK.

The type of this parameter is String. Its maximum settable length is 20 characters.

See Also:: Constant Field Values

PHONE_NUM

static final java.lang.String PHONE_NUM

The phone number of the participant. The "PHONE_NUM" parameter can be modified using the setParameter() method. The setParameter() method is not available for the Conference Viewer DTK.

The type of this parameter is String. Its maximum settable length is 40 characters.

See Also:: Constant Field Values

PINCODE

static final java.lang.String PINCODE

The security id associated with this participant. The "PINCODE" 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

COMPANY

static final java.lang.String COMPANY

The name of the company associated with this participant. Used as an optional data field. The "COMPANY" parameter can be modified using the setParameter() method.

The setParameter() method is not available for the Conference Viewer DTK.

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

AUX1

static final java.lang.String AUX1

An extra field that can be populated by user defined character data. The "AUX1" parameter can be modified using the setParameter() method. The setParameter() method is not available for the Conference Viewer DTK.

The type of this parameter is String. Its maximum settable length is 60 characters.

This parameter is only available on the Avaya 700/780 Bridge and maps directly to the comment field.

See Also:: Constant Field Values

AUX2

static final java.lang.String AUX2

An extra field that can be populated by user defined character data. The "AUX2" parameter can be modified using the setParameter() method. The setParameter() method is not available for the Conference Viewer DTK.

The type of this parameter is String. Its maximum settable length is 60 characters.

This parameter is only available on the Avaya 700/780 Bridge.

See Also:: Constant Field Values

AUX3

static final java.lang.String AUX3

An extra field that can be populated by user defined character data. The "AUX3" parameter can be modified using the setParameter() method. The setParameter() method is not available for the Conference Viewer DTK.

The type of this parameter is String. Its maximum settable length is 60 characters.

This parameter is only available on the Avaya 700/780 Bridge.

See Also:: Constant Field Values

AUXILIARY_CODE

static final java.lang.String AUXILIARY_CODE

An extra field that can be populated by user defined character data representing a billing code. The "AUXILIARY_CODE" parameter can be modified using the setParameter() method. The setParameter() method is not available for the Conference Viewer DTK.

The type of this parameter is String. Its maximum settable length is 40 characters.

This parameter is only available on the Avaya 700/780 Bridge.

See Also:: Constant Field Values

WEB_ID

static final java.lang.String WEB_ID

WebId associated with this line

See Also:: Constant Field Values

FROM_URI

static final java.lang.String FROM_URI

The URI of an incoming line

Since:: S6200 5.0 BCAPI-1.6
S6100 NOT SUPPORTED
See Also:: Constant Field Values

TO_URI

static final java.lang.String TO_URI

The URI of an out going line

Since:: S6200 5.0 BCAPI-1.6
S6100 NOT SUPPORTED
See Also:: Constant Field Values

PAC_STATUS

static final java.lang.String PAC_STATUS

PlayAndCollect status associated with this line

See Also:: Constant Field Values

PAC_DIGITS

static final java.lang.String PAC_DIGITS

PlayAdnCollect digits collected associated with this line

See Also:: Constant Field Values

COMMENT

static final java.lang.String COMMENT

An optional field that can be populated with user defined character data. The "COMMENT" parameter can be modifed using the setParameter() method.

The setParameter() method is not available for the Conference Viewer DTK.

The type of this parameter is String.

This parameter is only available on the Avaya 7000 Bridge, and should not be used with the Avaya 700/780. If you do use this parameter on a Avaya 700/780 bridge, it is mapped to the AUX1 parameter.

See Also:: Constant Field Values

INTERCEPTED_WITH

static final java.lang.String INTERCEPTED_WITH

The unique id associated with the currently intercepted participant. The "INTERCEPTED_WITH" parameter is read-only and can be accessed via the getParameter() method. This key must also be used under the Conference.getParticipant() method. The type of this parameter is String.

See Also:: Constant Field Values

QA_NEXT

static final java.lang.String QA_NEXT

The unique id associated with the next participant in the QA queue. The "QA_NEXT" parameter is read-only and can be accessed via the getParameter() method. This key must also be used under the Conference.getParticipant() method.

The type of this parameter is String.

See Also:: Constant Field Values

CONFERENCE_ID

static final java.lang.String CONFERENCE_ID

The conference Id of the conference that the participant is currently in. The "CONFERENCE_ID" parameter is read-only and can be accessed via the getParameter() method. This key must also be used under the Bridge.getConference() method.

The type of this parameter is String.

See Also:: Constant Field Values

IS_INCOMING

static final java.lang.String IS_INCOMING

Identifies whether the participant dialed into the bridge, not out from the bridge. Returns true when the participant dialed into the bridge; false when the participant was dialed out from the bridge. The "IS_INCOMING" 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_BACKPATH

static final java.lang.String IS_BACKPATH

Identifies whether the participant is waiting for an interceptor to answer on the backpath. The interceptor is defined as the participant greeting the participant who is waiting to enter the conference.

The "IS_BACKPATH" 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_VLL

static final java.lang.String IS_VLL

Determines if this participant is a Virtual Link Line (VLL). This is used to connect conferences across multiple bridges. Returns true when the participant is a VLL; false otherwise. The "IS_VLL" 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_HELP_REQ

static final java.lang.String IS_HELP_REQ

Identifies if the participant has requested help. Returns true when the participant requested help; false otherwise. The "IS_HELP_REQ" 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

See Also:: Constant Field Values

IS_IN_QA

static final java.lang.String IS_IN_QA

Identifies when a participant is trying to ask a question in a Q&A (Question and Answer) session. Returns true when the participant is in the Q&A queue; false otherwise. The "IS_IN_QA" 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_IN_POLL

static final java.lang.String IS_IN_POLL

Identifies if the participant is participating in a Polling session. Returns true when the participant is in a polling session; false otherwise. The "IS_IN_POLL" 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

See Also:: Constant Field Values

IS_MODERATOR

static final java.lang.String IS_MODERATOR

Determines if this participant is a moderator. Returns true when the participant is a moderator; false otherwise. The "IS_MODERATOR" 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.

See Also:: Constant Field Values

IS_OPERATOR

static final java.lang.String IS_OPERATOR

Determines if this participant is an operator. Returns true when the participant is an operator; false otherwise. The "IS_OPERATOR" 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_MUTED

static final java.lang.String IS_MUTED

Identifies if this participant is muted. Returns true when the participant is muted; false otherwise. The "IS_MUTED" 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_SELF_MUTED

static final java.lang.String IS_SELF_MUTED

Identifies if this participant has applied a self-mute. Returns true when the participant is self-muted, false otherwise. The "IS_SELF_MUTED" 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

IS_OPER_MUTED

static final java.lang.String IS_OPER_MUTED

Identifies if this participant has operator mute applied. Returns true when the participant is operator muted, false otherwise. The "IS_OPER_MUTED" 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

IS_TALKING

static final java.lang.String IS_TALKING

Determines if this participant is currently speaking. Returns true when the participant is speaking; false when the participant is silent.

Note that due to this parameter tending to change often, a change in this parameter is only indicated with a Bridge.TALKER_EVENT to Bridge-level listeners, unlike other Participant parameters, which change with PARTICIPANT_EVENT sent to Participant listeners.

The "IS_TALKING" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is Boolean.

See Also:: Bridge.TALKER_EVENT, Constant Field Values

IS_RECORDING_LINE

static final java.lang.String IS_RECORDING_LINE

Indicates that this line (or the participant obj) is a recording line for a conference. Returns true if the line is a recording line; false otherwise. The "IS_RECORDING_LINE" 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_HELD

static final java.lang.String IS_HELD

Indicates that this line is individually "on hold", in other words is muted and cannot speak to or hear any of the rest of the conference. The "IS_HELD" parameter is read-only and can be accessed via the getParameter() method

The type of this parameter is Boolean.

See Also:: Constant Field Values

CALL_START

static final java.lang.String CALL_START

Time in seconds from 00/00/1970 GMT when the line was seized by the bridge. The value is NOT reset when the participant hangs up. The "CALL_START" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is Integer.

See Also:: Constant Field Values

CONF_START

static final java.lang.String CONF_START

Time in seconds from 00/00/1970 GMT when the participant entered the conference associated with CONFERENCE_ID. This value is updated whenever the participant enters a subconference, intercept conference, or returns to the parent conference. The value is NOT reset when the participant leaves the conference. The "CONF_START" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is Integer.

See Also:: Constant Field Values

IS_IN_SUBCONF

static final java.lang.String IS_IN_SUBCONF

Identifies if the line is currently in a subconference. Returns true when the line is in a subconference; false otherwise. The "IS_IN_SUBCONF" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is Boolean.

See Also:: Constant Field Values

CHAN_TYPE

static final java.lang.String CHAN_TYPE

The type of channel the participant is defined by the bridge. Possible values include FDAPI types or user. A user is defined as a moderator or non-moderator conferee. The "CHAN_TYPE" 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 700/780 Bridge.

See Also:: Constant Field Values

CALLER_ID

static final java.lang.String CALLER_ID

The CLI digits captured from the incoming call of the participant. The "CALLER_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

DNIS_DIGITS

static final java.lang.String DNIS_DIGITS

The DDI digits captured from the incoming call of the participant. The "DNIS_DIGITS" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is String.

See Also:: Constant Field Values

PARTICIPANT_ID

static final java.lang.String PARTICIPANT_ID

The unique identifier of this participant. The "PARTICIPANT_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

CALL_TYPE

static final java.lang.String CALL_TYPE

Identifies the type of call. Users may enter any value, but usually this value is set to either: dial_out, dial_in, odo, VLL, or u_blast.

The "CALL_TYPE" parameter is only available on the Avaya 700/780 Bridge.

See Also:: Constant Field Values

CALL_TYPE_DIAL_IN

static final java.lang.String CALL_TYPE_DIAL_IN

The call type for lines dialed into the bridge.

The type of this parameter is String.

Since:: S6200 5.0 BCAPI-1.6
See Also:: CALL_TYPE, CALL_TYPE_DIAL_OUT_BY_API, CALL_TYPE_DIAL_OUT_BY_DTMF, CALL_TYPE_LINK_LINE, CALL_TYPE_UBLAST, CALL_TYPE_OTHER, Constant Field Values

CALL_TYPE_DIAL_OUT_BY_API

static final java.lang.String CALL_TYPE_DIAL_OUT_BY_API

The call type for lines dialed out of the bridge by the API or Operator.

The type of this parameter is String.

Since:: S6200 5.0 BCAPI-1.6
See Also:: CALL_TYPE, CALL_TYPE_DIAL_IN, CALL_TYPE_DIAL_OUT_BY_DTMF, CALL_TYPE_LINK_LINE, CALL_TYPE_UBLAST, CALL_TYPE_OTHER, Constant Field Values

CALL_TYPE_DIAL_OUT_BY_DTMF

static final java.lang.String CALL_TYPE_DIAL_OUT_BY_DTMF

The call type for lines dialed out of the bridge by moderator DTMF commands.

The type of this parameter is String.

Since:: S6200 5.0 BCAPI-1.6
See Also:: CALL_TYPE, CALL_TYPE_DIAL_IN, CALL_TYPE_DIAL_OUT_BY_API, CALL_TYPE_LINK_LINE, CALL_TYPE_UBLAST, CALL_TYPE_OTHER, Constant Field Values

CALL_TYPE_LINK_LINE

static final java.lang.String CALL_TYPE_LINK_LINE

The call type for lines dialed by an operator and marked as virtual link line to lkink conference rooms.

The type of this parameter is String.

Since:: S6200 5.0 BCAPI-1.6
See Also:: CALL_TYPE, CALL_TYPE_DIAL_IN, CALL_TYPE_DIAL_OUT_BY_API, CALL_TYPE_DIAL_OUT_BY_DTMF, CALL_TYPE_UBLAST, CALL_TYPE_OTHER, Constant Field Values

CALL_TYPE_UBLAST

static final java.lang.String CALL_TYPE_UBLAST

The call type for lines dialed as a result of blast dial from operator or moderator DTMF.

The type of this parameter is String.

Since:: S6200 5.0 BCAPI-1.6
See Also:: CALL_TYPE, CALL_TYPE_DIAL_IN, CALL_TYPE_DIAL_OUT_BY_API, CALL_TYPE_DIAL_OUT_BY_DTMF, CALL_TYPE_LINK_LINE, CALL_TYPE_OTHER, Constant Field Values

CALL_TYPE_OTHER

static final java.lang.String CALL_TYPE_OTHER

A line in a conference that is not defined by the other types.

The type of this parameter is String.

Since:: S6200 5.0 BCAPI-1.6
See Also:: CALL_TYPE, CALL_TYPE_DIAL_IN, CALL_TYPE_DIAL_OUT_BY_API, CALL_TYPE_DIAL_OUT_BY_DTMF, CALL_TYPE_LINK_LINE, CALL_TYPE_UBLAST, Constant Field Values

PROMPT_SET

static final java.lang.String PROMPT_SET

The prompt set used by the participant: 1 - MAX_PROMPTSETS, or 0 if the first update for this value has not yet been received by the bridge.

The parameter "PROMPT_SET" 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, Conference.PROMPT_SET, Conference.MAX_PROMPTSETS, Constant Field Values

QA_PRIORITY

static final java.lang.String QA_PRIORITY

The priority assigned to the participant during Q&A (Question and Answer) sessions. Possible values include top, normal and excluded. If excluded, the participant is not allowed to participate in the Q&A queue. If top, the participant gets listed ahead of normal priority participants in the Q&A queue. The "QA_PRIORITY" 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:: QAPRIORITY_NORMAL, QAPRIORITY_TOP, QAPRIORITY_EXCLUDED, Constant Field Values

QAPRIORITY_NORMAL

static final java.lang.String QAPRIORITY_NORMAL

The participant may be included in the Q&A session for the conference. Any participants with a priority of TOP are added to the QA list above this participant.

This parameter is only available on the Avaya 700/780 Bridge.

See Also:: QA_PRIORITY, QAPRIORITY_TOP, QAPRIORITY_EXCLUDED, Constant Field Values

QAPRIORITY_TOP

static final java.lang.String QAPRIORITY_TOP

The participant will be included in the Q&A session for the conference above any participants with a priority of QAPRIORITY_NORMAL.

This parameter is only available on the Avaya 700/780 Bridge.

See Also:: QAPRIORITY_NORMAL, QA_PRIORITY, QAPRIORITY_EXCLUDED, Constant Field Values

QAPRIORITY_EXCLUDED

static final java.lang.String QAPRIORITY_EXCLUDED

The participant will be excluded from the Q&A session for the conference.

This parameter is only available on the Avaya 700/780 Bridge.

See Also:: QAPRIORITY_NORMAL, QAPRIORITY_TOP, QA_PRIORITY, Constant Field Values

STATE

static final java.lang.String STATE

The current state of the participant. The "STATE" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is Integer.

See Also:: Constant Field Values

STATE_FREE

static final java.lang.Integer STATE_FREE

Conferee state (value = 1) after leaving conference.

The type of this parameter is Integer.

STATE_FULL_DUPLEX

static final java.lang.Integer STATE_FULL_DUPLEX

Conferee state (value = 2) while in conference.

The type of this parameter is Integer.

STATE_ON_HOLD

static final java.lang.Integer STATE_ON_HOLD

Conferee state (value = 3) while on hold.

The type of this parameter is Integer.

STATE_BEING_DIALED

static final java.lang.Integer STATE_BEING_DIALED

Conferee state (value = 4) while outgoing call is awaiting answer.

The type of this parameter is Integer.

STATE_IN_ANNUNCIATION

static final java.lang.Integer STATE_IN_ANNUNCIATION

Conferee state (value = 5) while being played a message.

The type of this parameter is Integer.

STATE_WAITING_ON_INTERCEPT

static final java.lang.Integer STATE_WAITING_ON_INTERCEPT

Conferee state (value = 6) for moderator connected to backpath of dialed caller listening to call progress.

The type of this parameter is Integer.

STATE_INTERCEPTOR

static final java.lang.Integer STATE_INTERCEPTOR

Conferee state (value = 7) for a moderator intercepting another caller.

The type of this parameter is Integer.

STATE_INTERCEPTEE

static final java.lang.Integer STATE_INTERCEPTEE

Conferee state (value = 8) for normal caller intercepted with a moderator.

The type of this parameter is Integer.

DR_NULL

static final java.lang.Integer DR_NULL

The participant is currently active and not disconnected. This field is used for comparison with the return value of getDisconnectReason().

DR_NETWORK_INDICATED

static final java.lang.Integer DR_NETWORK_INDICATED

The participant has hungup on the far end. This field is used for comparison with the return value of getDisconnectReason().

DR_OPERATOR_HANGUP

static final java.lang.Integer DR_OPERATOR_HANGUP

The participant has been hungup on the near end (by an operator). This field is used for comparison with the return value of getDisconnectReason().

DR_INVALID_SEC_CODE

static final java.lang.Integer DR_INVALID_SEC_CODE

If configured on the bridge, the participant has been disconnected due to entering an invalid security code on all attempts. This field is used for comparison with the return value of getDisconnectReason().

DR_SEC_CODE_TIMEOUT

static final java.lang.Integer DR_SEC_CODE_TIMEOUT

If configured on the bridge, the participant has been disconnected due to a failure in entering the security code in the time period alloted. This field is used for comparison with the return value of getDisconnectReason().

DR_CONF_SECURED

static final java.lang.Integer DR_CONF_SECURED

If configured on the bridge, the participant has been disconnected due to the conference being secured. This field is used for comparison with the return value of getDisconnectReason().

DR_INVALID_TIME

static final java.lang.Integer DR_INVALID_TIME

The participant has been disconnected due to an attempt to enter a conference at the wrong time of day (prior to start of the conference, or after the conference has concluded). This field is used for comparison with the return value of getDisconnectReason().

DR_MAX_LINES_IN_CONF

static final java.lang.Integer DR_MAX_LINES_IN_CONF

If configured on the bridge, the participant has been disconnected due to a maximum number of lines in the conference. This field is used for comparison with the return value of getDisconnectReason().

DR_CONF_TIME_EXPIRED

static final java.lang.Integer DR_CONF_TIME_EXPIRED

The participant has been disconnected due to the the conference end time being reached. This field is used for comparison with the return value of getDisconnectReason().

DR_HOOKFLASH_TRANSFER

static final java.lang.Integer DR_HOOKFLASH_TRANSFER

The participant has been disconnected due to a hook-flash transfer.

DR_LINE_TIMEOUT

static final java.lang.Integer DR_LINE_TIMEOUT

If configured on the bridge, the participant has been disconnected due to the time limit being reached for the active line.

DR_CLPG_TIMEOUT

static final java.lang.Integer DR_CLPG_TIMEOUT

If configured on the bridge, the participant has been disconnected due to no answer within the configured timeout. This field is used for comparison with the return value of getDisconnectReason().

DR_SYS_OTHER

static final java.lang.Integer DR_SYS_OTHER

The participant has been disconnected and the reason is undefined. This field is used for comparison with the return value of getDisconnectReason().

DR_FAULT

static final java.lang.Integer DR_FAULT

The participant has been disconnected due to the line being faulted. This field is used for comparison with the return value of getDisconnectReason().

DR_ALARM

static final java.lang.Integer DR_ALARM

The participant has been disconnected due to the trunk going out of service. This field is used for comparison with the return value of getDisconnectReason().

DR_DSP_FAILURE

static final java.lang.Integer DR_DSP_FAILURE

The participant has been disconnected due to a DSP failure signaling an inability to process the line. This field is used for comparison with the return value of getDisconnectReason().

DR_ERROR

static final java.lang.Integer DR_ERROR

The participant has been disconnected due to an error when dialing out. This field is used for comparison with the return value of getDisconnectReason().

DR_DNIS_HANGUP

static final java.lang.Integer DR_DNIS_HANGUP

If configured on the bridge, the participant has been disconnected due to the DNIS digits being matched to the call branding table for hang-up. This field is used for comparison with the return value of getDisconnectReason().

DR_ODO_HANGUP

static final java.lang.Integer DR_ODO_HANGUP

The participant has been disconnected due to an aborted ODO attempt by the moderator via DTMF. This field is used for comparison with the return value of getDisconnectReason().

DR_MOD_HANGUP

static final java.lang.Integer DR_MOD_HANGUP

If configured on the bridge, the participant has been disconnected due to the last moderator exiting the conference. This field is used for comparison with the return value of getDisconnectReason().

DR_CONFEREE_TRANSFER

static final java.lang.Integer DR_CONFEREE_TRANSFER

The participant has been transfered to another conference. This field is used for comparison with the return value of getDisconnectReason().

DR_SINGLE_PERSON_CONF

static final java.lang.Integer DR_SINGLE_PERSON_CONF

The participant was alone in the conference for too long. The bridge can be configured to disconnect a participant for this reason. (See S700 admin guide for details.) This field is used for comparison with the return value of getDisconnectReason().

Since:: 1.2

DR_HOT_SWAP

static final java.lang.Integer DR_HOT_SWAP

The participant has been disconnected due to the hot-swapping of a telephony card that the participant was using. This field is used for comparison with the return value of getDisconnectReason().

Since:: 1.3

MAX_PROMPTSETS

static final int MAX_PROMPTSETS

The maximum value for the range of prompt sets available for the participant.

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

PAC_EVENT_NO_MATCH

static final java.lang.Integer PAC_EVENT_NO_MATCH

PAC_STATUS value

PAC_EVENT_MATCH

static final java.lang.Integer PAC_EVENT_MATCH

PAC_STATUS values

PAC_EVENT_MIN_NOT_MET

static final java.lang.Integer PAC_EVENT_MIN_NOT_MET

PAC_STATUS values

PAC_EVENT_MAX_EXCEEDED

static final java.lang.Integer PAC_EVENT_MAX_EXCEEDED

PAC_STATUS values

PAC_EVENT_TIMEOUT

static final java.lang.Integer PAC_EVENT_TIMEOUT

PAC_STATUS values

PAC_EVENT_CANCELED

static final java.lang.Integer PAC_EVENT_CANCELED

PAC_STATUS values

Method Detail

getParameters

java.util.Hashtable getParameters()

Gets a Hashtable containing the current state of the Participant object. This returned Hashtable is new each time, and not shared with other callers; modifying it does not change future calls.

Mandatory Entries

CONFERENCE_ID - String - the conference id
STATE - Integer - current state of the participant

Optional Entries

Present when the participant is connected.

IS_INCOMING - Boolean - was this call dialed into, not out from, the bridge?
IS_BACKPATH - Boolean - if this call is awaiting an answer, is there an interceptor waiting on the backpath? (7000 only?)
IS_MODERATOR - Boolean - is this participant a moderator line?
IS_OPERATOR - Boolean - is this participant an operator line?
IS_MUTED - Boolean - is this participant muted? (should be one of the states)
PARTICIPANT_ID - Short - Unique ID of this participant
INTERCEPTED_WITH - Byte - ID of line with which this line is intercepted
PHONE_NUM - String - The telephone digits used to dial this participant out from the bridge
NAME - String - The name of this participant
PINCODE - String - The pin code for this participant
COMMENT - String - The comment associated with this participant
DNIS_DIGITS - String - DDI number of the incoming call
CALLER_ID - String - CLI number from the incoming call
CALL_START - Integer - start time, seconds from 00/00/1970 GMT
CONF_START - Integer - time participant entered current conference, seconds from 00/00/1970 GMT
QA_NEXT_PARTICIPANT_ID - String - the next called in the Q&A queue (7000 only?)
IS_IN_SUB_CONF - Boolean - is this line currenly in a subconference?
IS_VLL - Boolean - Is the participant a virtual link line connecting global conferences for multisite?
IS_IN_POLL - Boolean - Is the participant in a poll? (700 only?)
IS_TALKING - Boolean - Is there talker data on this participant line?

Returns:: The Hashtable
See Also:: getParameter(java.lang.String)

getParameter

java.lang.Object getParameter(java.lang.String key)

Get the parameter defined by the given key string.

Parameters:: key - The String value identifying the desired parameter.
Returns:: The parameter associated with the given key, null means not found.
See Also:: getParameters()

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 the key or value is null, the key is not a settable parameter key for the Participant object, or there are errors while sending the request for change to the bridge.

setParameters

void setParameters(java.util.Hashtable parameters)
                   throws BridgeException

Set the parameters with the given 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:: parameters - fields to change (e.g. Digits, Comment, Name)
Throws:: BridgeException - if any keys are not settable parameter keys for the Participant object, or 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 participant. The promptSet should be within the range [1, MAX_PROMPTSETS].

Parameters:: promptSet - The desired prompt set for the participant.
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

setAsynchronous

void setAsynchronous()

Do not wait for command completion.

setSynchronous

void setSynchronous(long timeout)

Sets how long we should wait for command completion.

This method is only available on the Avaya 7000 Bridge.

Parameters:: timeout - Milliseconds to wait for command to complete

isConnected

boolean isConnected()

Identifies whether this participant is either a member of a conference, or is otherwise active on the bridge.

Returns:: true if this participant is a member of a conference.

register

void register(BridgeListener listener)

Parameters:: listener - The Listener to add.

deRegister

void deRegister(BridgeListener listener)

Remove a listener from the Participant.

Parameters:: listener - The Listener to remove.

disconnect

void disconnect()
                throws BridgeException

Disconnect a Participant.

Note: If this participant is the interceptor of an intercept conference then calling disconnect will have the side-effect of also disconnecting the dialed party if they are both still in the intercept conference.

Throws:: BridgeException - If the message sent or received fails on the I/O Stream, or the physical bridge returns an error.

hold

void hold()
          throws BridgeException

Place a Participant on hold.

Throws:: BridgeException - if there is a problem with the operation If the message body of the exception reads "line not available" it suggests that no default music line has been initialized.
See Also:: holdOff(), IS_HELD

hold

void hold(java.lang.Integer musicSource)
          throws BridgeException

Place a participant on hold with the given music source.

Parameters:: musicSource - The music source to play to this participant while on hold.
Throws:: BridgeException - if there is a problem with the operation. If the message body of the exception reads "line not available" it suggests that the music line defined by musicSource has not been initialized.
See Also:: Conference.MUSIC_SRC_M1, Conference.MUSIC_SRC_M2, Conference.MUSIC_SRC_M3, Conference.MUSIC_SRC_M4, holdOff(), IS_HELD

holdOff

void holdOff()
             throws BridgeException

Take a participant off hold.

Throws:: BridgeException - if there is a problem with the operation
See Also:: hold(), hold(Integer), IS_HELD

mute

void mute()
          throws BridgeException

Mute a Participant.

Throws:: BridgeException - if there is a problem with the operation

unMute

void unMute()
            throws BridgeException

Un-mute a Participant.

Throws:: BridgeException - if there is a problem with the operation

selfMute

void selfMute()
              throws BridgeException

Applies a self-mute to the Participant.

Throws:: BridgeException - If there is a problem with the operation
Since:: 1.1

selfUnMute

void selfUnMute()
                throws BridgeException

Removes a self-mute from the Participant.

Throws:: BridgeException - If there is a problem with the operation.
Since:: 1.1

operatorMute

void operatorMute()
                  throws BridgeException

Applies operator mute to the Participant.

Throws:: BridgeException - If there is a problem with the operation.
Since:: 1.1

operatorUnMute

void operatorUnMute()
                    throws BridgeException

Removes operator mute from the Participant.

Throws:: BridgeException - If there is a problem with the operation.
Since:: 1.1

playAndCollect

void playAndCollect(short promptNo,
                    short promptSet)
                    throws BridgeException

Play a prompt to a participant asking them to enter a dtmf. Collect the dtmf and send it back to the application. Any number of digits up to a maximum (currently 20) can be collected. The returning event will contain a status of timeout only if no digits were entered.

Parameters:

promptNo - The prompt to play

promptSet - The language prompt set for the prompt

Throws:

BridgeException - If there is a problem with the operation, or if the bridge is S6100.

Since:

S6200 5.0 BCAPI-1.6

S6100 NOT SUPPORTED

playAndCollect

void playAndCollect(short promptNo,
                    short promptSet,
                    byte minDigits,
                    byte maxDigits)
                    throws BridgeException

Play a prompt to a participant asking them to enter a dtmf. Collect the dtmf and send it back to the application. Minimum and maximum number of digits is required.

Throws:: BridgeException - If there is a problem with the operation.

playAndCollect

void playAndCollect(short promptNo,
                    short promptSet,
                    java.lang.String dtmfToMatch)
                    throws BridgeException

Play a prompt to a participant asking them to enter a dtmf. Collect the dtmf and send it back to the application. The collected dtmf is matched against what is passed in.

Throws:: BridgeException - If there is a problem with the operation.

makeModerator

void makeModerator(boolean toModerator)
                   throws BridgeException

Set the Participant to and from moderator status.

Parameters:: toModerator - If true, set the participant to moderator. If false, set the participant to normal.
Throws:: BridgeException - If there is a problem with the operation.

toggle

void toggle()
            throws BridgeException

Toggle a Participant to or from a sub-conference.

Throws:: BridgeException - if there is a problem with the operation

intercept

void intercept(java.lang.String participantID)
               throws BridgeException

Intercept another Participant.

Parameters:: participantID - ID of participant to intercept
Throws:: BridgeException - if there is a problem with the operation

interceptOff

void interceptOff()
                  throws BridgeException

Return this participant and the participant with which it it is intercepted to the conference.

Throws:: BridgeException - if there is a problem with the operation

moveQaPosition

void moveQaPosition(int amount)
                    throws BridgeException

Move the Q&A position of this participant in the Q&A queue.

Parameters:: amount - The desired number of levels to move this participant in the Q&A queue. A positive value moves the participant down and a negative value moves the participant up the Q&A queue.
Throws:: BridgeException - Thrown if the bridge is not connected, Thrown if there is a IO connectivity error. Thrown if there is an internal error while sending the request for change to the bridge. Also thrown if called on a participant who has not joined the Q&A session via DTMF.
See Also:: IS_IN_QA

moveQaPosition

void moveQaPosition(int amount,
                    boolean includeHelp,
                    boolean includeMods,
                    boolean includeQs)
                    throws BridgeException

Move the Q&A position of this participant in the Q&A queue.Depending on the provided filters, the participant will be moved relative to the moderators and help requests.

Parameters:: amount - The desired amount of levels to move this participant in the Q&A queue. This can be a positive or negative value to move the participant up or down the Q&A queue respectively.; includeHelp - If true, include help requests in the list when moving.; includeMods - If true, include moderators in the list when moving.; includeQs - If true. include participants with questions in the list when moving.
Throws:: BridgeException - Thrown if there is an internal error while sending the request for change to the bridge. Also thrown if called on a participant who has not joined the Q&A session via DTMF.
See Also:: IS_IN_QA

removeFromQa

void removeFromQa()
                  throws BridgeException

Remove this participant from the Q&A queue (without accessing the line).

Throws:: BridgeException - Thrown if there is an internal error while sending the request for change to the bridge. Also thrown if called on a participant who has not joined the Q&A session via DTMF.
See Also:: IS_IN_QA

askQuestionOnQAChan

void askQuestionOnQAChan()
                         throws BridgeException

Throws:: BridgeException - Thrown if there is an internal error while sending the request for change to the bridge. Also thrown if called on a participant who has not joined the Q&A session via DTMF. Also thrown if connected to S6100 as this feature is Not Implemented on S6100.
See Also:: IS_IN_QA

resumeQAChan

void resumeQAChan()
                  throws BridgeException

Put the participant back into QA after they asked their question.

Throws:: BridgeException - Thrown if there is an internal error while sending the request for change to the bridge. Also thrown if called on a participant who has not joined the Q&A session via DTMF. Also thrown if connected to S6100 as this feature is Not Implemented on S6100.
Since:: S6200 5.0 BCAPI-1.6
See Also:: IS_IN_QA

setQaPriority

void setQaPriority(java.lang.String priority)
                   throws BridgeException

Set the Q&A priority for this participant.

Possible values for the priority designated to the participant during QA (Question and Answer) sessions include top, normal and excluded. If excluded, the participant is not allowed to participate in the QA session. If top, the participant is added above other normal participants.

This method is only available on the Avaya 700/780 Bridge.

Parameters:: priority - The desired priority for this participant during a Q&A session.
Throws:: BridgeException - Thrown if there is an internal error while sending the request for change to the bridge. This exception is also thrown if the priority is invalid.
See Also:: QAPRIORITY_NORMAL, QAPRIORITY_TOP, QAPRIORITY_EXCLUDED

getPollingVote

int getPollingVote()
                   throws BridgeException

Returns a polling vote for this participant during a Polling session. Values range between 0-9, where 0 suggests that the participant abstained from voting.

This method is only available on the Avaya 700/780 Bridge.

Returns:: The polling vote of this participant.
Throws:: BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

placeInConference

void placeInConference(java.lang.String conferenceId)
                       throws BridgeException

Place this participant into a conference.

This method will transfer the participant even if it's in an annunciator or operator conference.

This method is only available on the Avaya 700/780 Bridge

Parameters:: conferenceId - The id of the conference this participant will be placed into.
Throws:: BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

transferToConference

void transferToConference(java.lang.String conferenceId)
                          throws BridgeException

Transfer this participant into the conference identified by conferenceId.

The transfer will fail silently if the participant is in an annunciator or operator conference.

Parameters:: conferenceId - The id of the conference to transfer this participant into.
Throws:: BridgeException - If the provided conferenceId is an invalid conference ID, or there is an error while sending the request to the bridge.

requestOperator

void requestOperator()
                     throws BridgeException

Request individual operator help for the specific participant.

This method is only available on the Avaya 700/780 Bridge.

Throws:: BridgeException - If the physical bridge returns an error indicating a failure on the request.

requestOperator

void requestOperator(boolean obeyRestrictions)
                     throws BridgeException

Request an operator's assistance on this participant only if such requests are allowed.

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 - If the physical bridge returns an error, indicating a failure on the request.
Since:: 1.4
See Also:: Conference.IS_HELP_REQ_ALLOWED

requestConferenceWideOperator

void requestConferenceWideOperator()
                                   throws BridgeException

Request conference-wide operator help for the individual participant.

This method is only available on the Avaya 700/780 Bridge.

Note, for a CALL_FLOW_DEFAULT conference, which participant requests conference-wide help is irrelevant, and any conference-wide help cancellations will remove the conference from the help queue. For a CALL_FLOW_FLEX conference, each participant can cancel their specific help request, and when all conference-wide help requests have been canceled, the conference is removed from the help queue.

Throws:: BridgeException - If the physical bridge returns an error, indicating a failure on the request.
See Also:: Conference.CALL_FLOW

requestConferenceWideOperator

void requestConferenceWideOperator(boolean obeyRestrictions)
                                   throws BridgeException

Request conference-wide operator help for the individual participant if such requests are allowed.

This method is only available 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 the current conference, or if the physical bridge returns an error indicating a failure on the request.
Since:: 1.4
See Also:: Conference.CALL_FLOW

cancelOperatorRequest

void cancelOperatorRequest()
                           throws BridgeException

Cancel the previous individual operator help request for this participant.

This method is only available on the Avaya 700/780 Bridge.

Throws:: BridgeException - If the physical bridge returns an error, indicating a failure on the request.

cancelConferenceWideOperatorRequest

void cancelConferenceWideOperatorRequest()
                                         throws BridgeException

Cancel the previous conference-wide operator help request for this participant.

This method is only available on the Avaya 700/780 Bridge.

Throws:: BridgeException - If the physical bridge returns an error, indicating a failure on the request.
See Also:: Conference.CALL_FLOW

getDisconnectReason

java.lang.Integer getDisconnectReason()

Retrieve the reason the participant was disconnected.

This method is only available on the Avaya 700/780 Bridge.

Returns:: The disconnect reason for this participant.

sendDTMF

void sendDTMF(java.lang.String digits,
              boolean append)
              throws BridgeException

Dials input DTMF string on the (presumably) already connected line. The characters "0123456789*#," will be dialed, others will be silently ignored by the bridge. If the append parameter is true, the dialed DTMF will be appended to the PHONE_NUM parameter after a space, if it's false, the dialed DTMF will replace the PHONE_NUM value. The bridge will treat a comma (",") as a short pause, and will add it to the PHONE_NUM with a leading and trailing space. For example, the arguments ("abc123,456def", false) will result in a PHONE_NUM of "123 , 456".

Parameters:: digits - - DTMF tones to dial.; append - - true to add a space and "digits" after line's PHONE_NUM, false to replace it
Throws:: BridgeException - if the line is currently in an annunciator conference or the enter queue, if the line is not connected, or there is an error sending the command to the bridge.
Since:: 1.1
See Also:: PHONE_NUM, Conference.dial(java.lang.String, java.lang.String, java.lang.String, boolean)

playAnnunciator

void playAnnunciator(int msgNum)
                     throws BridgeException

Plays an annunciator message to this line.

Parameters:: msgNum - The number of the message to play.
Throws:: BridgeException - if the message specified is unknown, the line is not connected, or if there is an error sending the command to the bridge.
Since:: 1.2

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 Participant

NAME

PHONE_NUM

PINCODE

COMPANY

AUX1

AUX2

AUX3

AUXILIARY_CODE

WEB_ID

FROM_URI

TO_URI

PAC_STATUS

PAC_DIGITS

COMMENT

INTERCEPTED_WITH

QA_NEXT

CONFERENCE_ID

IS_INCOMING

IS_BACKPATH

IS_VLL

IS_HELP_REQ

IS_IN_QA

IS_IN_POLL

IS_MODERATOR

IS_OPERATOR

IS_MUTED

IS_SELF_MUTED

IS_OPER_MUTED

IS_TALKING

IS_RECORDING_LINE

IS_HELD

CALL_START

CONF_START

IS_IN_SUBCONF

CHAN_TYPE

CALLER_ID

DNIS_DIGITS

PARTICIPANT_ID

CALL_TYPE

CALL_TYPE_DIAL_IN

CALL_TYPE_DIAL_OUT_BY_API

CALL_TYPE_DIAL_OUT_BY_DTMF

CALL_TYPE_LINK_LINE

CALL_TYPE_UBLAST

CALL_TYPE_OTHER

PROMPT_SET

QA_PRIORITY

QAPRIORITY_NORMAL

QAPRIORITY_TOP

QAPRIORITY_EXCLUDED

STATE

STATE_FREE

STATE_FULL_DUPLEX

STATE_ON_HOLD

STATE_BEING_DIALED

STATE_IN_ANNUNCIATION

STATE_WAITING_ON_INTERCEPT

STATE_INTERCEPTOR

STATE_INTERCEPTEE

DR_NULL

DR_NETWORK_INDICATED

DR_OPERATOR_HANGUP

DR_INVALID_SEC_CODE

DR_SEC_CODE_TIMEOUT

DR_CONF_SECURED

DR_INVALID_TIME

DR_MAX_LINES_IN_CONF

DR_CONF_TIME_EXPIRED

DR_HOOKFLASH_TRANSFER

DR_LINE_TIMEOUT

DR_CLPG_TIMEOUT

DR_SYS_OTHER

DR_FAULT

DR_ALARM

DR_DSP_FAILURE

DR_ERROR

DR_DNIS_HANGUP

DR_ODO_HANGUP

DR_MOD_HANGUP

com.spectel.bcapi
Interface Participant