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

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

All Implemented Interfaces:

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

public class PlayMessage
extends AbstractOperationImpl<java.lang.Boolean,PlayMessage>

Operation to allow an Operator to play a Message to either a Conference or an EndPoint.

The operation will return a Boolean indicating whether the Message was played successfully.

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

Operation.Impact	getImpact() Returns the impact of the operation.
Message	getMessage() Gets the Message.
Verb	getVerb() This gets the verb that describes this operation.
void	setMessage(Message message) Sets the Message to play.

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

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

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public Message getMessage()

Gets the Message.

Returns:

the Message.

Since:

5.1.0.0.29

setMessage

@Required
public void setMessage(Message message)

Sets the Message to play.

Parameters:

message - the Message.

Since:

5.1.0.0.29

getImpact

public Operation.Impact getImpact()

Returns the impact of the operation.

Returns:

the impact.

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