com.avaya.conferencing.api.acp.control.operations
Class Hold

java.lang.Object
  com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.Boolean,T>
      com.avaya.conferencing.api.acp.control.operations.StateChangingOperation<Hold>
          com.avaya.conferencing.api.acp.control.operations.Hold

All Implemented Interfaces:

Operation<java.lang.Boolean,Hold>, java.lang.Cloneable

public final class Hold
extends StateChangingOperation<Hold>

Places an EndPoint on hold.

Since:

5.1.0.0.29

Nested Class Summary

Nested classes/interfaces inherited from interface com.avaya.conferencing.api.acp.control.operations.Operation

Operation.Impact

Method Summary

MediaSource	getSource() Getter for property 'source'.
State	getState() Gets the Hold State
Verb	getVerb() This gets the verb that describes this operation.
void	setSource(MediaSource source) Setter for property 'source'.

Methods inherited from class com.avaya.conferencing.api.acp.control.operations.StateChangingOperation

getImpact, getMode, off, on, setMode, toggle, toString

Methods inherited from class com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl

await, await, checkNotSubmitted, checkSubmitted, clone, get, get, isDone, isSubmitted, set

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getSource

public MediaSource getSource()

Getter for property 'source'.

Returns:

Value for property 'source'.

Since:

5.1.0.0.29

setSource

public void setSource(MediaSource source)

Setter for property 'source'.

Parameters:

source - Value to set for property 'source'.

Since:

5.1.0.0.29

getVerb

public Verb getVerb()

This gets the verb that describes this operation. Multiple operations may return the same verb, however verbs must be unique across the preferred operations. That is only one prefered operation may implement the "mute" verb. There may be deprecated operations that implement the "mute" verb but these will be less performant as they will be implemented as wrappers for the preferred "mute" operation.

Returns:

the verb that describes the operation.

Since:

5.1.0.0.29

getState

public State getState()

Gets the Hold State

Specified by:

getState in class StateChangingOperation<Hold>

Returns:

the Hold State

Since:

5.1.0.0.29