cisco.uc.cuae.legacy
Class MediaControl.PlayToneOptions

java.lang.Object
  cisco.uc.cuae.legacy.MediaControl.PlayToneOptions

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

public static class MediaControl.PlayToneOptions
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

java.lang.String	state1 Optional user state information which is guaranteed present as the State event parameter in PlayTone_Complete or PlayTone_Failed.
java.lang.String	termCondDigit A specific digit that will cause the PlayTone operation to terminate.
java.lang.Long	termCondMaxTime The amount of time (in milliseconds) that can elapse before terminating the PlayTone operation.
java.lang.Long	termCondNonSilence The amount of non-silence (in milliseconds) to observe before terminating the PlayTone operation.
java.lang.Long	termCondSilence The amount of silence (in milliseconds) to observe before terminating the PlayTone operation.
java.lang.Integer	timeout The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action.

Constructor Summary

MediaControl.PlayToneOptions()
Constructs the PlayToneOptions.

MediaControl.PlayToneOptions(java.lang.String state1, java.lang.Long termCondMaxTime, java.lang.String termCondDigit, java.lang.Long termCondSilence, java.lang.Integer timeout, java.lang.Long termCondNonSilence)
Constructs the PlayToneOptions.

Method Summary

java.lang.String	getState1() Gets the value.
java.lang.String	getTermCondDigit() Gets the value.
java.lang.Long	getTermCondMaxTime() Gets the value.
java.lang.Long	getTermCondNonSilence() Gets the value.
java.lang.Long	getTermCondSilence() Gets the value.
java.lang.Integer	getTimeout() Gets the value.
void	setState1(java.lang.String value) Sets the value.
void	setTermCondDigit(java.lang.String value) Sets the value.
void	setTermCondMaxTime(java.lang.Long value) Sets the value.
void	setTermCondNonSilence(java.lang.Long value) Sets the value.
void	setTermCondSilence(java.lang.Long value) Sets the value.
void	setTimeout(java.lang.Integer value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

state1

public java.lang.String state1

Optional user state information which is guaranteed present as the State event parameter in PlayTone_Complete or PlayTone_Failed.

termCondMaxTime

public java.lang.Long termCondMaxTime

The amount of time (in milliseconds) that can elapse before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of maxtime.

termCondDigit

public java.lang.String termCondDigit

A specific digit that will cause the PlayTone operation to terminate. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of digit. Note that this termination condition is only valid if one is playing a tone to a ConnectionId.

termCondSilence

public java.lang.Long termCondSilence

The amount of silence (in milliseconds) to observe before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of silence.

timeout

public java.lang.Integer timeout

The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

termCondNonSilence

public java.lang.Long termCondNonSilence

The amount of non-silence (in milliseconds) to observe before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of nonsilence.

Constructor Detail

MediaControl.PlayToneOptions

public MediaControl.PlayToneOptions()

Constructs the PlayToneOptions. Don't init any fields.

MediaControl.PlayToneOptions

public MediaControl.PlayToneOptions(java.lang.String state1,
                                    java.lang.Long termCondMaxTime,
                                    java.lang.String termCondDigit,
                                    java.lang.Long termCondSilence,
                                    java.lang.Integer timeout,
                                    java.lang.Long termCondNonSilence)

Constructs the PlayToneOptions.

Parameters:

state1 - Optional user state information which is guaranteed present as the State state1 event parameter in PlayTone_Complete or PlayTone_Failed. state1

termCondMaxTime - The amount of time (in milliseconds) that can elapse before terminating the termCondMaxTime PlayTone operation. If this condition is met, the PlayTone command will termCondMaxTime result in the PlayTone_Complete event with a TerminationCondition of termCondMaxTime maxtime. termCondMaxTime

termCondDigit - A specific digit that will cause the PlayTone operation to terminate. If termCondDigit this condition is met, the PlayTone command will result in the termCondDigit PlayTone_Complete event with a TerminationCondition of digit. Note that termCondDigit this termination condition is only valid if one is playing a tone to a termCondDigit ConnectionId. termCondDigit

termCondSilence - The amount of silence (in milliseconds) to observe before terminating the termCondSilence PlayTone operation. If this condition is met, the PlayTone command will termCondSilence result in the PlayTone_Complete event with a TerminationCondition of termCondSilence silence. termCondSilence

timeout - The Timeout property specifies to the Application Runtime Environment how timeout long to wait for a response from the provider for the current action. The timeout ReturnValue returned in this case is Timeout. The value must be a literal timeout value in milliseconds. timeout

termCondNonSilence - The amount of non-silence (in milliseconds) to observe before terminating termCondNonSilence the PlayTone operation. If this condition is met, the PlayTone command will termCondNonSilence result in the PlayTone_Complete event with a TerminationCondition of termCondNonSilence nonsilence. termCondNonSilence

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getState1

public java.lang.String getState1()

Gets the value. Optional user state information which is guaranteed present as the State event parameter in PlayTone_Complete or PlayTone_Failed.

Returns:

the value.

setState1

public void setState1(java.lang.String value)

Sets the value. Optional user state information which is guaranteed present as the State event parameter in PlayTone_Complete or PlayTone_Failed.

Parameters:

value - the value.

getTermCondMaxTime

public java.lang.Long getTermCondMaxTime()

Gets the value. The amount of time (in milliseconds) that can elapse before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of maxtime.

Returns:

the value.

setTermCondMaxTime

public void setTermCondMaxTime(java.lang.Long value)

Sets the value. The amount of time (in milliseconds) that can elapse before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of maxtime.

Parameters:

value - the value.

getTermCondDigit

public java.lang.String getTermCondDigit()

Gets the value. A specific digit that will cause the PlayTone operation to terminate. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of digit. Note that this termination condition is only valid if one is playing a tone to a ConnectionId.

Returns:

the value.

setTermCondDigit

public void setTermCondDigit(java.lang.String value)

Sets the value. A specific digit that will cause the PlayTone operation to terminate. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of digit. Note that this termination condition is only valid if one is playing a tone to a ConnectionId.

Parameters:

value - the value.

getTermCondSilence

public java.lang.Long getTermCondSilence()

Gets the value. The amount of silence (in milliseconds) to observe before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of silence.

Returns:

the value.

setTermCondSilence

public void setTermCondSilence(java.lang.Long value)

Sets the value. The amount of silence (in milliseconds) to observe before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of silence.

Parameters:

value - the value.

getTimeout

public java.lang.Integer getTimeout()

Gets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Returns:

the value.

setTimeout

public void setTimeout(java.lang.Integer value)

Sets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Parameters:

value - the value.

getTermCondNonSilence

public java.lang.Long getTermCondNonSilence()

Gets the value. The amount of non-silence (in milliseconds) to observe before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of nonsilence.

Returns:

the value.

setTermCondNonSilence

public void setTermCondNonSilence(java.lang.Long value)

Sets the value. The amount of non-silence (in milliseconds) to observe before terminating the PlayTone operation. If this condition is met, the PlayTone command will result in the PlayTone_Complete event with a TerminationCondition of nonsilence.

Parameters:

value - the value.