cisco.uc.cuae.legacy
Class CallControl.MakeCallOptions

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

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

See Also:

Serialized Form

Field Summary

java.lang.Boolean	conference Indicates that this call is to be placed in a conference.
java.lang.String	conferenceId The ConferenceId of the conference to add this call to.
java.lang.Boolean	hairpin Indicates that the new conference should be optimized for two parties.
java.lang.Long	mmsId The ID of the media engine to create the connection on.
java.lang.String	peerCallId The CallId of an unanswered incoming call that has triggered a script instance via the IncomingCall event.
java.lang.String	proxyDTMFCallId The CallId to establish a proxy relationship with.
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.
CallControl.WaitForMedia	waitForMedia Indicates what degree of media negotiation must be established before the call is considered completed.

Constructor Summary

CallControl.MakeCallOptions()
Constructs the MakeCallOptions.

CallControl.MakeCallOptions(java.lang.Long mmsId, java.lang.String peerCallId, java.lang.String proxyDTMFCallId, CallControl.WaitForMedia waitForMedia, java.lang.Boolean conference, java.lang.String conferenceId, java.lang.Boolean hairpin, java.lang.Integer timeout)
Constructs the MakeCallOptions.

Method Summary

java.lang.Boolean	getConference() Gets the value.
java.lang.String	getConferenceId() Gets the value.
java.lang.Boolean	getHairpin() Gets the value.
java.lang.Long	getMmsId() Gets the value.
java.lang.String	getPeerCallId() Gets the value.
java.lang.String	getProxyDTMFCallId() Gets the value.
java.lang.Integer	getTimeout() Gets the value.
CallControl.WaitForMedia	getWaitForMedia() Gets the value.
void	setConference(java.lang.Boolean value) Sets the value.
void	setConferenceId(java.lang.String value) Sets the value.
void	setHairpin(java.lang.Boolean value) Sets the value.
void	setMmsId(java.lang.Long value) Sets the value.
void	setPeerCallId(java.lang.String value) Sets the value.
void	setProxyDTMFCallId(java.lang.String value) Sets the value.
void	setTimeout(java.lang.Integer value) Sets the value.
void	setWaitForMedia(CallControl.WaitForMedia 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

mmsId

public java.lang.Long mmsId

The ID of the media engine to create the connection on. If no MmsId is specified when using MakeCall, a media engine with the most available resources is dynamically selected from the Media Resource Group associated with the partition of the script instance from which MakeCall is invoked.

peerCallId

public java.lang.String peerCallId

The CallId of an unanswered incoming call that has triggered a script instance via the IncomingCall event. Once the call placed by this MakeCall is completed, the call specified by this action parameter is automatically answered by the application server and the media streams are established in a peer-to-peer relationship.

proxyDTMFCallId

public java.lang.String proxyDTMFCallId

The CallId to establish a proxy relationship with. Any digits received on one call leg will be proxied to the other. If ProxyDTMFCallId is not set and PeerCallId is, then the call specified by PeerCallId will be used for this action parameter.

waitForMedia

public CallControl.WaitForMedia waitForMedia

Indicates what degree of media negotiation must be established before the call is considered completed. A completed call results in the MakeCall_Complete event being fired. Valid values are as follows: None - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered, regardless of the state of media negotiation. Tx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered and the remote endpoint has specified the properties of the audio stream that it wants transmitted to it. Rx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered and the application server has specified the properties of the audio stream that it wants transmitted to the media engine. TxRx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered, the remote endpoint has specified the properties of the audio stream that it wants transmitted to it, and the application server has specified the properties of the audio stream that it wants transmitted to the media engine. Note that depending on the value chosen, MakeCall_Complete event parameters relating to the negotiated media information may not be valid yet because the media negotiation may not yet be completed.

conference

public java.lang.Boolean conference

Indicates that this call is to be placed in a conference. If a ConferenceId is not specified or is set to 0, then a new conference is created on the media engine and the ConferenceId in the MakeCall_Complete event is the unique identifier for that new conference (assuming WaitForMedia is the default TxRx). If a ConferenceId is specified, then the connection created for this call is moved into the existing conference as soon as the media channels for the call have been fully established.

conferenceId

public java.lang.String conferenceId

The ConferenceId of the conference to add this call to. Specify no value or 0 if this is to be a new conference. This field is ignored if Conference is false.

hairpin

public java.lang.Boolean hairpin

Indicates that the new conference should be optimized for two parties. A hairpinned conference does not use any conference resources. However, a hairpin conference will be 'promoted', or converted to a true media conference, if a 3rd participant is added to the conference or if a voice operation is performed on the conference itself. In either case, this will cause each participant and conferenced voice operation to use one conference resource. True conferences also have a slightly increased latency over a hairpinned conference.

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.

Constructor Detail

CallControl.MakeCallOptions

public CallControl.MakeCallOptions()

Constructs the MakeCallOptions. Don't init any fields.

CallControl.MakeCallOptions

public CallControl.MakeCallOptions(java.lang.Long mmsId,
                                   java.lang.String peerCallId,
                                   java.lang.String proxyDTMFCallId,
                                   CallControl.WaitForMedia waitForMedia,
                                   java.lang.Boolean conference,
                                   java.lang.String conferenceId,
                                   java.lang.Boolean hairpin,
                                   java.lang.Integer timeout)

Constructs the MakeCallOptions.

Parameters:

mmsId - The ID of the media engine to create the connection on. If no MmsId is mmsId specified when using MakeCall, a media engine with the most available mmsId resources is dynamically selected from the Media Resource Group associated mmsId with the partition of the script instance from which MakeCall is invoked. mmsId

peerCallId - The CallId of an unanswered incoming call that has triggered a script peerCallId instance via the IncomingCall event. Once the call placed by this MakeCall peerCallId is completed, the call specified by this action parameter is automatically peerCallId answered by the application server and the media streams are established in peerCallId a peer-to-peer relationship. peerCallId

proxyDTMFCallId - The CallId to establish a proxy relationship with. Any digits received on proxyDTMFCallId one call leg will be proxied to the other. If ProxyDTMFCallId is not set proxyDTMFCallId and PeerCallId is, then the call specified by PeerCallId will be used for proxyDTMFCallId this action parameter. proxyDTMFCallId

waitForMedia - Indicates what degree of media negotiation must be established before the waitForMedia call is considered completed. A completed call results in the waitForMedia MakeCall_Complete event being fired. Valid values are as follows: waitForMedia waitForMedia None - Indicates that the call should be considered completed as soon as waitForMedia the call control signaling has indicated that the call is waitForMedia answered, regardless of the state of media negotiation. waitForMedia Tx - Indicates that the call should be considered completed as soon as waitForMedia the call control signaling has indicated that the call is answered waitForMedia and the remote endpoint has specified the properties of the audio waitForMedia stream that it wants transmitted to it. waitForMedia Rx - Indicates that the call should be considered completed as soon as waitForMedia the call control signaling has indicated that the call is answered waitForMedia and the application server has specified the properties of the audio waitForMedia stream that it wants transmitted to the media engine. waitForMedia TxRx - Indicates that the call should be considered completed as soon as waitForMedia the call control signaling has indicated that the call is waitForMedia answered, the remote endpoint has specified the properties of the waitForMedia audio stream that it wants transmitted to it, and the application waitForMedia server has specified the properties of the audio stream that it waitForMedia wants transmitted to the media engine. waitForMedia waitForMedia Note that depending on the value chosen, MakeCall_Complete event parameters waitForMedia relating to the negotiated media information may not be valid yet because waitForMedia the media negotiation may not yet be completed. waitForMedia

conference - Indicates that this call is to be placed in a conference. If a ConferenceId conference is not specified or is set to 0, then a new conference is created on the conference media engine and the ConferenceId in the MakeCall_Complete event is the conference unique identifier for that new conference (assuming WaitForMedia is the conference default TxRx). If a ConferenceId is specified, then the connection created conference for this call is moved into the existing conference as soon as the media conference channels for the call have been fully established. conference

conferenceId - The ConferenceId of the conference to add this call to. Specify no value or conferenceId 0 if this is to be a new conference. This field is ignored if Conference is conferenceId false. conferenceId

hairpin - Indicates that the new conference should be optimized for two parties. A hairpin hairpinned conference does not use any conference resources. However, a hairpin hairpin conference will be 'promoted', or converted to a true media hairpin conference, if a 3rd participant is added to the conference or if a voice hairpin operation is performed on the conference itself. In either case, this will hairpin cause each participant and conferenced voice operation to use one hairpin conference resource. True conferences also have a slightly increased hairpin latency over a hairpinned conference. hairpin

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMmsId

public java.lang.Long getMmsId()

Gets the value. The ID of the media engine to create the connection on. If no MmsId is specified when using MakeCall, a media engine with the most available resources is dynamically selected from the Media Resource Group associated with the partition of the script instance from which MakeCall is invoked.

Returns:

the value.

setMmsId

public void setMmsId(java.lang.Long value)

Sets the value. The ID of the media engine to create the connection on. If no MmsId is specified when using MakeCall, a media engine with the most available resources is dynamically selected from the Media Resource Group associated with the partition of the script instance from which MakeCall is invoked.

Parameters:

value - the value.

getPeerCallId

public java.lang.String getPeerCallId()

Gets the value. The CallId of an unanswered incoming call that has triggered a script instance via the IncomingCall event. Once the call placed by this MakeCall is completed, the call specified by this action parameter is automatically answered by the application server and the media streams are established in a peer-to-peer relationship.

Returns:

the value.

setPeerCallId

public void setPeerCallId(java.lang.String value)

Sets the value. The CallId of an unanswered incoming call that has triggered a script instance via the IncomingCall event. Once the call placed by this MakeCall is completed, the call specified by this action parameter is automatically answered by the application server and the media streams are established in a peer-to-peer relationship.

Parameters:

value - the value.

getProxyDTMFCallId

public java.lang.String getProxyDTMFCallId()

Gets the value. The CallId to establish a proxy relationship with. Any digits received on one call leg will be proxied to the other. If ProxyDTMFCallId is not set and PeerCallId is, then the call specified by PeerCallId will be used for this action parameter.

Returns:

the value.

setProxyDTMFCallId

public void setProxyDTMFCallId(java.lang.String value)

Sets the value. The CallId to establish a proxy relationship with. Any digits received on one call leg will be proxied to the other. If ProxyDTMFCallId is not set and PeerCallId is, then the call specified by PeerCallId will be used for this action parameter.

Parameters:

value - the value.

getWaitForMedia

public CallControl.WaitForMedia getWaitForMedia()

Gets the value. Indicates what degree of media negotiation must be established before the call is considered completed. A completed call results in the MakeCall_Complete event being fired. Valid values are as follows: None - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered, regardless of the state of media negotiation. Tx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered and the remote endpoint has specified the properties of the audio stream that it wants transmitted to it. Rx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered and the application server has specified the properties of the audio stream that it wants transmitted to the media engine. TxRx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered, the remote endpoint has specified the properties of the audio stream that it wants transmitted to it, and the application server has specified the properties of the audio stream that it wants transmitted to the media engine. Note that depending on the value chosen, MakeCall_Complete event parameters relating to the negotiated media information may not be valid yet because the media negotiation may not yet be completed.

Returns:

the value.

setWaitForMedia

public void setWaitForMedia(CallControl.WaitForMedia value)

Sets the value. Indicates what degree of media negotiation must be established before the call is considered completed. A completed call results in the MakeCall_Complete event being fired. Valid values are as follows: None - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered, regardless of the state of media negotiation. Tx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered and the remote endpoint has specified the properties of the audio stream that it wants transmitted to it. Rx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered and the application server has specified the properties of the audio stream that it wants transmitted to the media engine. TxRx - Indicates that the call should be considered completed as soon as the call control signaling has indicated that the call is answered, the remote endpoint has specified the properties of the audio stream that it wants transmitted to it, and the application server has specified the properties of the audio stream that it wants transmitted to the media engine. Note that depending on the value chosen, MakeCall_Complete event parameters relating to the negotiated media information may not be valid yet because the media negotiation may not yet be completed.

Parameters:

value - the value.

getConference

public java.lang.Boolean getConference()

Gets the value. Indicates that this call is to be placed in a conference. If a ConferenceId is not specified or is set to 0, then a new conference is created on the media engine and the ConferenceId in the MakeCall_Complete event is the unique identifier for that new conference (assuming WaitForMedia is the default TxRx). If a ConferenceId is specified, then the connection created for this call is moved into the existing conference as soon as the media channels for the call have been fully established.

Returns:

the value.

setConference

public void setConference(java.lang.Boolean value)

Sets the value. Indicates that this call is to be placed in a conference. If a ConferenceId is not specified or is set to 0, then a new conference is created on the media engine and the ConferenceId in the MakeCall_Complete event is the unique identifier for that new conference (assuming WaitForMedia is the default TxRx). If a ConferenceId is specified, then the connection created for this call is moved into the existing conference as soon as the media channels for the call have been fully established.

Parameters:

value - the value.

getConferenceId

public java.lang.String getConferenceId()

Gets the value. The ConferenceId of the conference to add this call to. Specify no value or 0 if this is to be a new conference. This field is ignored if Conference is false.

Returns:

the value.

setConferenceId

public void setConferenceId(java.lang.String value)

Sets the value. The ConferenceId of the conference to add this call to. Specify no value or 0 if this is to be a new conference. This field is ignored if Conference is false.

Parameters:

value - the value.

getHairpin

public java.lang.Boolean getHairpin()

Gets the value. Indicates that the new conference should be optimized for two parties. A hairpinned conference does not use any conference resources. However, a hairpin conference will be 'promoted', or converted to a true media conference, if a 3rd participant is added to the conference or if a voice operation is performed on the conference itself. In either case, this will cause each participant and conferenced voice operation to use one conference resource. True conferences also have a slightly increased latency over a hairpinned conference.

Returns:

the value.

setHairpin

public void setHairpin(java.lang.Boolean value)

Sets the value. Indicates that the new conference should be optimized for two parties. A hairpinned conference does not use any conference resources. However, a hairpin conference will be 'promoted', or converted to a true media conference, if a 3rd participant is added to the conference or if a voice operation is performed on the conference itself. In either case, this will cause each participant and conferenced voice operation to use one conference resource. True conferences also have a slightly increased latency over a hairpinned conference.

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.