|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CiscoTerminalConnection
CiscoTerminalConnection
interface extends the
CallControlTerminalConnection interface with additional capabilities.
Applications can use the getReason
method to obtain the reason for the creation of
this Connection.
Field Summary | |
---|---|
static int |
CISCO_SELECTEDLOCAL
The call is selected. |
static int |
CISCO_SELECTEDNONE
The the call is not selected. |
static int |
CISCO_SELECTEDREMOTE
A passive TerminalConnection receives this select status if the call is selected by its shared line. |
static int |
RECORDING_INVOCATION_TYPE_SILENT
If used when invoking startRecording, there will be no indication to the phone that recording is in progress. |
static int |
RECORDING_INVOCATION_TYPE_USER
If used when invoking startRecording, the phone will display a notice that recording was invoked by the user. |
Fields inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection |
---|
BRIDGED, DROPPED, HELD, IDLE, INUSE, RINGING, TALKING, UNKNOWN |
Fields inherited from interface javax.telephony.TerminalConnection |
---|
ACTIVE, PASSIVE |
Method Summary | |
---|---|
void |
addMediaStream(java.lang.String streamDN,
java.lang.String callingPartyNumber)
Adds a Media Stream to this call, using the CiscoTerminalConnection object
that invoked this API. |
CiscoMonitorInitiatorInfo |
getCiscoMonitorInitiatorInfo()
Returns CiscoMonitorInitiatorInfo. |
CiscoMonitorTargetInfo |
getCiscoMonitorTargetInfo()
Returns CiscoMonitorTargetInfo. |
CiscoRecorderInfo |
getCiscoRecorderInfo()
Returns CiscoRecorderInfo, which exposes the terminal name and address of the recorder. |
boolean |
getPrivacyStatus()
Returns the privacy status of the call on the terminal. |
int |
getSelectStatus()
Returns the select status of the call on the terminal. |
void |
playTone(int toneType,
int toneDirection)
This interface plays the specified tone to the specified party |
void |
removeMediaStream()
Removes an active Media Stream from this call. |
void |
startRecording(int playToneDirection)
Deprecated. Applications should move to the new method, startRecording(playToneDirection, invocationType) |
void |
startRecording(int playToneDirection,
int invocationType)
Starts recording a call. |
void |
stopRecording(int invocationType)
Stops recording a call. |
void |
updateMonitorType(int monitorType,
int toneDirection)
Updates the monitorType of current monitoring session. |
Methods inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection |
---|
getCallControlState, hold, join, leave, unhold |
Methods inherited from interface javax.telephony.TerminalConnection |
---|
answer, getCapabilities, getConnection, getState, getTerminal, getTerminalConnectionCapabilities |
Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer |
---|
getObject, setObject |
Field Detail |
---|
static final int CISCO_SELECTEDNONE
static final int CISCO_SELECTEDLOCAL
static final int CISCO_SELECTEDREMOTE
static final int RECORDING_INVOCATION_TYPE_SILENT
static final int RECORDING_INVOCATION_TYPE_USER
Method Detail |
---|
boolean getPrivacyStatus()
int getSelectStatus()
void startRecording(int playToneDirection) throws javax.telephony.InvalidStateException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException, javax.telephony.InvalidArgumentException
Pre-conditions
((this.getTerminal()).getProvider()).getState() == Provider.IN_SERVICE this.getCallControlState() == CallControlTerminalConnection.TALKING ((CiscoProviderCapabilities)(this.getTerminal().getProvider().getProviderCapabilities()).canRecord() == TRUE this.getConnection().getAddress().getRecordingConfig(this.getTerminal()) == CiscoAddress.APPLICATION_CONTROLLED__RECORDING
playToneDirection
- Specifies whether to play a tone. Valid values are:
javax.telephony.InvalidStateException
- Either the Provider was not "in service" or the TerminalConnection is not in the
"TALKING" state.
javax.telephony.PrivilegeViolationException
- The application does not have the proper authority to invoke this method.
javax.telephony.ResourceUnavailableException
- An internal resource that this method requires is not available.
javax.telephony.InvalidArgumentException
- The value for playToneDirection is not valid.void startRecording(int playToneDirection, int invocationType) throws javax.telephony.InvalidStateException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException, javax.telephony.InvalidArgumentException
Pre-conditions
((this.getTerminal()).getProvider()).getState() == Provider.IN_SERVICE this.getCallControlState() == CallControlTerminalConnection.TALKING ((CiscoProviderCapabilities)(this.getTerminal().getProvider().getProviderCapabilities()).canRecord() == TRUE this.getConnection().getAddress().getRecordingConfig(this.getTerminal()) == CiscoAddress.SELECTIVE_RECORDING
playToneDirection
- Specifies whether to play a tone. Valid values are:
invocationType
- Specifies the requested invocation type for the recording. Valid values are:
javax.telephony.InvalidStateException
- Either the Provider was not "in service" or the TerminalConnection is not in the
"TALKING" state.
javax.telephony.PrivilegeViolationException
- The application does not have the proper authority to invoke this method.
javax.telephony.ResourceUnavailableException
- An internal resource that this method requires is not available.
javax.telephony.InvalidArgumentException
- The value for playToneDirection or invocationType is not valid.void stopRecording(int invocationType) throws javax.telephony.InvalidArgumentException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidStateException
invocationType
- Specifies the requested invocation type for the stop request This much match the type that was used to start the recording. Valid values are:
javax.telephony.PrivilegeViolationException
- The application does not have the proper authority to invoke this method.
javax.telephony.InvalidArgumentException
- The value for invocationType is not valid.
javax.telephony.InvalidStateException
- The internal Call Handle is invalid, or Recording Session Inactive, or No Recording Session Exists, or Pending Recording Stop Request,CiscoRecorderInfo getCiscoRecorderInfo()
CiscoMonitorInitiatorInfo getCiscoMonitorInitiatorInfo()
CiscoMonitorTargetInfo getCiscoMonitorTargetInfo()
void addMediaStream(java.lang.String streamDN, java.lang.String callingPartyNumber) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.ResourceUnavailableException, javax.telephony.InvalidArgumentException
CiscoTerminalConnection
object
that invoked this API. A second, background call will be placed to the DN specified by
the streamDN parameter, and this call will be mixed into the invoking
CiscoTerminalConnection
's Built-In-Bridge.
streamDN
- A String
object representing the DN of the endpoint that will be
streaming media to this call. This is usually an IVR or CTI Port.callingPartyNumber
- A String
object representing information that will be shown as
the calling party number to the streamDN when the call is initially offered to it.
javax.telephony.PlatformException
- if the addMediaStream request takes too long and times out.
javax.telephony.InvalidStateException
- if the state of the Call or CiscoTerminalConnection
is not valid for a Media Stream to be added.
javax.telephony.ResourceUnavailableException
- when the BIB resource of the invoking device cannot be allocated.
javax.telephony.InvalidArgumentException
- when the streamDN is nullvoid removeMediaStream() throws javax.telephony.InvalidStateException, javax.telephony.ResourceUnavailableException
javax.telephony.InvalidStateException
- if the state of the Call or CiscoTerminalConnection
is not valid for a Media Stream to be removed.
javax.telephony.ResourceUnavailableException
- when the BIB resource of the invoking device cannot be allocated.void updateMonitorType(int monitorType, int toneDirection) throws javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidPartyException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException
monitorType
- - Specifies the mode in which application wants monitoring to transition. Valid
values are:
toneDirection
- Specifies where to play a tone. Valid values are:
javax.telephony.ResourceUnavailableException
- - An internal resource that this method requires is not available.
javax.telephony.PrivilegeViolationException
- - The application does not have the proper authority to invoke this method.
javax.telephony.InvalidPartyException
- - Request is invoked on incorrect TerminalConnection.
javax.telephony.InvalidArgumentException
- - The value for one or more parameters is not correct.
javax.telephony.InvalidStateException
- - The state is not correct to invoke this method. TerminalConnection may not be
in TALKING state or media is not established.void playTone(int toneType, int toneDirection) throws javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException, javax.telephony.PlatformException
toneType
- - can be one of supported tones from CiscoTonetoneDirection
- - can be either CiscoCall.PLAYTONE_LOCALONLY or CiscoCall.PLAYTONE_REMOTEONLY.
javax.telephony.InvalidStateException
javax.telephony.InvalidArgumentException
javax.telephony.PlatformException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |