|
Avaya Conferencing Provider API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
ConferencingObject extension points are derived.ConnectionSpecificResource extension points are derived.List of numbers to be dialed into the Conference
EndPoint to the list that will be pre-populated into the Conference
ConferencingProvider.ConferencingProvider.Future interface that is already completed.Connection.getEventBacklogLimit() * 4 events which have not been processed, or because a call to
SourceSequentialEventListener.eventBacklogWarning(Object, int) returned true.
Math.min(getEventBacklogLimit() / 32, 1) events
queued for a specific source instance once the unprocessed event queue is longer than getEventBacklogLimit().
ExecutorService instances.Conference
null
if not currently in a Conference.
null if the reference is no longer valid.
null if the supplied authentication is not associated with an EndPoint (i.e.
null if the EndPoint is active or the reason why the EndPoint was disconnected.
null if no EndPoint
has been connected.
EndPoint instances that will be pre-populated into the Conference.
null if the Conference is not in a help queue.
null if the EndPoint is
not in a help queue.
null if this conference is hosted on a single ConferencingProvider or the
inter-ConferencingProvider conference id (typically a database id for the conference booking)
associated with this Conference object.
MeasureSignalToNoiseRatio.getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.
PlayAndCollect.getMessage()
Strings) of numbers to dial into the Conference.
null for a main Conference, or the parent Conference for
subconferences.
null if
this conference does not belong to any ParticipantCodeGroup.
null for a conference that is not recording, or one of the standard.
- getReferencedClass() -
Method in class com.avaya.conferencing.api.acp.control.Reference
- Returns the type of ConferencingObject that this reference refers to.
- getReferencedObject() -
Method in class com.avaya.conferencing.api.acp.control.Reference
- Returns the object referenced used by this reference.
- getResourceClass() -
Method in interface com.avaya.conferencing.api.acp.control.ConnectionSpecificResource
- Returns the class of this ConnectionSpecificResource.
- getRoom() -
Method in class com.avaya.conferencing.api.acp.control.Conference
- In subconferences, this returns the Room to which this subconference belongs for the parent
Conference object, for all other Conference objects this will return
null.
- getRoom() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaceInSubconference
- Returns the room of this PlaceInSubconference object.
- getRooms() -
Method in class com.avaya.conferencing.api.acp.control.Connection
- Gets the available Room instances that this Connection provides.
- getRulePriority() -
Method in class com.avaya.conferencing.api.acp.control.CallFlowMappingRule
- In the case where multiple rules match an destinationUri, the rule with the lowest priority will always win.
- getScheduledEndDateTime() -
Method in class com.avaya.conferencing.api.acp.control.Conference
- Returns the scheduled finish time for the Conference
- getScheduledStartDateTime() -
Method in class com.avaya.conferencing.api.acp.control.Conference
- Returns the scheduled start time for the Conference
- getSecretPIN() -
Method in class com.avaya.conferencing.api.acp.control.operations.MakeCall
- Gets the MakeCall.secretPIN value
- getSecurityCode() -
Method in class com.avaya.conferencing.api.acp.control.operations.CallListGet
- Gets the Security code provided by the user for access to the Call List.
- getSecurityCode() -
Method in class com.avaya.conferencing.api.acp.control.operations.CallListSet
- gets the security code
- getSecurityCode() -
Method in class com.avaya.conferencing.api.acp.control.operations.MakeCallsFromList
- Gets the security code.
- getSelfIdentificationCode() -
Method in class com.avaya.conferencing.api.acp.control.EndPoint
- Gets the self-identification code associated with the EndPoint or an empty string if either: no
self-identification code has been associated with the EndPoint; or the self-identification feature
is not supported by the ConferencingProvider.
- getSequenceNumber() -
Method in class com.avaya.conferencing.api.acp.control.events.ChildEvent
- The sequence number of this event for this parent object.
- getSequenceNumber() -
Method in class com.avaya.conferencing.api.acp.control.events.DTMFEvent
- Returns the sequence number of this DTMF event.
- getSignalToNoiseRatio() -
Method in class com.avaya.conferencing.api.acp.control.events.DTMFEvent
- Returns the signal-to-noise ratio of the DTMF event or
null if this information is not available.
- getSkipTime() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaybackModeResume
- Returns the skipTime of this PlaybackModeResume object.
- getSkipTime() -
Method in class com.avaya.conferencing.api.acp.control.operations.RecordingModeResume
- Returns the skipTime of this RecordingModeResume object.
- getSource() -
Method in class com.avaya.conferencing.api.acp.control.events.AvailableVerbsChangeEvent
- The object on which the Event initially occurred.
- getSource() -
Method in class com.avaya.conferencing.api.acp.control.events.ChildEvent
- The object on which the Event initially occurred, that is the parent.
- getSource() -
Method in class com.avaya.conferencing.api.acp.control.events.DTMFEvent
- The EndPoint which generated this Event.
- getSource() -
Method in class com.avaya.conferencing.api.acp.control.events.StateChangeEvent
- The conferencing object on which the Event occurred.
- getSource() -
Method in class com.avaya.conferencing.api.acp.control.operations.Hold
- Getter for property 'source'.
- getStartTime() -
Method in class com.avaya.conferencing.api.acp.control.Conference
- Return the start time of this Conference.
- getStartTime() -
Method in class com.avaya.conferencing.api.acp.control.EndPoint
- Gets the time when this EndPoint connected to the ConferencingProvider.
- getState() -
Method in interface com.avaya.conferencing.api.acp.control.ConferencingObject
- Gets the state of this ConferencingObject.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.events.StateChangeEvent
- Returns the state change reported by this StateChangeEvent object.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.Access
- Returns the state that is affected by this StateChangingOperation.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.AutomaticGainControlMode
- Gets the State affected by the operation.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.ConferencingProviderLink
- Returns the state that is affected by this StateChangingOperation.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.DTMFPassthrough
- Gets the DTMF passthrough State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.DTMFRegeneration
- Gets the DTMF regeneration State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.Fault
- Returns the state that is affected by this StateChangingOperation.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.Hold
- Gets the Hold State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.LectureMode
- Gets the current Lecture State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.MeasureDTMFSignalToNoiseRatio
- Gets the DTMF signal to noise ratio reporting State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.Moderator
- Gets the Moderator State of the resource.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.ModeratorDisconnectMode
- Gets the State affected by the operation.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.Mute
- Gets the Muted State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.Observe
- Returns the state that is affected by this StateChangingOperation.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.ProtectDetails
- Gets the current locked State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.SecuredMode
- Gets the current conference secured State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.SecurityFeatures
- Gets whether security is enabled.
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.Silence
- Gets the 'Silenced' State
- getState() -
Method in class com.avaya.conferencing.api.acp.control.operations.StateChangingOperation
- Returns the state that is affected by this StateChangingOperation.
- getStates(Class<S>) -
Method in class com.avaya.conferencing.api.acp.control.ConferenceCallFlow
- Returns the permissible States for the specified ConferencingObject class when in this
call flow.
- getSubconferences() -
Method in class com.avaya.conferencing.api.acp.control.Conference
- Returns the Subconferences of this Conference.
- getSubconferences(Filter<? super Conference>...) -
Method in class com.avaya.conferencing.api.acp.control.Conference
- Returns the Subconferences of this Conference matching the specified filters.
- getSupportedProperties(Class<T>) -
Method in class com.avaya.conferencing.api.acp.control.Connection
- Returns the properties that are known/supported for a specific ConferencingObject class on this
connection.
- getSupportedProtocols() -
Method in class com.avaya.conferencing.api.acp.control.ConferencingProvider
- Returns the protocols supported by this ConferencingProvider.
- getSupportedURISchemes() -
Method in class com.avaya.conferencing.api.acp.control.Connection
- Gets the URI schemes supported by this connection.
- getToNumber() -
Method in class com.avaya.conferencing.api.acp.control.EndPoint
- Gets the callee's (that is the EndPoint's) phone number, that is the number dialled by the caller,
also known as DNIS.
- getToURI() -
Method in class com.avaya.conferencing.api.acp.control.EndPoint
- Gets the callee's (that is the EndPoint's) destination URI, that is URI that the caller connected
to.
- getToURI() -
Method in class com.avaya.conferencing.api.acp.control.operations.OperatorLogin
- Returns the desired Operator.getToURI() of the Operator object returned by this
OperatorLogin.
- getToURI() -
Method in class com.avaya.conferencing.api.acp.control.Operator
- Gets the dial-in URI for this Operator.
- getUniqueParticipantIdentifier() -
Method in class com.avaya.conferencing.api.acp.control.EndPoint
- Returns the EndPoint's unique participant identifier
- getUniqueParticpantIdentifier() -
Method in class com.avaya.conferencing.api.acp.control.operations.MakeCall
- Gets the MakeCall.uniqueParticpantIdentifier value
- getUriToDelete() -
Method in class com.avaya.conferencing.api.acp.control.operations.DeleteURI
-
- getUserCode() -
Method in class com.avaya.conferencing.api.acp.control.operations.CallListSet
- Deprecated. use
CallListSet.getSecurityCode()
- getUserCode() -
Method in class com.avaya.conferencing.api.acp.control.operations.MakeCallsFromList
- Deprecated. use
MakeCallsFromList.getSecurityCode()
- getUsername() -
Method in class com.avaya.conferencing.api.acp.control.operations.OperatorLogin
- Returns the username of this OperatorLogin object.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.AbortSignalToNoiseRatioMeasurement
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Access
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.AccessNextEntry
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.AutomaticGainControlMode
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.CallListGet
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.CallListSet
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.CallListsGet
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.CancelHelp
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.ConferencingProviderLink
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Create
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.DeleteURI
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Disconnect
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.DTMFPassthrough
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.DTMFRegeneration
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Fault
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.ForceConnectionUpdate
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.GetCurrentTime
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.GetRecordingURIs
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Hold
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.LectureMode
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.MakeCall
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.MakeCallsFromList
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.MeasureDTMFSignalToNoiseRatio
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.MeasureSignalToNoiseRatio
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.MediaSourceConnect
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Moderator
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.ModeratorDisconnectMode
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.ModifyDetails
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Mute
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Observe
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Open
- This gets the verb that describes this operation.
- getVerb() -
Method in interface com.avaya.conferencing.api.acp.control.operations.Operation
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.OperatorLogin
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.OperatorLogout
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaceInConference
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaceInMainConference
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaceInSubconference
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlayAndCollect
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaybackModePause
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaybackModeResume
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaybackModeStart
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlaybackModeStop
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlayConferenceRoster
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlayMessage
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PlayParticipantName
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PollingAssist
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PollingModeStart
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PollingModeStop
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PollingQuery
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PollingQueryDetail
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.PollingReset
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.ProtectDetails
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QACancelQuestion
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QAFinishedQuestion
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QAHaveQuestion
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QAModeStart
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QAModeStop
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QAMoveQuestion
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QANextQuestion
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QAPostponeQuestion
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.QAPreviousQuestion
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.RecordingModePause
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.RecordingModeResume
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.RecordingModeStart
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.RecordingModeStop
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.RequestHelp
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.SecuredMode
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.SecurityFeatures
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.SendDTMF
- This gets the verb that describes this operation.
- getVerb() -
Method in class com.avaya.conferencing.api.acp.control.operations.Silence
- This gets the verb that describes this operation.
- getVerbs() -
Method in class com.avaya.conferencing.api.acp.control.AbstractConferencingObject
- Returns the verbs that the connection's authentication is allowed to execute against this ConferencingObject
instance.
- getVerbs() -
Method in interface com.avaya.conferencing.api.acp.control.ConferencingObject
- Returns the verbs that the connection's authentication is allowed to execute against this ConferencingObject
instance.
- getVerbsAs(CPAuthentication) -
Method in interface com.avaya.conferencing.api.acp.control.ConferencingObject
- Returns the verbs that the specified authentication is allowed to execute against this ConferencingObject
instance.
- getVoiceMailFilter() -
Method in class com.avaya.conferencing.api.acp.control.operations.MakeCall
- Gets the value of VoiceMailFilter flag
- getWelcomeMessage() -
Method in class com.avaya.conferencing.api.acp.control.CallFlowMappingRule
- Returns the welcome message that is played to an EndPoint when it first connects, or
null if
no welcome message is played.
- getWorkerFactory() -
Method in class com.avaya.conferencing.api.acp.control.ConnectionContext
- Getter for property 'factory'.
true if the Conference is connected.
true if this EndPointQueue is connected.
true if this EndPointQueue is connected.
true if the EndPoint is connected.
true if this EndPointQueue is connected.
true if the MediaSource is connected.
true if the MediaSource is connected.
getFeatures().contains(Features.AUTO_GENERATE_FILE_NAME)
true when the message set of the Conference will be used for the messages played
specifically to the EndPoint (once the EndPoint has been placed in Conference), or false when the message set of the CallFlowMappingRule will be used for the
messages played specifically to the EndPoint.
true if this PropertyType represents information describing a ConferencingObject.
true if this operation completed.
true if all operations have completed.
true if this operation completed.
getEntries().isEmpty
true if this priority will exclude
EndPoints from the EndPointQueue
with ConferencingObjectQueue.Purposes.QA_QUESTIONS.
true if this PropertyType can be changed using this API.
true if the state is now present.
true if the state was previously present.
true if the connection is open.
getFeatures().contains(Features.PAUSE_RESUME)
getFeatures().contains(Features.PLAYBACK)
true if the protocol is supported.
true if the participant's name is recorded in this mode.
getFeatures().contains(Features.RECORDING)
true if the EndPoint's unique participant identifier and secret PIN (if applicable)
have been validated sucessfully.
true if this PropertyType represents the state of a ConferencingObject.
true if this operation has been submitted for execution.
true if the operations have been submitted.
true if this operation has been submitted for execution.
getFeatures().contains(Features.CAN_RECORD_TO_MESSAGE)
or getFeatures().contains(Features.CAN_RECORD_FROM_CONFERENCE) etc
true if the EndPoint is currently talking.
true if the reference is valid.
true if this operation will validate all property values before attempting to modify them.
null if the container does not exist.
null if incoming calls will be disconnected.
null if the rule does not place incoming EndPoint calls direct into
conference.
ExecutorService instance.
Conference.EndPoint from the Q&A queue).Reference object for a ConferencingObject.Conference
EndPoint instances into the list of those to be prepopulated into the Conference.
List of EndPoint instances into the existing list of those to be prepopulated into the
Conference.
MeasureSignalToNoiseRatio.getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.
PlayAndCollect.setMessage(com.avaya.conferencing.api.acp.control.Message)
Conference.
List of numbers into the list of those to be dialed into the Conference.
OperatorLogin.
CallListSet.setSecurityCode(String)
MakeCallsFromList.setSecurityCode(String)
true the properties will only be modified if all the properties are valid.
true and the AbstractConferencingObject.toString() method will print out the
proprty values of all properties.
|
Avaya Conferencing Provider API | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||