|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CiscoCall
The CiscoCall
interface extends the CallControlCall interface with additional Cisco
Unified Communications Manager specific capabilities.
In Cisco Unified Communications Manager, every Call object comprises a set of call legs that share a common identifier: the global call handle. Connection objects represent call legs in JTAPI, and the Call object that relates a set of Connections contains the global call handle that the underlying call legs share.
The global call handle within a CiscoCall is accessible via its CallManagerID and CallID
properties. Taken together, the CallManagerID and CallID form the global call handle that Cisco
Unified Communications Manager maintains. Consider this pair of properties as guaranteed to be
unique among all ACTIVE
Call objects, but when an ACTIVE
call becomes
INACTIVE
, its CallManagerID and CallID may be reused to identify a newly created
Call object. Therefore, an INACTIVE
Call can have identical CallManagerID and CallID
properties to those of a currently ACTIVE
Call object.
Call
Field Summary | |
---|---|
static int |
CALLSECURITY_AUTHENTICATED
Call security status is authenticated. |
static int |
CALLSECURITY_ENCRYPTED
Call security status is encrypted. |
static int |
CALLSECURITY_NOTAUTHENTICATED
Call security status is not authenticated. |
static int |
CALLSECURITY_UNKNOWN
Call security status is unknown. |
static int |
CFWD_ALL_CLEAR
Call is created due to CFwdAll soft key press to clear CFA |
static int |
CFWD_ALL_NONE
Call is not created due to CFwdAll soft key press |
static int |
CFWD_ALL_SET
Call is created due to CFwdAll soft key pres to set CFA |
static int |
FEATUREPRIORITY_EMERGENCY
Feature priority is emergency |
static int |
FEATUREPRIORITY_NORMAL
Feature priority is normal |
static int |
FEATUREPRIORITY_URGENT
Feature priority is urgent |
static int |
PLAYTONE_BOTHLOCALANDREMOTE
A tone plays to both the caller and the monitor target (agent) when this option gets used. |
static int |
PLAYTONE_LOCALONLY
A tone plays only to the monitor target (agent) when this option gets used. |
static int |
PLAYTONE_NOLOCAL_OR_REMOTE
When this option is used no tone plays to the monitor target (agent) or the caller. |
static int |
PLAYTONE_REMOTEONLY
A tone plays only to the caller when this option gets used. |
static int |
SILENT_MONITOR
This option indicates that silent monitor is requested. |
static int |
WHISPER_MONITOR
This option indicates that whisper monitor is requested. |
Fields inherited from interface javax.telephony.Call |
---|
ACTIVE, IDLE, INVALID |
Method Summary | |
---|---|
void |
conference(javax.telephony.Call[] otherCalls)
This interface conferences multiple Calls together, resulting in the union of the participants of all the Calls being placed on a single Call. |
javax.telephony.Connection[] |
connect(javax.telephony.Terminal origterm,
javax.telephony.Address origaddr,
java.lang.String dialedDigits,
int featurePriority)
This method overloads Call.connect() method.It takes a new parameter featurePriority. |
boolean |
getCalledAddressPI()
Returns the Presentation Indicator(PI) that is associated with getCalledAddressPI. |
CiscoPartyInfo |
getCalledPartyInfo()
Returns the PartyInfo of the called party of the call. |
CiscoCallID |
getCallID()
CallID is a unique identifier among all ACTIVE calls with the same
CallManagerID. |
boolean |
getCallingAddressPI()
Returns the Presentation Indicator(PI) that is associated with getCallingAddressPI. |
int |
getCallSecurityStatus()
This interface returns the SecurityStatus of the Call. |
int |
getCFwdAllKeyPressIndicator()
Returns the CFwdAll key press indicator to distinguish if the call is created due to CallFwdAll key press or not. |
CiscoConferenceChain |
getConferenceChain()
This interface returns a CiscoConferenceChain object if this Call is a chained conference Call. |
javax.telephony.Address |
getCurrentCalledAddress()
Returns the current called Address for the call. |
boolean |
getCurrentCalledAddressPI()
Returns the Presentation Indicator(PI) that is associated with CurrentCalledAddress. |
boolean |
getCurrentCalledDisplayNamePI()
Returns the Presentation Indicator(PI) that is associated with getCurredCalledDisplayNamePI. |
java.lang.String |
getCurrentCalledPartyDisplayName()
This interface returns the display name of the called party in the call. |
CiscoPartyInfo |
getCurrentCalledPartyInfo()
Returns the PartyInfo of the current called party of the call. |
java.lang.String |
getCurrentCalledPartyUnicodeDisplayName()
Returns the Unicode display name of the called party in the call. |
int |
getCurrentCalledPartyUnicodeDisplayNamelocale()
Returns the locale of the current called party Unicode display name. |
javax.telephony.Terminal |
getCurrentCalledTerminal()
Returns the Terminal object representing the device of the current called party. |
javax.telephony.Address |
getCurrentCallingAddress()
Returns the current calling Address for the call. |
boolean |
getCurrentCallingAddressPI()
Returns the Presentation Indicator(PI) that is associated with getCurrentCallingAddressPI. |
boolean |
getCurrentCallingDisplayNamePI()
Returns the Presentation Indicator(PI) that is associated with getCurrentCalledDisplayNamePI. |
java.lang.String |
getCurrentCallingPartyDisplayName()
This interface returns the display name of the calling party. |
CiscoPartyInfo |
getCurrentCallingPartyInfo()
Returns the PartyInfo of the current calling party of the call. |
java.lang.String |
getCurrentCallingPartyUnicodeDisplayName()
Returns the Unicode display name of the calling party in the call. |
int |
getCurrentCallingPartyUnicodeDisplayNamelocale()
Returns the locale of the current called party Unicode display name. |
javax.telephony.Terminal |
getCurrentCallingTerminal()
Returns the Terminal object representing the device of the current calling
party. |
java.lang.String |
getGlobalizedCallingParty()
This will return the globalizedCallingParty |
CiscoPartyInfo |
getLastRedirectedPartyInfo()
Returns the PartyInfo of the last redirecting party of the call. |
boolean |
getLastRedirectingAddressPI()
Returns the Presentation Indicator(PI) that is associated with getLastRedirectingAddressPI. |
CiscoPartyInfo |
getLastRedirectingPartyInfo()
Deprecated. - use getLastRedirectedPartyInfo(); |
javax.telephony.Address |
getModifiedCalledAddress()
This interface returns the modified called Address for the call if called party is modified by using called party transformation pattern or other means. |
javax.telephony.Address |
getModifiedCallingAddress()
This interface returns the modified calling Address for the call if an application modifies its calling party by using the selectRoute API or other means. |
boolean |
isConference()
Checks if this call is a conference call or not. |
javax.telephony.Connection[] |
startMonitor(javax.telephony.Terminal monitorInitiatorTerminal,
javax.telephony.Address monitorInitiatorAddress,
int monitorTargetCallId,
java.lang.String monitorTargetDN,
java.lang.String monitorTargetTerminalName,
int monitorType,
int playToneDirection)
If the application has the information about the call at the monitor target, the application can use this interface to monitor calls. |
javax.telephony.Connection[] |
startMonitor(javax.telephony.Terminal monitorInitiatorTerminal,
javax.telephony.Address monitorInitiatorAddress,
javax.telephony.TerminalConnection termConnofMonitorTarget,
int monitorType,
int playToneDirection)
If the application is observing the monitor target (agent) Address, the application can use the Terminal connection of the monitor target (agent) to initiate a monitor request. |
javax.telephony.Connection |
transfer(java.lang.String address,
java.lang.String facCode,
java.lang.String cmcCode)
This method is similar to the CallControlCall.transfer(String address) interface
except that it also takes facCode (Forced Authorization Code) and cmcCode (Client Matter
Code) if the transfer Address requires these codes to offer the call. |
Methods inherited from interface javax.telephony.callcontrol.CallControlCall |
---|
addParty, conference, consult, consult, drop, getCalledAddress, getCallingAddress, getCallingTerminal, getConferenceController, getConferenceEnable, getLastRedirectedAddress, getTransferController, getTransferEnable, offHook, setConferenceController, setConferenceEnable, setTransferController, setTransferEnable, transfer, transfer |
Methods inherited from interface javax.telephony.Call |
---|
addObserver, connect, getCallCapabilities, getCapabilities, getConnections, getObservers, getProvider, getState, removeObserver |
Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer |
---|
getObject, setObject |
Field Detail |
---|
static final int FEATUREPRIORITY_NORMAL
static final int FEATUREPRIORITY_URGENT
static final int FEATUREPRIORITY_EMERGENCY
static final int PLAYTONE_NOLOCAL_OR_REMOTE
static final int PLAYTONE_LOCALONLY
static final int PLAYTONE_REMOTEONLY
static final int PLAYTONE_BOTHLOCALANDREMOTE
static final int SILENT_MONITOR
static final int WHISPER_MONITOR
static final int CALLSECURITY_UNKNOWN
static final int CALLSECURITY_NOTAUTHENTICATED
static final int CALLSECURITY_AUTHENTICATED
static final int CALLSECURITY_ENCRYPTED
static final int CFWD_ALL_NONE
static final int CFWD_ALL_SET
static final int CFWD_ALL_CLEAR
Method Detail |
---|
javax.telephony.Connection[] connect(javax.telephony.Terminal origterm, javax.telephony.Address origaddr, java.lang.String dialedDigits, int featurePriority) throws javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidPartyException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
CiscoCall.FEATUREPRIORITY_NORMAL
CiscoCall.FEATUREPRIORITY_URGENT
CiscoCall.FEATUREPRIORITY_EMERGENCY
origterm
- origaddr
- dialedDigits
- featurePriority
-
javax.telephony.ResourceUnavailableException
javax.telephony.PrivilegeViolationException
javax.telephony.InvalidPartyException
javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException
CiscoCallID getCallID()
ACTIVE
calls with the same
CallManagerID.
javax.telephony.Address getCurrentCalledAddress()
NOTE: In the CiscoJtapi implementation,
CallControlCall.getCalledAddress()
returns the first called party of the call:
the original called party.
if (call instanceof CiscoCall) { Address currentCalled = ((CiscoCall) call).getCurrentCalledAddress(); }
CallControlCall
javax.telephony.Address getCurrentCallingAddress()
NOTE: In the CiscoJtapi implementation,
CallControlCall.getCallingAddress()
returns the first calling party of the call:
the original calling party.
if (call instanceof CiscoCall) { Address currentCalling = ((CiscoCall) call).getCurrentCallingAddress(); }
CallControlCall
javax.telephony.Address getModifiedCallingAddress()
Usage:
if (call instanceof CiscoCall) { Address modifiedCalling = ((CiscoCall) call).getModifiedCallingAddress(); }
CallControlCall
javax.telephony.Address getModifiedCalledAddress()
Usage:
if (call instanceof CiscoCall) { Address modifiedCalled = ((CiscoCall) call).getModifiedCalledAddress(); }
CallControlCall
java.lang.String getCurrentCalledPartyDisplayName()
java.lang.String getCurrentCallingPartyDisplayName()
void conference(javax.telephony.Call[] otherCalls) throws javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException, javax.telephony.MethodNotSupportedException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException
CallControlTerminalConnection.TALKING
state, and hence, the TerminalConnection
on the secondary Call should be in the CallControlTerminalConnection.HELD
state.
As a result of invokation of this method, all the conference controller TerminalConnection
merge into one TerminalConnection.
Applications can set which Terminal would acts as the conference controller when a conference
call gets set up by setting up Conference controller TerminalConnection via invoking
CallControlCalll.setConferenceController()
method. The
CalControlCall.getConferenceController()
method returns the current conference
controller, or null
if there is none. If no conference controller is set
initially, the implementation chooses a suitable TerminalConnection when the conferencing
feature is invoked.
Call.INVALID
state.
Pre-conditions:
Post-conditions:
otherCalls
- The Other Calls which are to be merged with this Call object.
javax.telephony.InvalidArgumentException
- The Call object that is provided is not valid for the conference.
javax.telephony.InvalidStateException
- Thismeans that the Provider is not "in service," the Call is not "active," or
the conference controllers are not in the proper state.
javax.telephony.MethodNotSupportedException
- The implementation does not support this method.
javax.telephony.PrivilegeViolationException
- The application does not have the proper authority to invoke this method.
javax.telephony.ResourceUnavailableException
- This means that an internal resource that is necessary for the successful
invocation of this method is not available.ConnCreatedEv
,
TermConnCreatedEv
,
ConnDisconnectedEv
,
TermConnDroppedEv
,
CallInvalidEv
,
CallCtlConnDisconnectedEv
,
CallCtlTermConnDroppedEv
javax.telephony.Connection transfer(java.lang.String address, java.lang.String facCode, java.lang.String cmcCode) throws javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.InvalidPartyException, javax.telephony.MethodNotSupportedException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException
CallControlCall.transfer(String address)
interface
except that it also takes facCode (Forced Authorization Code) and cmcCode (Client Matter
Code) if the transfer Address requires these codes to offer the call. If only one of the
codes is required, the other code may need to be a null value.
If the user enters no codes, or invalid codes, the call may not be offered and platformException may contain the following error codes:
CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_NEEDED
CiscoJTAPIException.CTIERR_FAC_CMC_REASON_CMC_NEEDED
CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED
CiscoJTAPIException.CTIERR_FAC_CMC_REASON_FAC_INVALID
CiscoJTAPIException.CTIERR_FAC_CMC_REASON_CMC_INVALID
This overloaded version of this method transfers all participants currently on this Call, with the exception of the transfer controller participant, to another Address. This is often called a "single-step transfer" because the transfer feature places another call and performs the transfer simultaneously. The Address string argument to this method must be valid and complete.
CallControlTerminalConnection.TALKING
state.
Applications may control which TerminalConnection acts as the transfer controller via the
CallControlCall.setTransferController()
method. The
CallControlCall.getTransferController()
method returns the current transfer
controller, or null
if there is none. If no transfer controller is set, the
implementation chooses a suitable TerminalConnection when the transfer feature gets invoked.
When the transfer feature gets invoked, the transfer controller moves into the
CallControlTerminalConnection.DROPPED
state. If it is the only
TerminalConnection associated with its Connection, then its Connection moves into the
CallControlConnection.DISCONNECTED
state as well.
null
if the Call
has been transferred outside of the Provider domain and can no longer be tracked. This
Connection must at least be in the CallControlConnection.IDLE
state. The
Connection state may have progressed beyond "idle" before this method returns, and should be
reflected by an event. This new Connection will progress as any normal destination Connection
on a call. Typical scenarios for this Connection are described by the
Call.connect()
method.
Pre-conditions:
address
- The destination Address string(dialedDigits) to which the Call is being
transferred.facCode
- The Force Authorization CodecmcCode
- The Client Matter Code
javax.telephony.InvalidArgumentException
- The TerminalConnection provided as controlling the transfer is not valid or
not part of this Call.
javax.telephony.InvalidStateException
- This means that the Provider is not "in service," the Call is not "active," or
the transfer controller is not "talking."
javax.telephony.InvalidPartyException
- The destination Address is not valid or complete.
javax.telephony.MethodNotSupportedException
- The implementation does not support this method.
javax.telephony.PrivilegeViolationException
- The application does not have the proper authority to invoke this method.
javax.telephony.ResourceUnavailableException
- An internal resource necessary for the successful invocation of this method is
unavailable.ConnCreatedEv
,
ConnDisconnectedEv
,
TermConnDroppedEv
,
CallCtlConnDisconnectedEv
,
CallCtlTermConnDroppedEv
boolean getCurrentCalledAddressPI()
boolean getCurrentCalledDisplayNamePI()
boolean getCurrentCallingAddressPI()
boolean getCurrentCallingDisplayNamePI()
boolean getLastRedirectingAddressPI()
boolean getCalledAddressPI()
boolean getCallingAddressPI()
java.lang.String getCurrentCalledPartyUnicodeDisplayName()
int getCurrentCalledPartyUnicodeDisplayNamelocale()
java.lang.String getCurrentCallingPartyUnicodeDisplayName()
int getCurrentCallingPartyUnicodeDisplayNamelocale()
CiscoPartyInfo getCurrentCallingPartyInfo()
CiscoPartyInfo getCurrentCalledPartyInfo()
CiscoPartyInfo getLastRedirectingPartyInfo()
CiscoPartyInfo getLastRedirectedPartyInfo()
CiscoPartyInfo getCalledPartyInfo()
javax.telephony.Connection[] startMonitor(javax.telephony.Terminal monitorInitiatorTerminal, javax.telephony.Address monitorInitiatorAddress, javax.telephony.TerminalConnection termConnofMonitorTarget, int monitorType, int playToneDirection) throws javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidPartyException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
Pre-Conditions:
(this.getProvider()).getState() == Provider.IN_SERVICE this.getState() == Call.IDLE ((CiscoProviderCapabilities)(this.getTerminal().getProvider().getProviderCapabilities()).canMonitor() == TRUE TerminalConnection.getProvider() == this.getProvider()
monitorInitiatorTerminal
- - The originating TerminalmonitorInitiatorAddress
- - The originating AddresstermConnofMonitorTarget
- - The TerminalConnection of the targetmonitorType
- - The type of monitor. Use CiscoCall.SILENT_MONITOR or CiscoCall.WHISPER_MONITOR.playToneDirection
- - Indicates whether the tone needs to be played to the target, the initiator, or
both. This should be one of CiscoCall.PLAYTONE_NOLOCAL_OR_REMOTE,
CiscoCall.PLAYTONE_LOCALONLY, CiscoCall.PLAYTONE_REMOTEONLY, or
CiscoCall.PLAYTONE_BOTHLOCALANDREMOTE
javax.telephony.ResourceUnavailableException
javax.telephony.PrivilegeViolationException
javax.telephony.InvalidPartyException
javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException
javax.telephony.Connection[] startMonitor(javax.telephony.Terminal monitorInitiatorTerminal, javax.telephony.Address monitorInitiatorAddress, int monitorTargetCallId, java.lang.String monitorTargetDN, java.lang.String monitorTargetTerminalName, int monitorType, int playToneDirection) throws javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidPartyException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
Pre-Conditions:
(this.getProvider()).getState() == Provider.IN_SERVICE this.getState() == Call.IDLE ((CiscoProviderCapabilities)(this.getTerminal().getProvider().getProviderCapabilities()).canMonitor() == TRUE
monitorInitiatorTerminal
- - The originating TerminalmonitorInitiatorAddress
- - The originating AddressmonitorTargetCallId
- - The callLegID of the call at the target. Assuming one call at monitor target
Address (targetAddress), callLegID =
targetAddress.getConnection().getConnectionID().intValue();monitorTargetDN
- - The DN of the monitor targetmonitorTargetTerminalName
- - The Terminal name of the monitor targetmonitorType
- - The type of monitor. Use CiscoCall.SILENT_MONITOR or CiscoCall.WHISPER_MONITOR.playToneDirection
- - Indicates whether the tone needs to be played to the target, to the caller, or
both
javax.telephony.ResourceUnavailableException
javax.telephony.PrivilegeViolationException
javax.telephony.InvalidPartyException
javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException
CiscoConferenceChain getConferenceChain()
int getCallSecurityStatus()
java.lang.String getGlobalizedCallingParty()
boolean isConference()
javax.telephony.Terminal getCurrentCallingTerminal()
Terminal
object representing the device of the current calling
party.
javax.telephony.Terminal getCurrentCalledTerminal()
Terminal
object representing the device of the current called party.
This WILL NOT BE SET until the called party ANSWERS the call.
int getCFwdAllKeyPressIndicator()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |