cisco.uc.cuae.legacy
Class CallControl.AcceptCallEarlyMediaResult

java.lang.Object
  cisco.uc.cuae.legacy.CallControl.AcceptCallEarlyMediaResult

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

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

See Also:

Serialized Form

Field Summary

java.lang.String	callId Indicates the call for which the one way media path is setup.
java.lang.String	connectionId Unique identifier used to identify this connection in all subsequent Media Control API operations.
java.lang.String	failReason Indicates the reason for failure of the execution of this API.
java.lang.String	mediaRxIP The IP address that the Rx RTP stream must be sent to for this connection.
java.lang.Long	mediaRxPort The IP address that the Rx RTP stream must be sent to for this connection.
java.lang.Long	mmsId Unique identifier used to identify the media engine in control of this connection.
CuaeCommon.CuaeResult	returnValue

Constructor Summary

CallControl.AcceptCallEarlyMediaResult()
Constructs the AcceptCallEarlyMediaResult.

CallControl.AcceptCallEarlyMediaResult(CuaeCommon.CuaeResult returnValue, java.lang.String callId, java.lang.Long mmsId, java.lang.String connectionId, java.lang.String mediaRxIP, java.lang.Long mediaRxPort, java.lang.String failReason)
Constructs the AcceptCallEarlyMediaResult.

Method Summary

java.lang.String	getCallId() Gets the value.
java.lang.String	getConnectionId() Gets the value.
java.lang.String	getFailReason() Gets the value.
java.lang.String	getMediaRxIP() Gets the value.
java.lang.Long	getMediaRxPort() Gets the value.
java.lang.Long	getMmsId() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
void	setCallId(java.lang.String value) Sets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setFailReason(java.lang.String value) Sets the value.
void	setMediaRxIP(java.lang.String value) Sets the value.
void	setMediaRxPort(java.lang.Long value) Sets the value.
void	setMmsId(java.lang.Long value) Sets the value.
void	setReturnValue(CuaeCommon.CuaeResult 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

returnValue

public CuaeCommon.CuaeResult returnValue

callId

public java.lang.String callId

Indicates the call for which the one way media path is setup. This is always the same value passed in as the CallId action parameter.

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 field will only be populated if the partition of the script instance is configured to Reserve Media Early.

connectionId

public java.lang.String connectionId

Unique identifier used to identify this connection in all subsequent Media Control API operations. Before using with most Media Control actions, this connection must still be fully connected with CreateConnection or by answering the call. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

mediaRxIP

public java.lang.String mediaRxIP

The IP address that the Rx RTP stream must be sent to for this connection. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

mediaRxPort

public java.lang.Long mediaRxPort

The IP address that the Rx RTP stream must be sent to for this connection. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

failReason

public java.lang.String failReason

Indicates the reason for failure of the execution of this API. Valid values are as follows: NoFail - Indicates that the API call is successful. RemoteMediaNotAvailable - Indicates that media information of the remote side is not available and so could not setup media session from the media engine. The call may not need to be terminated for this condition and it can be followed by AnswerCall, RejectCall, etc. EarlyMediaNotSet - Indicates that Reserve Media Early is not set to true on the partition of the script instance and so media session would not be setup. The call may not need to be terminated for this condition and it can be followed by AnswerCall, RejectCall, etc. InternalError - Indicates that API execution failed due to some error conditions and the call should be terminated.

Constructor Detail

CallControl.AcceptCallEarlyMediaResult

public CallControl.AcceptCallEarlyMediaResult()

Constructs the AcceptCallEarlyMediaResult. Don't init any fields.

CallControl.AcceptCallEarlyMediaResult

public CallControl.AcceptCallEarlyMediaResult(CuaeCommon.CuaeResult returnValue,
                                              java.lang.String callId,
                                              java.lang.Long mmsId,
                                              java.lang.String connectionId,
                                              java.lang.String mediaRxIP,
                                              java.lang.Long mediaRxPort,
                                              java.lang.String failReason)

Constructs the AcceptCallEarlyMediaResult.

Parameters:

callId - Indicates the call for which the one way media path is setup. This is callId always the same value passed in as the CallId action parameter. 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 field will only be populated if the partition of the script mmsId instance is configured to Reserve Media Early. mmsId

connectionId - Unique identifier used to identify this connection in all subsequent connectionId Media Control API operations. Before using with most Media Control connectionId actions, this connection must still be fully connected with connectionId CreateConnection or by answering the call. This field will only be connectionId populated if the partition of the script instance is configured to connectionId Reserve Media Early. connectionId

mediaRxIP - The IP address that the Rx RTP stream must be sent to for this mediaRxIP connection. This field will only be populated if the partition of the mediaRxIP script instance is configured to Reserve Media Early. mediaRxIP

mediaRxPort - The IP address that the Rx RTP stream must be sent to for this mediaRxPort connection. This field will only be populated if the partition of the mediaRxPort script instance is configured to Reserve Media Early. mediaRxPort

failReason - Indicates the reason for failure of the execution of this API. Valid failReason values are as follows: failReason failReason NoFail - Indicates that the API call is successful. failReason RemoteMediaNotAvailable - Indicates that media information of the failReason remote side is not available and so could not setup failReason media session from the media engine. The call may not failReason need to be terminated for this condition and it can be failReason followed by AnswerCall, RejectCall, etc. failReason EarlyMediaNotSet - Indicates that Reserve Media Early is not set to failReason true on the partition of the script instance and so failReason media session would not be setup. The call may not need failReason to be terminated for this condition and it can be failReason followed by AnswerCall, RejectCall, etc. failReason InternalError - Indicates that API execution failed due to some error failReason conditions and the call should be terminated. failReason

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getReturnValue

public CuaeCommon.CuaeResult getReturnValue()

Gets the value.

Returns:

the value.

setReturnValue

public void setReturnValue(CuaeCommon.CuaeResult value)

Sets the value.

Parameters:

value - the value.

getCallId

public java.lang.String getCallId()

Gets the value. Indicates the call for which the one way media path is setup. This is always the same value passed in as the CallId action parameter.

Returns:

the value.

setCallId

public void setCallId(java.lang.String value)

Sets the value. Indicates the call for which the one way media path is setup. This is always the same value passed in as the CallId action parameter.

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 field will only be populated if the partition of the script instance is configured to Reserve Media Early.

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 field will only be populated if the partition of the script instance is configured to Reserve Media Early.

Parameters:

value - the value.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. Before using with most Media Control actions, this connection must still be fully connected with CreateConnection or by answering the call. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

Returns:

the value.

setConnectionId

public void setConnectionId(java.lang.String value)

Sets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. Before using with most Media Control actions, this connection must still be fully connected with CreateConnection or by answering the call. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

Parameters:

value - the value.

getMediaRxIP

public java.lang.String getMediaRxIP()

Gets the value. The IP address that the Rx RTP stream must be sent to for this connection. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

Returns:

the value.

setMediaRxIP

public void setMediaRxIP(java.lang.String value)

Sets the value. The IP address that the Rx RTP stream must be sent to for this connection. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

Parameters:

value - the value.

getMediaRxPort

public java.lang.Long getMediaRxPort()

Gets the value. The IP address that the Rx RTP stream must be sent to for this connection. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

Returns:

the value.

setMediaRxPort

public void setMediaRxPort(java.lang.Long value)

Sets the value. The IP address that the Rx RTP stream must be sent to for this connection. This field will only be populated if the partition of the script instance is configured to Reserve Media Early.

Parameters:

value - the value.

getFailReason

public java.lang.String getFailReason()

Gets the value. Indicates the reason for failure of the execution of this API. Valid values are as follows: NoFail - Indicates that the API call is successful. RemoteMediaNotAvailable - Indicates that media information of the remote side is not available and so could not setup media session from the media engine. The call may not need to be terminated for this condition and it can be followed by AnswerCall, RejectCall, etc. EarlyMediaNotSet - Indicates that Reserve Media Early is not set to true on the partition of the script instance and so media session would not be setup. The call may not need to be terminated for this condition and it can be followed by AnswerCall, RejectCall, etc. InternalError - Indicates that API execution failed due to some error conditions and the call should be terminated.

Returns:

the value.

setFailReason

public void setFailReason(java.lang.String value)

Sets the value. Indicates the reason for failure of the execution of this API. Valid values are as follows: NoFail - Indicates that the API call is successful. RemoteMediaNotAvailable - Indicates that media information of the remote side is not available and so could not setup media session from the media engine. The call may not need to be terminated for this condition and it can be followed by AnswerCall, RejectCall, etc. EarlyMediaNotSet - Indicates that Reserve Media Early is not set to true on the partition of the script instance and so media session would not be setup. The call may not need to be terminated for this condition and it can be followed by AnswerCall, RejectCall, etc. InternalError - Indicates that API execution failed due to some error conditions and the call should be terminated.

Parameters:

value - the value.