Avaya Conferencing Provider API

Package com.avaya.conferencing.api.acp.control.operations

Operations supported by the Avaya Conferencing Provider Interface.

See:
          Description

Interface Summary
BulkOperation<RESULT> Performs an operation against a collection of conferencing objects.
ConferenceProducingOperation<IMPL extends Operation<Conference,IMPL>> An operation that results in a Conference instance, for example creating a conference.
EndPointProducingOperation<IMPL extends Operation<EndPoint,IMPL>> An operation which returns an EndPoint if succesful.
Operation<RESULT,IMPL extends Operation<RESULT,IMPL>> Describes operations exposed by a conferencing object.
 

Class Summary
AbortSignalToNoiseRatioMeasurement Measures the signal to noise ratio of an EndPoint.
AbstractOperationImpl<RESULT,IMPL extends Operation<RESULT,IMPL>> Abstract base class for all Operation implementations.
Access Intercepting an EndPoint will temporarily remove the EndPoint from a conference and into a direct one-to-one conversation with an Operator.
AccessNextEntry Gets and actions the help Request.
AutomaticGainControlMode Controls whether the conference is disconnected when the last moderator disconnects.
CallListGet Gets the contents of the call list specified from the ConferencingProvider.
CallListSet Sets the contents of a Call list on the ConferencingProvider.
CallListsGet Gets a list of the call lists that are stored on the ConferencingProvider.
CancelHelp Cancels a help request.
CompletedFuture<V> An implementation of the Future interface that is already completed.
ConferencingProviderLink Toggles the States.CONFERENCING_PROVIDER_LINK state of an EndPoint.
Create Opens a new Ad-hoc Conference.
DeleteURI Deletes a URI (in effect a file) from the ConferencingProvider.
Disconnect Hang-up a Conference or an EndPoint.
DTMFPassthrough Modifies the States.PASSTHROUGH_DTMF state of a Conference.
DTMFRegeneration /** Modifies the States.REGENERATE_DTMF state of an EndPoint or a Conference.
Fault Toggles the States.FAULTED state of an EndPoint
ForceConnectionUpdate Will refresh the Connection to reload the ConferencingProvider's configuration.
GetCurrentTime Gets the current time according to the ConferencingProvider.
GetRecordingURIs Gets a list of the recordings (previously made on the ConferencingProvider).
Hold Places an EndPoint on hold.
LectureMode Stops lecture mode.
MakeCall Dials out to a new EndPoint.
MakeCallsFromList Calls (dials in) all entries from the specified call list(s).
MeasureDTMFSignalToNoiseRatio /** Modifies the States.REGENERATE_DTMF state of an EndPoint or a Conference.
MeasureSignalToNoiseRatio Measures the signal to noise ratio of an EndPoint.
MediaSourceConnect Connects a MediaSource.
Moderator Makes EndPoints moderators.
ModeratorDisconnectMode Controls whether the conference is disconnected when the last moderator disconnects.
ModifyDetails Modifies the properties of a ConferencingObject.
Mute Mutes EndPoints.
Observe Observing an EndPoint will allow the Operator's EndPoint to receive the same media as the EndPoint is receiving an Operator.
Open Opens a conference.
OperationFactory Factory for creating Operation instances.
OperatorLogin Login an Operator.
OperatorLogout Logout an Operator.
PlaceInConference Places an EndPoint into a pre-existing Conference.
PlaceInMainConference This command operates on an EndPoint in a Subconference, and returns it to the Conference.
PlaceInSubconference Places an EndPoint putting it into a Subconference.
PlayAndCollect Plays a prompt to an EndPoint and waits for a response (DTMF string) from that EndPoint.
PlaybackModePause Pauses playback of a Conference.
PlaybackModeResume Continues playback of a paused Conference.
PlaybackModeStart Starts playing back a previously made recording of the conference.
PlaybackModeStop Stops an ongoing (or paused) playback.
PlayConferenceRoster Plays a conference roster.
PlayMessage Operation to allow an Operator to play a Message to either a Conference or an EndPoint.
PlayParticipantName Operation to play callee information to an EndPoint or a Conference.
PollingAssist This command operates on a Conference.
PollingModeStart This command operates on a Conference.
PollingModeStop This command operates on a Conference.
PollingQuery This operation will get the current, or interim, polling values.
PollingQueryDetail This operation will get the current, or interim, polling detail values.
PollingReset This command operates on a Conference.
ProtectDetails Locks a conference.
QACancelQuestion Cancel an EndPoint's question on the Q&A queue.
QAFinishedQuestion Marks an EndPoint on the Q&A queue as having been answered (essentially, it removes the EndPoint from the Q&A queue).
QAHaveQuestion Modifies the States.QA_HAS_QUESTION state of an EndPoint
QAModeStart Opens a Conference Question & Answer session where Conference callees can join a queue of callees with questions to be answered.
QAModeStop Closes a Conference Question & Answer session.
QAMoveQuestion Moves an EndPoint's question in the Q&A queue.
QANextQuestion Gets the EndPoint for the next Q&A question in the queue.
QAPostponeQuestion Postpones an EndPoint's question on the Q&A queue.
QAPreviousQuestion Gets the EndPoint for the last Q&A question that was terminated (i.e.
RecordingModePause Pauses recording of a Conference.
RecordingModeResume Continues recording of a paused Conference.
RecordingModeStart Starts recording a Conference.
RecordingModeStop Stops an ongoing (or paused) recording of a Conference.
RequestHelp Places a ConferencingObject (i.e.
SecuredMode Locks a conference.
SecurityFeatures Enables security in the conference.
SendDTMF Sends DTMF to the EndPoint.
Silence Silences EndPoints.
StateChangingOperation<T extends StateChangingOperation<T>> A state changing operation.
 

Enum Summary
Operation.Impact Describes the impact of an operation.
StateChange Describes the different types of state change that can be effected.
Verb High-level description of operations.
 

Annotation Types Summary
Required Annotation for action setters that must be called before the action is valid.
ValuesDerivedFrom Annotation for Operation 'setter' methods, to allow the developer to tell any users what Verb should be used to derive valid entries for that 'setter'.
 

Package com.avaya.conferencing.api.acp.control.operations Description

Operations supported by the Avaya Conferencing Provider Interface.

Since:
5.1.0.0.29

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.