Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control.operations
Enum Verb

java.lang.Object
  extended by java.lang.Enum<Verb>
      extended by com.avaya.conferencing.api.acp.control.operations.Verb
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Verb>

public enum Verb
extends java.lang.Enum<Verb>

High-level description of operations.

Since:
5.1.0.0.29

Enum Constant Summary
ABORT_SIGNAL_TO_NOISE_RATIO_MEASUREMENT
          Aborts the measurement of the signal-to-noise ratio of an EndPoint that was started by a MEASURE_SIGNAL_TO_NOISE_RATIO operation.
ACCESS
          Starts/stops direct access to the specified EndPoint with the Operator.
ACCESS_NEXT_ENTRY
          Gets and actions a help request.
AUTOMATIC_GAIN_CONTROL_MODE
          Toggles automatic gain control mode.
CALL_LIST_GET
          Gets the contents of a dial list from the Conferencing Provider.
CALL_LIST_SET
          Creates a new (or modifies an existing) Dial List on the Conferencing Provider.
CALL_LISTS_GET
          Gets a list of the dial lists held on the conferencing provider.
CANCEL_HELP
          Closes an operator help request.
CONFERENCING_PROVIDER_LINK
          Toggles the States.CONFERENCING_PROVIDER_LINK state of an EndPoint.
CREATE
          Creates a new adhoc conference.
DELETE_URI
          Removes a specific recording from the conferencing provider.
DISCONNECT
          Hang-up a conference or an EndPoint.
DTMF_PASSTHROUGH
          Modifies the States.PASSTHROUGH_DTMF state of a Conference.
DTMF_REGENERATION
          Modifies the States.REGENERATE_DTMF state of an EndPoint or a Conference.
FAULT
          Toggles the States.FAULTED state of an EndPoint.
FORCE_CONNECTION_UPDATE
          Forces the Connection to reload the ConferencingProvider's configuration.
GET_CURRENT_TIME
          Returns the current time as measured by the ConferencingProvider.
GET_RECORDING_URIS
          Returns a list of the current recordings stored on the conferencing provider.
HOLD
          Places an EndPoint on hold.
LECTURE_MODE
          Lecture mode ensures that all callees are gagged.
MAKE_CALL
          Dials out to a new EndPoint.
MAKE_CALLS_FROM_LIST
          Blast dials a number of conferees.
MEASURE_DTMF_SIGNAL_TO_NOISE_RATIO
          Modifies whether the signal-to-noise ratio of the DTMFEvents produced by an EndPoint will include information about the signal-to-noise ratio of the DTMF tones.
MEASURE_SIGNAL_TO_NOISE_RATIO
          Measure the signal-to-noise ratio of an EndPoint.
MEDIA_SOURCE_CONNECT
          Connects a media source to it's destination.
MODERATOR
          Makes an EndPoint a moderator.
MODERATOR_DISCONNECT_MODE
          Controls whether the conference is disconnected when the last moderator disconnects.
MODIFY_DETAILS
          Modifies a ConferencingObject's properties.
MUTE
          Mutes EndPoints.
OBSERVE
          Starts direct observation of the specified line with the Operator.
OPEN
          Opens a new conference.
OPERATOR_LOGIN
          Logs in the Operator.
OPERATOR_LOGOUT
          Stops playing back a conference.
PLACE_IN_CONFERENCE
          Puts an EndPoint into a conference.
PLACE_IN_MAIN_CONFERENCE
          Returns an EndPoint in a subconference to the main Conference.
PLACE_IN_SUBCONFERENCE
          Puts an EndPoint into a subconference.
PLAY_AND_COLLECT
          Plays a message and collects the resulting DTMF code.
PLAY_CONFERENCE_ROSTER
          Plays the conference roster.
PLAY_MESSAGE
          Plays an annunciator message.
PLAY_PARTICIPANT_NAME
          Plays the callee's information.
PLAYBACK_MODE_PAUSE
          Pauses playback of a conference.
PLAYBACK_MODE_RESUME
          Resumes a paused playback.
PLAYBACK_MODE_START
          Plays back a previous recording along the current EndPoint.
PLAYBACK_MODE_STOP
          Stops playing back a conference.
POLLING_ASSIST
          Access EndPoint that is requesting help.
POLLING_MODE_START
          Starts polling on a conference.
POLLING_MODE_STOP
          Stops polling mode for a conference.
POLLING_QUERY
          Get the current (i.e.
POLLING_QUERY_DETAIL
          Get the current (i.e.
POLLING_RESET
          Clears the polling data for EndPoints.
PROTECT_DETAILS
          Locks a conference to prevent additional EndPoints entering.
QA_CANCEL_QUESTION
          Cancels a EndPoint's question during a question and answer session.
QA_FINISHED_QUESTION
          Releases a Conference callee the floor during a question and answer session.
QA_HAVE_QUESTION
          Modifies the States.QA_HAS_QUESTION state of an EndPoint.
QA_MODE_START
          Opens a conference Question & Answer session where conference callees can join a queue of callees with questions to be answered.
QA_MODE_STOP
          Closes a conference Question & Answer session.
QA_MOVE_QUESTION
          Moves a EndPoint's question within the question and answer queue during a question and answer session.
QA_NEXT_QUESTION
          Gives a Conference callee the floor during a question and answer session.
QA_POSTPONE_QUESTION
          Releases a Conference callee the floor during a question and answer session.
QA_PREVIOUS_QUESTION
          Releases a Conference callee the floor during a question and answer session.
RECORDING_MODE_PAUSE
          Pauses recording of a conference.
RECORDING_MODE_RESUME
          Resumes a paused recording.
RECORDING_MODE_START
          Starts a recording (into a specified file for Digital recordings) of an EndPoint.
RECORDING_MODE_STOP
          Stops an ongoing recording.
REQUEST_HELP
          Opens an operator help request.
SECURED_MODE
          A Secure conference can only be modified by moderators in the conference.
SECURITY_FEATURES
          Turn on/off conference security.
SEND_DTMF
          Sends dtmf to an end-point.
SILENCE
          Silences EndPoint.
 
Method Summary
static Verb valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Verb[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FORCE_CONNECTION_UPDATE

public static final Verb FORCE_CONNECTION_UPDATE
Forces the Connection to reload the ConferencingProvider's configuration.

Since:
5.1.0.0.46

MODIFY_DETAILS

public static final Verb MODIFY_DETAILS
Modifies a ConferencingObject's properties.

Since:
5.1.0.0.29

MAKE_CALL

public static final Verb MAKE_CALL
Dials out to a new EndPoint.

Since:
5.1.0.0.29

MAKE_CALLS_FROM_LIST

public static final Verb MAKE_CALLS_FROM_LIST
Blast dials a number of conferees.

Since:
5.1.0.0.40

MEDIA_SOURCE_CONNECT

public static final Verb MEDIA_SOURCE_CONNECT
Connects a media source to it's destination.

Since:
5.1.0.0.40

SEND_DTMF

public static final Verb SEND_DTMF
Sends dtmf to an end-point.

Since:
5.1.0.0.41

ACCESS

public static final Verb ACCESS
Starts/stops direct access to the specified EndPoint with the Operator.

Since:
5.1.0.0.29

OBSERVE

public static final Verb OBSERVE
Starts direct observation of the specified line with the Operator.

Since:
5.1.0.0.29

DISCONNECT

public static final Verb DISCONNECT
Hang-up a conference or an EndPoint.

Since:
5.1.0.0.29

MODERATOR_DISCONNECT_MODE

public static final Verb MODERATOR_DISCONNECT_MODE
Controls whether the conference is disconnected when the last moderator disconnects.

Since:
5.1.0.0.37

AUTOMATIC_GAIN_CONTROL_MODE

public static final Verb AUTOMATIC_GAIN_CONTROL_MODE
Toggles automatic gain control mode.

Since:
5.1.0.0.37

SECURED_MODE

public static final Verb SECURED_MODE
A Secure conference can only be modified by moderators in the conference.

Since:
5.1.0.0.29

SECURITY_FEATURES

public static final Verb SECURITY_FEATURES
Turn on/off conference security.

Since:
5.1.0.0.29

PROTECT_DETAILS

public static final Verb PROTECT_DETAILS
Locks a conference to prevent additional EndPoints entering.

Since:
5.1.0.0.29

LECTURE_MODE

public static final Verb LECTURE_MODE
Lecture mode ensures that all callees are gagged.

Since:
5.1.0.0.29

SILENCE

public static final Verb SILENCE
Silences EndPoint. Normally, mute is something that an EndPoint requests of itself, while silence is something that is done to an EndPoint. For example, a moderator may silence an EndPoint because it is generating a lot of noise on a conference call. If an EndPoint is silenced and muted, removal of the silence will not affect the mute.

Since:
5.1.0.0.29

MUTE

public static final Verb MUTE
Mutes EndPoints.

Since:
5.1.0.0.29

HOLD

public static final Verb HOLD
Places an EndPoint on hold.

Since:
5.1.0.0.29

MODERATOR

public static final Verb MODERATOR
Makes an EndPoint a moderator.

Since:
5.1.0.0.29

FAULT

public static final Verb FAULT
Toggles the States.FAULTED state of an EndPoint.

Since:
5.1.0.0.40

CONFERENCING_PROVIDER_LINK

public static final Verb CONFERENCING_PROVIDER_LINK
Toggles the States.CONFERENCING_PROVIDER_LINK state of an EndPoint.

Since:
5.1.0.0.40

OPEN

public static final Verb OPEN
Opens a new conference.

Since:
5.1.0.0.29

CREATE

public static final Verb CREATE
Creates a new adhoc conference.

Since:
5.1.0.0.34

REQUEST_HELP

public static final Verb REQUEST_HELP
Opens an operator help request.

Since:
5.1.0.0.29

CANCEL_HELP

public static final Verb CANCEL_HELP
Closes an operator help request.

Since:
5.1.0.0.29

ACCESS_NEXT_ENTRY

public static final Verb ACCESS_NEXT_ENTRY
Gets and actions a help request.

Since:
5.1.0.0.29

PLACE_IN_CONFERENCE

public static final Verb PLACE_IN_CONFERENCE
Puts an EndPoint into a conference.

Since:
5.1.0.0.29

PLACE_IN_SUBCONFERENCE

public static final Verb PLACE_IN_SUBCONFERENCE
Puts an EndPoint into a subconference.

Since:
5.1.0.0.29

PLACE_IN_MAIN_CONFERENCE

public static final Verb PLACE_IN_MAIN_CONFERENCE
Returns an EndPoint in a subconference to the main Conference.

Since:
5.1.0.0.29

RECORDING_MODE_START

public static final Verb RECORDING_MODE_START
Starts a recording (into a specified file for Digital recordings) of an EndPoint.

Since:
5.1.0.0.29

RECORDING_MODE_PAUSE

public static final Verb RECORDING_MODE_PAUSE
Pauses recording of a conference.

Since:
5.1.0.0.29

RECORDING_MODE_RESUME

public static final Verb RECORDING_MODE_RESUME
Resumes a paused recording.

Since:
5.1.0.0.29

RECORDING_MODE_STOP

public static final Verb RECORDING_MODE_STOP
Stops an ongoing recording.

Since:
5.1.0.0.29

PLAYBACK_MODE_START

public static final Verb PLAYBACK_MODE_START
Plays back a previous recording along the current EndPoint.

Since:
5.1.0.0.29

PLAYBACK_MODE_PAUSE

public static final Verb PLAYBACK_MODE_PAUSE
Pauses playback of a conference.

Since:
5.1.0.0.29

PLAYBACK_MODE_RESUME

public static final Verb PLAYBACK_MODE_RESUME
Resumes a paused playback.

Since:
5.1.0.0.29

PLAYBACK_MODE_STOP

public static final Verb PLAYBACK_MODE_STOP
Stops playing back a conference.

Since:
5.1.0.0.29

POLLING_MODE_START

public static final Verb POLLING_MODE_START
Starts polling on a conference. Note that an operator audio path is required.

Since:
5.1.0.0.29

POLLING_MODE_STOP

public static final Verb POLLING_MODE_STOP
Stops polling mode for a conference.

Since:
5.1.0.0.29

POLLING_RESET

public static final Verb POLLING_RESET
Clears the polling data for EndPoints.

Since:
5.1.0.0.29

POLLING_ASSIST

public static final Verb POLLING_ASSIST
Access EndPoint that is requesting help.

Since:
5.1.0.0.29

POLLING_QUERY

public static final Verb POLLING_QUERY
Get the current (i.e. as at request time) polling values.

Since:
5.1.0.0.34

POLLING_QUERY_DETAIL

public static final Verb POLLING_QUERY_DETAIL
Get the current (i.e. as at request time) polling values for each EndPoint.

Since:
5.1.0.0.40

OPERATOR_LOGIN

public static final Verb OPERATOR_LOGIN
Logs in the Operator.

Since:
5.1.0.0.29

OPERATOR_LOGOUT

public static final Verb OPERATOR_LOGOUT
Stops playing back a conference.

Since:
5.1.0.0.29

PLAY_PARTICIPANT_NAME

public static final Verb PLAY_PARTICIPANT_NAME
Plays the callee's information.

Since:
5.1.0.0.29

PLAY_CONFERENCE_ROSTER

public static final Verb PLAY_CONFERENCE_ROSTER
Plays the conference roster.

Since:
5.1.0.0.29

PLAY_MESSAGE

public static final Verb PLAY_MESSAGE
Plays an annunciator message.

Since:
5.1.0.0.29

PLAY_AND_COLLECT

public static final Verb PLAY_AND_COLLECT
Plays a message and collects the resulting DTMF code.

Since:
5.1.0.0.29

QA_MODE_START

public static final Verb QA_MODE_START
Opens a conference Question & Answer session where conference callees can join a queue of callees with questions to be answered.

Since:
5.1.0.0.29

QA_MOVE_QUESTION

public static final Verb QA_MOVE_QUESTION
Moves a EndPoint's question within the question and answer queue during a question and answer session.

Since:
5.1.0.0.41

QA_NEXT_QUESTION

public static final Verb QA_NEXT_QUESTION
Gives a Conference callee the floor during a question and answer session.

Since:
5.1.0.0.29

QA_POSTPONE_QUESTION

public static final Verb QA_POSTPONE_QUESTION
Releases a Conference callee the floor during a question and answer session.

Since:
5.1.0.0.29

QA_PREVIOUS_QUESTION

public static final Verb QA_PREVIOUS_QUESTION
Releases a Conference callee the floor during a question and answer session.

Since:
5.1.0.0.29

QA_FINISHED_QUESTION

public static final Verb QA_FINISHED_QUESTION
Releases a Conference callee the floor during a question and answer session.

Since:
5.1.0.0.29

QA_CANCEL_QUESTION

public static final Verb QA_CANCEL_QUESTION
Cancels a EndPoint's question during a question and answer session.

Since:
5.1.0.0.41

QA_MODE_STOP

public static final Verb QA_MODE_STOP
Closes a conference Question & Answer session.

Since:
5.1.0.0.29

GET_CURRENT_TIME

public static final Verb GET_CURRENT_TIME
Returns the current time as measured by the ConferencingProvider.

Since:
5.1.0.0.29

GET_RECORDING_URIS

public static final Verb GET_RECORDING_URIS
Returns a list of the current recordings stored on the conferencing provider.

Since:
5.1.0.0.31

DELETE_URI

public static final Verb DELETE_URI
Removes a specific recording from the conferencing provider.

Since:
5.1.0.0.31

CALL_LISTS_GET

public static final Verb CALL_LISTS_GET
Gets a list of the dial lists held on the conferencing provider.

Since:
5.1.0.0.40

CALL_LIST_GET

public static final Verb CALL_LIST_GET
Gets the contents of a dial list from the Conferencing Provider.

Since:
5.1.0.0.40

CALL_LIST_SET

public static final Verb CALL_LIST_SET
Creates a new (or modifies an existing) Dial List on the Conferencing Provider.

Since:
5.1.0.0.40

MEASURE_SIGNAL_TO_NOISE_RATIO

public static final Verb MEASURE_SIGNAL_TO_NOISE_RATIO
Measure the signal-to-noise ratio of an EndPoint.

Since:
5.1.1.0.1

ABORT_SIGNAL_TO_NOISE_RATIO_MEASUREMENT

public static final Verb ABORT_SIGNAL_TO_NOISE_RATIO_MEASUREMENT
Aborts the measurement of the signal-to-noise ratio of an EndPoint that was started by a MEASURE_SIGNAL_TO_NOISE_RATIO operation.

Since:
5.1.1.0.1

MEASURE_DTMF_SIGNAL_TO_NOISE_RATIO

public static final Verb MEASURE_DTMF_SIGNAL_TO_NOISE_RATIO
Modifies whether the signal-to-noise ratio of the DTMFEvents produced by an EndPoint will include information about the signal-to-noise ratio of the DTMF tones.

Since:
5.1.1.0.1

DTMF_PASSTHROUGH

public static final Verb DTMF_PASSTHROUGH
Modifies the States.PASSTHROUGH_DTMF state of a Conference.

Since:
5.1.1.0.1

DTMF_REGENERATION

public static final Verb DTMF_REGENERATION
Modifies the States.REGENERATE_DTMF state of an EndPoint or a Conference.

Since:
5.1.1.0.1

QA_HAVE_QUESTION

public static final Verb QA_HAVE_QUESTION
Modifies the States.QA_HAS_QUESTION state of an EndPoint.

Since:
5.1.1.0.6
Method Detail

values

public static Verb[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (Verb c : Verb.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static Verb valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.