cisco.uc.cuae.legacy
Class CallControl.StopTxOptions

java.lang.Object
  extended by cisco.uc.cuae.legacy.CallControl.StopTxOptions
All Implemented Interfaces:
java.io.Serializable
Enclosing interface:
CallControl

public static class CallControl.StopTxOptions
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
 java.lang.String callId
          Unique identifier used to identify the call leg that received the command to stop sending media.
 java.lang.String connectionId
          Unique identifier used to identify this connection in all Media Control API operations.
 java.lang.Long mmsId
          Unique identifier used to identify the media engine in control of this connection.
 
Constructor Summary
CallControl.StopTxOptions()
          Constructs the StopTxOptions.
CallControl.StopTxOptions(java.lang.String callId, java.lang.Long mmsId, java.lang.String connectionId)
          Constructs the StopTxOptions.
 
Method Summary
 java.lang.String getCallId()
          Gets the value.
 java.lang.String getConnectionId()
          Gets the value.
 java.lang.Long getMmsId()
          Gets the value.
 void setCallId(java.lang.String value)
          Sets the value.
 void setConnectionId(java.lang.String value)
          Sets the value.
 void setMmsId(java.lang.Long 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

callId

public java.lang.String callId
Unique identifier used to identify the call leg that received the command to stop sending media.


mmsId

public java.lang.Long mmsId
Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine. This event parameter will not be populated if the call is in a peer-to-peer relationship.


connectionId

public java.lang.String connectionId
Unique identifier used to identify this connection in all Media Control API operations. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Constructor Detail

CallControl.StopTxOptions

public CallControl.StopTxOptions()
Constructs the StopTxOptions. Don't init any fields.


CallControl.StopTxOptions

public CallControl.StopTxOptions(java.lang.String callId,
                                 java.lang.Long mmsId,
                                 java.lang.String connectionId)
Constructs the StopTxOptions.

Parameters:
callId - Unique identifier used to identify the call leg that received the command callId to stop sending media. callId
mmsId - Unique identifier used to identify the media engine in control of this mmsId connection. A common use for this ID is to ensure that other connections mmsId which will ultimately be conferenced with this connection are all created mmsId on the same media engine. This correlation is necessary because all mmsId connections in a single conference must all reside on the same media mmsId engine. This event parameter will not be populated if the call is in a mmsId peer-to-peer relationship. mmsId
connectionId - Unique identifier used to identify this connection in all Media Control API connectionId operations. This event parameter will not be populated if the call is in a connectionId peer-to-peer relationship. connectionId
Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getCallId

public java.lang.String getCallId()
Gets the value. Unique identifier used to identify the call leg that received the command to stop sending media.

Returns:
the value.

setCallId

public void setCallId(java.lang.String value)
Sets the value. Unique identifier used to identify the call leg that received the command to stop sending media.

Parameters:
value - the value.

getMmsId

public java.lang.Long getMmsId()
Gets the value. Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Returns:
the value.

setMmsId

public void setMmsId(java.lang.Long value)
Sets the value. Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Parameters:
value - the value.

getConnectionId

public java.lang.String getConnectionId()
Gets the value. Unique identifier used to identify this connection in all Media Control API operations. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Returns:
the value.

setConnectionId

public void setConnectionId(java.lang.String value)
Sets the value. Unique identifier used to identify this connection in all Media Control API operations. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Parameters:
value - the value.


Copyright © 2008. All Rights Reserved.