cisco.uc.cuae.legacy
Class JTapi.JTapiStartMonitoringOptions

java.lang.Object
  cisco.uc.cuae.legacy.JTapi.JTapiStartMonitoringOptions

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

JTapi

public static class JTapi.JTapiStartMonitoringOptions
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

java.lang.String	listenerDeviceName The device name of a device that should receive the monitor call.
java.lang.String	listenerDevicePool The name of the device pool containing application server-controlled devices.
JTapi.PlayToneDirection	playToneDirection The direction in which a recording indicator tone will be played.
java.lang.String	rxIP The IP address that the monitored audio should be sent to.
java.lang.Long	rxPort The port that the monitored audio should be sent to.
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

JTapi.JTapiStartMonitoringOptions()
Constructs the JTapiStartMonitoringOptions.

JTapi.JTapiStartMonitoringOptions(java.lang.Integer timeout, java.lang.String listenerDevicePool, java.lang.String listenerDeviceName, java.lang.String rxIP, java.lang.Long rxPort, JTapi.PlayToneDirection playToneDirection)
Constructs the JTapiStartMonitoringOptions.

Method Summary

java.lang.String	getListenerDeviceName() Gets the value.
java.lang.String	getListenerDevicePool() Gets the value.
JTapi.PlayToneDirection	getPlayToneDirection() Gets the value.
java.lang.String	getRxIP() Gets the value.
java.lang.Long	getRxPort() Gets the value.
java.lang.Integer	getTimeout() Gets the value.
void	setListenerDeviceName(java.lang.String value) Sets the value.
void	setListenerDevicePool(java.lang.String value) Sets the value.
void	setPlayToneDirection(JTapi.PlayToneDirection value) Sets the value.
void	setRxIP(java.lang.String value) Sets the value.
void	setRxPort(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

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.

listenerDevicePool

public java.lang.String listenerDevicePool

The name of the device pool containing application server-controlled devices. If specified, also specify RxIP and RxPort, but do not specify ListenerDeviceName and ListenerLineDN.

listenerDeviceName

public java.lang.String listenerDeviceName

The device name of a device that should receive the monitor call. If specified, also specify ListenerLineDN, but do not specify ListenerDevicePool.

rxIP

public java.lang.String rxIP

The IP address that the monitored audio should be sent to. If specified, also specify ListenerDevicePool and RxPort, but do not specify ListenerDeviceName and ListenerLineDN.

rxPort

public java.lang.Long rxPort

The port that the monitored audio should be sent to. If specified, also specify ListenerDevicePool and RxIP, but do not specify ListenerDeviceName and ListenerLineDN.

playToneDirection

public JTapi.PlayToneDirection playToneDirection

The direction in which a recording indicator tone will be played. If not specified, no tone will be played. Valid values area as follows: PlayToneNoLocalOrRemote - No tones are generated. PlayToneLocalOnly - The user being monitored hears a periodic tone. PlayToneRemoteOnly - The listener hears a periodic tone. PlayToneBothLocalAndRemote - Both local and remote tones are generated.

Constructor Detail

JTapi.JTapiStartMonitoringOptions

public JTapi.JTapiStartMonitoringOptions()

Constructs the JTapiStartMonitoringOptions. Don't init any fields.

JTapi.JTapiStartMonitoringOptions

public JTapi.JTapiStartMonitoringOptions(java.lang.Integer timeout,
                                         java.lang.String listenerDevicePool,
                                         java.lang.String listenerDeviceName,
                                         java.lang.String rxIP,
                                         java.lang.Long rxPort,
                                         JTapi.PlayToneDirection playToneDirection)

Constructs the JTapiStartMonitoringOptions.

Parameters:

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

listenerDevicePool - The name of the device pool containing application server-controlled listenerDevicePool devices. If specified, also specify RxIP and RxPort, but do not specify listenerDevicePool ListenerDeviceName and ListenerLineDN. listenerDevicePool

listenerDeviceName - The device name of a device that should receive the monitor call. If listenerDeviceName specified, also specify ListenerLineDN, but do not specify listenerDeviceName ListenerDevicePool. listenerDeviceName

rxIP - The IP address that the monitored audio should be sent to. If specified, rxIP also specify ListenerDevicePool and RxPort, but do not specify rxIP ListenerDeviceName and ListenerLineDN. rxIP

rxPort - The port that the monitored audio should be sent to. If specified, also rxPort specify ListenerDevicePool and RxIP, but do not specify ListenerDeviceName rxPort and ListenerLineDN. rxPort

playToneDirection - The direction in which a recording indicator tone will be played. If not playToneDirection specified, no tone will be played. Valid values area as follows: playToneDirection playToneDirection PlayToneNoLocalOrRemote - No tones are generated. playToneDirection PlayToneLocalOnly - The user being monitored hears a periodic tone. playToneDirection PlayToneRemoteOnly - The listener hears a periodic tone. playToneDirection PlayToneBothLocalAndRemote - Both local and remote tones are generated. playToneDirection

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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.

getListenerDevicePool

public java.lang.String getListenerDevicePool()

Gets the value. The name of the device pool containing application server-controlled devices. If specified, also specify RxIP and RxPort, but do not specify ListenerDeviceName and ListenerLineDN.

Returns:

the value.

setListenerDevicePool

public void setListenerDevicePool(java.lang.String value)

Sets the value. The name of the device pool containing application server-controlled devices. If specified, also specify RxIP and RxPort, but do not specify ListenerDeviceName and ListenerLineDN.

Parameters:

value - the value.

getListenerDeviceName

public java.lang.String getListenerDeviceName()

Gets the value. The device name of a device that should receive the monitor call. If specified, also specify ListenerLineDN, but do not specify ListenerDevicePool.

Returns:

the value.

setListenerDeviceName

public void setListenerDeviceName(java.lang.String value)

Sets the value. The device name of a device that should receive the monitor call. If specified, also specify ListenerLineDN, but do not specify ListenerDevicePool.

Parameters:

value - the value.

getRxIP

public java.lang.String getRxIP()

Gets the value. The IP address that the monitored audio should be sent to. If specified, also specify ListenerDevicePool and RxPort, but do not specify ListenerDeviceName and ListenerLineDN.

Returns:

the value.

setRxIP

public void setRxIP(java.lang.String value)

Sets the value. The IP address that the monitored audio should be sent to. If specified, also specify ListenerDevicePool and RxPort, but do not specify ListenerDeviceName and ListenerLineDN.

Parameters:

value - the value.

getRxPort

public java.lang.Long getRxPort()

Gets the value. The port that the monitored audio should be sent to. If specified, also specify ListenerDevicePool and RxIP, but do not specify ListenerDeviceName and ListenerLineDN.

Returns:

the value.

setRxPort

public void setRxPort(java.lang.Long value)

Sets the value. The port that the monitored audio should be sent to. If specified, also specify ListenerDevicePool and RxIP, but do not specify ListenerDeviceName and ListenerLineDN.

Parameters:

value - the value.

getPlayToneDirection

public JTapi.PlayToneDirection getPlayToneDirection()

Gets the value. The direction in which a recording indicator tone will be played. If not specified, no tone will be played. Valid values area as follows: PlayToneNoLocalOrRemote - No tones are generated. PlayToneLocalOnly - The user being monitored hears a periodic tone. PlayToneRemoteOnly - The listener hears a periodic tone. PlayToneBothLocalAndRemote - Both local and remote tones are generated.

Returns:

the value.

setPlayToneDirection

public void setPlayToneDirection(JTapi.PlayToneDirection value)

Sets the value. The direction in which a recording indicator tone will be played. If not specified, no tone will be played. Valid values area as follows: PlayToneNoLocalOrRemote - No tones are generated. PlayToneLocalOnly - The user being monitored hears a periodic tone. PlayToneRemoteOnly - The listener hears a periodic tone. PlayToneBothLocalAndRemote - Both local and remote tones are generated.

Parameters:

value - the value.