Cisco JTAPI Developer Guide for Cisco CallManager 3.3(3)
Cisco JTAPI Implementation
Downloads: This chapterpdf (PDF - 1.74MB) The complete bookPDF (PDF - 6.9MB) | Feedback

Cisco JTAPI Implementation

Table Of Contents

Cisco JTAPI Implementation

Cisco JTAPI Extensions Hierarchy

Class Hierarchy

Interface Hierarchy

Class com.cisco.jtapi.extensions

CiscoAddrCreatedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddress

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddressCallInfo

Declaration

Constructors

Methods

CiscoAddressObserver

Declaration

All Superinterfaces

Description

CiscoAddrEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoAddrInServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoAddrOutOfServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoAddrRemovedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoCall

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Methods

CiscoCallEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Fields

Methods

CiscoCallID

Declaration

All Superinterfaces

Description

Methods

CiscoConferenceEndEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoConferenceStartEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoConnection

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoConnectionID

Declaration

All Superinterfaces

Description

Methods

CiscoConsultCall

Declaration

All Superinterfaces

Description

Methods

CiscoConsultCallActiveEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoG711MediaCapability

Declaration

Description

Fields

Constructors

CiscoG723MediaCapability

Declaration

Description

Fields

Constructors

Methods

CiscoG729MediaCapability

Declaration

Description

Fields

Constructors

CiscoGSMMediaCapability

Declaration

Description

Fields

Constructors

CiscoJtapiException

Declaration

Description

Fields

Methods

CiscoJtapiPeer

Declaration

All Superinterfaces

Description

Methods

CiscoJtapiProperties

Declaration

Description

Methods

CiscoJtapiVersion

Declaration

Description

Constructors

Methods

CiscoMediaCapability

Declaration

Direct Known Subclasses

Description

Fields

Constructors

Methods

CiscoMediaTerminal

Declaration

All Superinterfaces

Description

Methods

CiscoObjectContainer

Declaration

All Known Subinterfaces

Description

Methods

CiscoOutOfServiceEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Fields

CiscoProvCallParkEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoProvEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoProvFeatureEv

Declaration

All Superinterfaces

All Known Subinterfaces

Methods

CiscoProvFeatureID

Declaration

Fields

CiscoProvFeatureUnRegisteredEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoProvider

Declaration

All Superinterfaces

Description

Methods

CiscoProviderCapabilities

Declaration

All Superinterfaces

Description

CiscoProviderObserver

Declaration

All Superinterfaces

Description

CiscoRegistrationException

Declaration

All Implemented Interfaces

Description

Constructors

CiscoRouteAddress

Declaration

All Superinterfaces

Methods

CiscoRouteSession

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPBitRate

Declaration

Description

Fields

CiscoRTPInputProperties

Declaration

Description

Methods

CiscoRTPInputStartedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPInputStoppedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPOutputProperties

Declaration

Description

Methods

CiscoRTPOutputStartedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPOutputStoppedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPParams

Declaration

Constructors

Methods

CiscoRTPPayload

Declaration

Description

Fields

CiscoSynchronousObserver

Declaration

Description

CiscoTermCreatedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermDataEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoTerminal

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Fields

Methods

CiscoTerminalConnection

Declaration

All Superinterfaces

Description

CiscoTerminalObserver

Declaration

All Superinterfaces:

Description

CiscoTermInServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoTermOutOfServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoTermRemovedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTransferEndEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTransferStartEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoUnregistrationException

Declaration

All Implemented Interfaces

Description

Constructors

Class com.cisco.services.alarm

Alarm

Declaration

All Known Implementing Classes

Description

Fields

Methods

AlarmManager

Declaration

Description

Constructors

Methods

AlarmWriter

Declaration

All Known Implementing Classes

Description

Methods

DefaultAlarm

Declaration

All Implemented Interfaces

Description

Constructors

Methods

DefaultAlarmWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

ParameterList

Declaration

Description

Constructors

Methods

Class com.cisco.services.tracing

BaseTraceWriter

Declaration

All Implemented Interfaces

Direct Known Subclasses

Description

Constructors

Methods

ConditionalTrace

Declaration

All Superinterfaces

Description

Methods

ConsoleTraceWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

LogFileTraceWriter

Declaration

All Implemented Interfaces

Description

Fields

Constructors

Methods

OutputStreamTraceWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

SyslogTraceWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

Trace

Declaration

All Known Subinterfaces

Description

Fields

Methods

TraceManager

Declaration

Description

Methods

TraceManagerFactory

Declaration

Description

Methods

TraceModule

Declaration

All Known Subinterfaces

Description

Methods

TraceWriter

Declaration

All Known Subinterfaces

All Known Implementing Classes

Description

Methods

TraceWriterManager

Declaration

All Superinterfaces

Description

Methods

UnconditionalTrace

Declaration

All Superinterfaces

Description


Cisco JTAPI Implementation


Cisco JTAPI Implementation describes interfaces and classes available. To create new applications, use these interfaces and classes with the standard JTAPI interfaces and classes described in the Cisco JTAPI v 1.2.

This chapter contains the following sections:

Cisco JTAPI Extensions Hierarchy

Class com.cisco.jtapi.extensions

Class com.cisco.services.alarm

Class com.cisco.services.tracing

Cisco JTAPI Extensions Hierarchy

Class Hierarchy

class java.lang.Object

class com.cisco.services.alarm.AlarmManager

class com.cisco.services.tracing.BaseTraceWriter (implements com.cisco.services.tracing.TraceWriter)

class com.cisco.services.tracing.ConsoleTraceWriter

class com.cisco.services.tracing.LogFileTraceWriter

class com.cisco.services.tracing.OutputStreamTraceWriter

class com.cisco.services.tracing.SyslogTraceWriter

class com.cisco.jtapi.extensions.CiscoAddressCallInfo

class com.cisco.jtapi.extensions.CiscoJtapiVersion

class com.cisco.jtapi.extensions.CiscoMediaCapability

class com.cisco.jtapi.extensions.CiscoG711MediaCapability

class com.cisco.jtapi.extensions.CiscoG723MediaCapability

class com.cisco.jtapi.extensions.CiscoG729MediaCapability

class com.cisco.jtapi.extensions.CiscoGSMMediaCapability

class com.cisco.jtapi.extensions.CiscoRTPParams

class com.cisco.services.alarm.DefaultAlarm (implements com.cisco.services.alarm.Alarm)

class com.cisco.services.alarm.DefaultAlarmWriter (implements com.cisco.services.alarm.AlarmWriter)

class com.cisco.services.alarm.ParameterList

class java.lang.Throwable (implements java.io.Serializable)

class java.lang.Exception

class com.cisco.jtapi.extensions.CiscoRegistrationException

class com.cisco.jtapi.extensions.CiscoUnregistrationException

class com.cisco.services.tracing.TraceManagerFactory

Interface Hierarchy

interface javax.telephony.Address

interface com.cisco.jtapi.extensions.CiscoAddress (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.callcenter.RouteAddress

interface com.cisco.jtapi.extensions.CiscoRouteAddress

interface javax.telephony.AddressObserver

interface com.cisco.jtapi.extensions.CiscoAddressObserver

interface com.cisco.services.alarm.Alarm

interface com.cisco.services.alarm.AlarmWriter

interface javax.telephony.Call

interface javax.telephony.callcontrol.CallControlCall

interface com.cisco.jtapi.extensions.CiscoCall (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface com.cisco.jtapi.extensions.CiscoConsultCall

interface com.cisco.jtapi.extensions.CiscoJtapiException

interface com.cisco.jtapi.extensions.CiscoJtapiProperties

interface com.cisco.jtapi.extensions.CiscoObjectContainer

interface com.cisco.jtapi.extensions.CiscoAddress (also extends javax.telephony.Address)

interface com.cisco.jtapi.extensions.CiscoCall (also extends javax.telephony.callcontrol.CallControlCall)

interface com.cisco.jtapi.extensions.CiscoConsultCall

interface com.cisco.jtapi.extensions.CiscoCallID

interface com.cisco.jtapi.extensions.CiscoConnection (also extends javax.telephony.callcontrol.CallControlConnection)

interface com.cisco.jtapi.extensions.CiscoConnectionID

interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModule)

interface com.cisco.jtapi.extensions.CiscoProvider (also extends javax.telephony.Provider)

interface com.cisco.jtapi.extensions.CiscoTerminal (also extends javax.telephony.Terminal)

interface com.cisco.jtapi.extensions.CiscoMediaTerminal

interface com.cisco.jtapi.extensions.CiscoTerminalConnection (also extends javax.telephony.callcontrol.CallControlTerminalConnection)

interface com.cisco.jtapi.extensions.CiscoProvFeatureID

interface com.cisco.jtapi.extensions.CiscoRTPBitRate

interface com.cisco.jtapi.extensions.CiscoRTPInputProperties

interface com.cisco.jtapi.extensions.CiscoRTPOutputProperties

interface com.cisco.jtapi.extensions.CiscoRTPPayload

interface com.cisco.jtapi.extensions.CiscoSynchronousObserver

interface javax.telephony.Connection

interface javax.telephony.callcontrol.CallControlConnection

interface com.cisco.jtapi.extensions.CiscoConnection (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.events.Ev

interface javax.telephony.events.AddrEv

interface com.cisco.jtapi.extensions.CiscoAddrEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv

interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface javax.telephony.events.CallEv

interface javax.telephony.events.CallActiveEv

interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends com.cisco.jtapi.extensions.CiscoCallEv)

interface com.cisco.jtapi.extensions.CiscoCallEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoConferenceEndEv

interface com.cisco.jtapi.extensions.CiscoConferenceStartEv

interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends javax.telephony.events.CallActiveEv)

interface com.cisco.jtapi.extensions.CiscoTransferEndEv

interface com.cisco.jtapi.extensions.CiscoTransferStartEv

interface com.cisco.jtapi.extensions.CiscoEv

interface com.cisco.jtapi.extensions.CiscoAddrEv (also extends javax.telephony.events.AddrEv)

interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv

interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface com.cisco.jtapi.extensions.CiscoCallEv (also extends javax.telephony.events.CallEv)

interface com.cisco.jtapi.extensions.CiscoConferenceEndEv

interface com.cisco.jtapi.extensions.CiscoConferenceStartEv

interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends javax.telephony.events.CallActiveEv)

interface com.cisco.jtapi.extensions.CiscoTransferEndEv

interface com.cisco.jtapi.extensions.CiscoTransferStartEv

interface com.cisco.jtapi.extensions.CiscoOutOfServiceEv

interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoAddrEv)

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoTermEv)

interface com.cisco.jtapi.extensions.CiscoProvEv (also extends javax.telephony.events.ProvEv)

interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv

interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureEv

interface com.cisco.jtapi.extensions.CiscoProvCallParkEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv

interface com.cisco.jtapi.extensions.CiscoTermCreatedEv

interface com.cisco.jtapi.extensions.CiscoTermRemovedEv

interface com.cisco.jtapi.extensions.CiscoTermEv (also extends javax.telephony.events.TermEv)

interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv

interface com.cisco.jtapi.extensions.CiscoTermDataEv

interface com.cisco.jtapi.extensions.CiscoTermInServiceEv

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface javax.telephony.events.ProvEv

interface com.cisco.jtapi.extensions.CiscoProvEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv

interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureEv

interface com.cisco.jtapi.extensions.CiscoProvCallParkEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv

interface com.cisco.jtapi.extensions.CiscoTermCreatedEv

interface com.cisco.jtapi.extensions.CiscoTermRemovedEv

interface javax.telephony.events.TermEv

interface com.cisco.jtapi.extensions.CiscoTermEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv

interface com.cisco.jtapi.extensions.CiscoTermDataEv

interface com.cisco.jtapi.extensions.CiscoTermInServiceEv

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface javax.telephony.JtapiPeer

interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends com.cisco.jtapi.extensions.CiscoObjectContainer, com.cisco.services.tracing.TraceModule)

interface javax.telephony.Provider

interface com.cisco.jtapi.extensions.CiscoProvider (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.capabilities.ProviderCapabilities

interface com.cisco.jtapi.extensions.CiscoProviderCapabilities

interface javax.telephony.ProviderObserver

interface com.cisco.jtapi.extensions.CiscoProviderObserver

interface javax.telephony.callcenter.RouteSession

interface com.cisco.jtapi.extensions.CiscoRouteSession

interface javax.telephony.Terminal

interface com.cisco.jtapi.extensions.CiscoTerminal (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface com.cisco.jtapi.extensions.CiscoMediaTerminal

interface javax.telephony.TerminalConnection

interface javax.telephony.callcontrol.CallControlTerminalConnection

interface com.cisco.jtapi.extensions.CiscoTerminalConnection (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.TerminalObserver

interface com.cisco.jtapi.extensions.CiscoTerminalObserver

interface com.cisco.services.tracing.Trace

interface com.cisco.services.tracing.ConditionalTrace

interface com.cisco.services.tracing.UnconditionalTrace

interface com.cisco.services.tracing.TraceManager

interface com.cisco.services.tracing.TraceModule

interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends com.cisco.jtapi.extensions.CiscoObjectContainer, javax.telephony.JtapiPeer)

interface com.cisco.services.tracing.TraceWriter

interface com.cisco.services.tracing.TraceWriterManager

Class com.cisco.jtapi.extensions

The Cisco JTAPI extension consists of a set of classes and interfaces that expose the functionality available in the Cisco IP Telephony. This API allows programmers to create independent applications for Cisco CallManager. The Cisco JTAPI implementation offers additional functionality not readily exposed through the JTAPI 1.2 interfaces. Applications can use the interfaces and classes in the com.cisco.jtapi.extensions package with the standard JTAPI interfaces and classes described in the Cisco JTAPI v 1.2 Specification manual to create new applications.

CiscoAddrCreatedEv

Declaration

public interface CiscoAddrCreatedEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoAddrCreatedEv event

Member Summary
Fields
static int
ID
Methods
javax.telephony.Address

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getAddress()

public javax.telephony.Address getAddress()

CiscoAddress

Declaration

public interface CiscoAddress extends javax.telephony.Address, CiscoObjectContainer

All Superinterfaces

javax.telephony.Address, CiscoObjectContainer

Description

The CiscoAddress interface extends the Address interface with additional CallManager-specific capabilities.

See Also

javax.telephony.Address

Member Summary
Fields
static int
This is an external address with a valid name.
static int
This is an external address with an unknown name.
static int
The address is out-of-service
static int
This is an internal address.
static int
The address is in-service
static int
Sets the ringer status to configured value
static int
Disables the ringer for the address
static int
Enables the ringer for the address
static int
This is an external address with an unknown name.
Methods
void
Use this interface to clear off any phantom calls on the address
CiscoAddressCallInfo
Use this Interface to get info of calls present at the terminal
int
Returns the state of this address.
int
Returns the state of this address.
int
Returns the type of this address.
void
Specifies whether the message-waiting indicator should be activated or deactivated for the Address specified by the destination.
void
changes the ringer status on this address

Inherited Member Summary
Methods inherited from interface Address
addCallObserver(CallObserver), addObserver(AddressObserver), getAddressCapabilities(Terminal), getCallObservers(), getCapabilities(), getConnections(), getName(), getObservers(), getProvider(), getTerminals(), removeCallObserver(CallObserver), removeObserver(AddressObserver)
Methods inherited from interface CiscoObjectContainer

Fields

EXTERNAL

public static final int EXTERNAL
This is an external address with a valid name. An address of this type is created when ANI or callerID is available on the call.

EXTERNAL_UNKNOWN

public static final int EXTERNAL_UNKNOWN
This is an external address with an unknown name. An address of this type is created to represent an endpoint for which there is insufficient information.

IN_SERVICE

public static final int IN_SERVICE
The address is out-of-service

INTERNAL

public static final int INTERNAL
This is an internal address.

OUT_OF_SERVICE

public static final int OUT_OF_SERVICE
The address is in-service

RINGER_DEFAULT

public static final int RINGER_DEFAULT
Sets the ringer status to configured value

RINGER_DISABLE

public static final int RINGER_DISABLE
Disables the ringer for the address

RINGER_ENABLE

public static final int RINGER_ENABLE
Enables the ringer for the address

UNKNOWN

public static final int UNKNOWN
This is an external address with an unknown name. An address of this type is created to represent an endpoint for which there is insufficient information.

Methods

clearCallConnections()

public void clearCallConnections()
throws PrivilegeViolationException
Use this interface to clear off any phantom calls on the address
Throws:
javax.telephony.PrivilegeViolationException

getAddressCallInfo(Terminal)

public com.cisco.jtapi.extensions.CiscoAddressCallInfo getAddressCallInfo( javax.telephony.Terminal iterminal)
Use this Interface to get info of calls present at the terminal

getRegistrationState()

public int getRegistrationState()
Deprecated.
This method has been replaced by the getState() method.
Returns the state of this address.
The state may be any of the following constants:
· CiscoAddress.OUT_OF_SERVICE
· CiscoAddress.IN_SERVICE
Returns:
the state of this address

getState()

public int getState()
Returns the state of this address.
The state may be any of the following constants:
· CiscoAddress.OUT_OF_SERVICE
· CiscoAddress.IN_SERVICE
Returns:
the state of this address

getType()

public int getType()
Returns the type of this address.
The type may be any of the following constants:
· CiscoAddress.INTERNAL
· CiscoAddress.EXTERNAL
· CiscoAddress.EXTERNAL_UNKNOWN
Returns:
the type of address

setMessageWaiting(String, boolean)

public void setMessageWaiting( java.lang.String destination, boolean enable)
throws MethodNotSupportedException, InvalidStateException, PrivilegeViolationException
Specifies whether the message-waiting indicator should be activated or deactivated for the Address specified by the destination. If enable is true, message-waiting is activated if not already activated. If enable is false, message-waiting is deactivated if not already deactivated.
Pre-conditions:
1. (this.getProvider()).getState() == Provider.IN_SERVICE
Post-conditions:
1. (this.getProvider()).getState() == Provider.IN_SERVICE
Note: The following postconditions as specified in CallControlAddress are currently not enforced by this implementation.
1. this.getMessageWaiting() == enable
2. CallCtlAddrMessageWaitingEv is delivered for this Address
Parameters:
destination - DN whose message waiting indicator should be activated
enable - True to activate message-waiting, false to deactivate.
Throws:
javax.telephony.MethodNotSupportedException - This method is not supported by the given implementation.
javax.telephony.InvalidStateException - The Provider is not "in service".
javax.telephony.PrivilegeViolationException - The Provider user has insufficient privleges to invoke the message waiting indicator for this destination

setRingerStatus(int)

public void setRingerStatus(int status)
throws MethodNotSupportedException, InvalidStateException, InvalidArgumentException
changes the ringer status on this address
Accepts on of the following constants: CiscoAddress.RINGER_DEFAULT CiscoAddress.RINGER_DISABLE CiscoAddress.RINGER_ENABLE
Throws:
javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

CiscoAddressCallInfo

Declaration

public class CiscoAddressCallInfo
java.lang.Object
  |
  +-- com.cisco.jtapi.extensions.CiscoAddressCallInfo

Member Summary
Constructors
 
CiscoAddressCallInfo(int, int, int, int) , int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold)
 
CiscoAddressCallInfo(int, int, int, int, CiscoCall[]) , int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold, CiscoCall icalls)
Methods
CiscoCall[]
int
int
getMaxCallsOnHold()
int
int

Inherited Member Summary
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), toString(), wait(), wait(), wait()

Constructors

CiscoAddressCallInfo(int, int, int, int)

public CiscoAddressCallInfo(int inumActiveCalls, int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold)

CiscoAddressCallInfo(int, int, int, int, CiscoCall[])

public CiscoAddressCallInfo(int inumActiveCalls, int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold, com.cisco.jtapi.extensions.CiscoCall[] icalls)

Methods

getCalls()

public com.cisco.jtapi.extensions.CiscoCall[] getCalls()

getMaxActiveCalls()

public int getMaxActiveCalls()

getMaxCallsOnHold()

public int getMaxCallsOnHold()

getNumActiveCalls()

public int getNumActiveCalls()

getNumCallsOnHold()

public int getNumCallsOnHold()

CiscoAddressObserver

Declaration

public interface CiscoAddressObserver extends javax.telephony.AddressObserver

All Superinterfaces

javax.telephony.AddressObserver

Description

Applications implement this interface in order to receive CiscoAddrEv events such as CiscoAddrInServiceEv and CiscoAddrOutOfServiceEv when observing Addresses via the Address.addObserver method.

See Also:

Inherited Member Summary
Methods inherited from interface AddressObserver
addressChangedEvent(AddrEv[])

CiscoAddrEv

Declaration

public interface CiscoAddrEv extends CiscoEv, javax.telephony.events.AddrEv

All Superinterfaces

javax.telephony.events.AddrEv, CiscoEv, javax.telephony.events.Ev

All Known Subinterfaces

Description

The CiscoAddrEv interface, which extends JTAPI's core javax.telephony.events.AddrEv interface, serves as the base interface for all Cisco-extended JTAPI Address events. Every Address-related event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.AddrEv

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface AddrEv
getAddress()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

CiscoAddrInServiceEv

Declaration

public interface CiscoAddrInServiceEv extends CiscoAddrEv

All Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoAddrInServiceEv event

Member Summary
Fields
static int
ID

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface AddrEv
getAddress()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

CiscoAddrOutOfServiceEv

Declaration

public interface CiscoAddrOutOfServiceEv extends CiscoAddrEv, CiscoOutOfServiceEv

All Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, CiscoOutOfServiceEv, javax.telephony.events.Ev

Description

The CiscoAddrOutOfServiceEv event

Member Summary
Fields
static int
ID

Inherited Member Summary
Fields inherited from interface CiscoOutOfServiceEv
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface AddrEv
getAddress()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

CiscoAddrRemovedEv

Declaration

public interface CiscoAddrRemovedEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoAddrRemovedEv event

Member Summary
Fields
static int
ID
Methods
javax.telephony.Address

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getAddress()

public javax.telephony.Address getAddress()

CiscoCall

Declaration

public interface CiscoCall extends javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer

All Superinterfaces

javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer

All Known Subinterfaces

Description

The CiscoCall interface extends the CallControlCall interface with additional CallManager-specific capabilities.
In CallManager terms, 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 maintained by the CallManager. This pair of properties is 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, it is possible for an INACTIVE Call to have identical CallManagerID and CallID properties to those of a currently ACTIVE Call object.

See Also:

javax.telephony.Call

Member Summary
Methods
CiscoCallID
CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.
javax.telephony.Address
java.lang.String
This interface returns the display of the called party in the call.
javax.telephony.Address
This interface returns current called address for the call this will return updated calling address every every time call is redirected or transferred
NOTE:
In the CiscoJtapi implementation CallControlCall.getCallingAddress()returns the first calling party of the call i.e.
java.lang.String
This interface returns the display name of the calling party.

Inherited Member Summary
Fields inherited from interface Call
ACTIVE, IDLE, INVALID
Methods inherited from interface Call
addObserver(CallObserver), connect(Terminal, Address, String), getCallCapabilities(Terminal, Address), getCapabilities(Terminal, Address), getConnections(), getObservers(), getProvider(), getState(), removeObserver(CallObserver)
Methods inherited from interface CallControlCall
addParty(String), conference(Call), consult(TerminalConnection), consult(TerminalConnection), drop(), getCalledAddress(), getCallingAddress(), getCallingTerminal(), getConferenceController(), getConferenceEnable(), getLastRedirectedAddress(), getTransferController(), getTransferEnable(), offHook(Address, Terminal), setConferenceController(TerminalConnection), setConferenceEnable(boolean), setTransferController(TerminalConnection), setTransferEnable(boolean), transfer(String), transfer(String)
Methods inherited from interface CiscoObjectContainer

Methods

getCallID()

public com.cisco.jtapi.extensions.CiscoCallID getCallID()
CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.
Returns:
the CallID property of this Call

getCurrentCalledAddress()

public javax.telephony.Address getCurrentCalledAddress()

getCurrentCalledPartyDisplayName()

public java.lang.String getCurrentCalledPartyDisplayName()
This interface returns the display of the called party in the call. It returns null if display name is unknown.

getCurrentCallingAddress()

public javax.telephony.Address getCurrentCallingAddress()
This interface returns current called address for the call this will return updated calling address every every time call is redirected or transferred
NOTE:
In the CiscoJtapi implementation CallControlCall.getCallingAddress()returns the first calling party of the call i.e. the original calling party
 Usage:
 if ( call instanceof CiscoCall ) {
Address currentCalled = ((CiscoCall)call).getCurrentCalling ();
 }
 

See Also:

javax.telephony.callcontrol.CallControlCall

getCurrentCallingPartyDisplayName()

public java.lang.String getCurrentCallingPartyDisplayName()
This interface returns the display name of the calling party. It returns null if display name is unknown.

CiscoCallEv

Declaration

public interface CiscoCallEv extends CiscoEv, javax.telephony.events.CallEv

All Superinterfaces

javax.telephony.events.CallEv, CiscoEv, javax.telephony.events.Ev

All Known Subinterfaces

Description

The CiscoCallEv interface, which extends JTAPI's core javax.telephony.events.CallEv interface, serves as the base interface for all Cisco-extended JTAPI Call events. Every Call-related event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.CallEv

Member Summary
Fields
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
Methods
int
Returns the CallManager cause for this event.

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface CallEv
getCall()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

CAUSE_ACCESSINFORMATIONDISCARDED

public static final int CAUSE_ACCESSINFORMATIONDISCARDED

CAUSE_BCBPRESENTLYAVAIL

public static final int CAUSE_BCBPRESENTLYAVAIL

CAUSE_BCNAUTHORIZED

public static final int CAUSE_BCNAUTHORIZED

CAUSE_BEARERCAPNIMPL

public static final int CAUSE_BEARERCAPNIMPL

CAUSE_CALLBEINGDELIVERED

public static final int CAUSE_CALLBEINGDELIVERED

CAUSE_CALLIDINUSE

public static final int CAUSE_CALLIDINUSE

CAUSE_CALLMANAGER_FAILURE

public static final int CAUSE_CALLMANAGER_FAILURE

CAUSE_CALLREJECTED

public static final int CAUSE_CALLREJECTED

CAUSE_CALLSPLIT

public static final int CAUSE_CALLSPLIT

CAUSE_CHANTYPENIMPL

public static final int CAUSE_CHANTYPENIMPL

CAUSE_CHANUNACCEPTABLE

public static final int CAUSE_CHANUNACCEPTABLE

CAUSE_CTIMANAGER_FAILURE

public static final int CAUSE_CTIMANAGER_FAILURE

CAUSE_DESTINATIONOUTOFORDER

public static final int CAUSE_DESTINATIONOUTOFORDER

CAUSE_DESTNUMMISSANDDCNOTSUB

public static final int CAUSE_DESTNUMMISSANDDCNOTSUB

CAUSE_FACILITYREJECTED

public static final int CAUSE_FACILITYREJECTED

CAUSE_IDENTIFIEDCHANDOESNOTEXIST

public static final int CAUSE_IDENTIFIEDCHANDOESNOTEXIST

CAUSE_IENIMPL

public static final int CAUSE_IENIMPL

CAUSE_INBOUNDBLINDTRANSFER

public static final int CAUSE_INBOUNDBLINDTRANSFER

CAUSE_INBOUNDCONFERENCE

public static final int CAUSE_INBOUNDCONFERENCE

CAUSE_INBOUNDTRANSFER

public static final int CAUSE_INBOUNDTRANSFER

CAUSE_INCOMINGCALLBARRED

public static final int CAUSE_INCOMINGCALLBARRED

CAUSE_INCOMPATABLEDDESTINATION

public static final int CAUSE_INCOMPATABLEDDESTINATION

CAUSE_INTERWORKINGUNSPECIFIED

public static final int CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_INVALIDCALLREFVALUE

public static final int CAUSE_INVALIDCALLREFVALUE

CAUSE_INVALIDIECONTENTS

public static final int CAUSE_INVALIDIECONTENTS

CAUSE_INVALIDMESSAGEUNSPECIFIED

public static final int CAUSE_INVALIDMESSAGEUNSPECIFIED

CAUSE_INVALIDNUMBERFORMAT

public static final int CAUSE_INVALIDNUMBERFORMAT

CAUSE_INVALIDTRANSITNETSEL

public static final int CAUSE_INVALIDTRANSITNETSEL

CAUSE_MANDATORYIEMISSING

public static final int CAUSE_MANDATORYIEMISSING

CAUSE_MSGNCOMPATABLEWCS

public static final int CAUSE_MSGNCOMPATABLEWCS

CAUSE_MSGTYPENCOMPATWCS

public static final int CAUSE_MSGTYPENCOMPATWCS

CAUSE_MSGTYPENIMPL

public static final int CAUSE_MSGTYPENIMPL

CAUSE_NETOUTOFORDER

public static final int CAUSE_NETOUTOFORDER

CAUSE_NOANSWERFROMUSER

public static final int CAUSE_NOANSWERFROMUSER

CAUSE_NOCALLSUSPENDED

public static final int CAUSE_NOCALLSUSPENDED

CAUSE_NOCIRCAVAIL

public static final int CAUSE_NOCIRCAVAIL

CAUSE_NOERROR

public static final int CAUSE_NOERROR

CAUSE_NONSELECTEDUSERCLEARING

public static final int CAUSE_NONSELECTEDUSERCLEARING

CAUSE_NORMALCALLCLEARING

public static final int CAUSE_NORMALCALLCLEARING

CAUSE_NORMALUNSPECIFIED

public static final int CAUSE_NORMALUNSPECIFIED

CAUSE_NOROUTETODDESTINATION

public static final int CAUSE_NOROUTETODDESTINATION

CAUSE_NOROUTETOTRANSITNET

public static final int CAUSE_NOROUTETOTRANSITNET

CAUSE_NOUSERRESPONDING

public static final int CAUSE_NOUSERRESPONDING

CAUSE_NUMBERCHANGED

public static final int CAUSE_NUMBERCHANGED

CAUSE_ONLYRDIVEARERCAPAVAIL

public static final int CAUSE_ONLYRDIVEARERCAPAVAIL

CAUSE_OUTBOUNDCONFERENCE

public static final int CAUSE_OUTBOUNDCONFERENCE

CAUSE_OUTBOUNDTRANSFER

public static final int CAUSE_OUTBOUNDTRANSFER

CAUSE_PROTOCOLERRORUNSPECIFIED

public static final int CAUSE_PROTOCOLERRORUNSPECIFIED

CAUSE_QUALOFSERVNAVAIL

public static final int CAUSE_QUALOFSERVNAVAIL

CAUSE_RECOVERYONTIMEREXPIRY

public static final int CAUSE_RECOVERYONTIMEREXPIRY

CAUSE_REDIRECTED

public static final int CAUSE_REDIRECTED

CAUSE_REQCALLIDHASBEENCLEARED

public static final int CAUSE_REQCALLIDHASBEENCLEARED

CAUSE_REQCIRCNAVIL

public static final int CAUSE_REQCIRCNAVIL

CAUSE_REQFACILITYNIMPL

public static final int CAUSE_REQFACILITYNIMPL

CAUSE_REQFACILITYNOTSUBSCRIBED

public static final int CAUSE_REQFACILITYNOTSUBSCRIBED

CAUSE_RESOURCESNAVAIL

public static final int CAUSE_RESOURCESNAVAIL

CAUSE_RESPONSETOSTATUSENQUIRY

public static final int CAUSE_RESPONSETOSTATUSENQUIRY

CAUSE_SERVNOTAVAILUNSPECIFIED

public static final int CAUSE_SERVNOTAVAILUNSPECIFIED

CAUSE_SERVOPERATIONVIOLATED

public static final int CAUSE_SERVOPERATIONVIOLATED

CAUSE_SERVOROPTNAVAILORIMPL

public static final int CAUSE_SERVOROPTNAVAILORIMPL

CAUSE_SUSPCALLBUTNOTTHISONE

public static final int CAUSE_SUSPCALLBUTNOTTHISONE

CAUSE_SWITCHINGEQUIPMENTCONGESTION

public static final int CAUSE_SWITCHINGEQUIPMENTCONGESTION

CAUSE_TEMPORARYFAILURE

public static final int CAUSE_TEMPORARYFAILURE

CAUSE_UNALLOCATEDNUMBER

public static final int CAUSE_UNALLOCATEDNUMBER

CAUSE_USERBUSY

public static final int CAUSE_USERBUSY

Methods

getCiscoCause()

public int getCiscoCause()
Returns the CallManager cause for this event.
In order to function properly, some applications need to know the reason why an event happened at an endpoint that the application is observing. For example, a Connection may be disconnected because the call was not answered ( CAUSE_NOANSWERFROMUSER), or whether the caller it was disconnected because it was rejected ( CAUSE_CALLREJECTED).
Returns:
the CallManager cause for this event

CiscoCallID

Declaration

public interface CiscoCallID extends CiscoObjectContainer

All Superinterfaces

Description

The CiscoCallID object repreents a unique object associated with each call. Aplications may use the object itself or the integer representation of the object returned by the intValue() method.

Member Summary
Methods
CiscoCall
int
returns the call manager nodeID of the call
int
returns the GlobalCallID of the call
int
Returns an integer representation of this object, currently a bitwise OR of the CallManagerID and GlobalCallID properties (shifted and truncated appropriately)

Inherited Member Summary
Methods inherited from interface CiscoObjectContainer

Methods

getCall()

public com.cisco.jtapi.extensions.CiscoCall getCall()

getCallManagerID()

public int getCallManagerID()
returns the call manager nodeID of the call

getGlobalCallID()

public int getGlobalCallID()
returns the GlobalCallID of the call

intValue()

public int intValue()
Returns an integer representation of this object, currently a bitwise OR of the CallManagerID and GlobalCallID properties (shifted and truncated appropriately)
Returns:
an integer representation of this object

CiscoConferenceEndEv

Declaration

public interface CiscoConferenceEndEv extends CiscoCallEv

All Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoConferenceEndEv event indicates that a transfer operation has completed. This event is reported via the CallControlCallObserver interface.

Member Summary
Fields
static int
ID
Methods
javax.telephony.Address
Returns the Address which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.Call
Returns the call that has been merged.
javax.telephony.Call
Returns the call that remains active after the conference is completed.
javax.telephony.TerminalConnection
Returns the TerminalConnection which currently acts as the conference controller for this call —- the final call.
javax.telephony.TerminalConnection
Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QUALOFSERVNAVAIL, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface CallEv
getCall()
Methods inherited from interface CiscoCallEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getConferenceControllerAddress()

public javax.telephony.Address getConferenceControllerAddress()
Returns the Address which currently acts as the conference controller for this call —- the initiating call.

getConferencedCall()

public javax.telephony.Call getConferencedCall()
Returns the call that has been merged. This call is in the Call.INVALID state.

getFinalCall()

public javax.telephony.Call getFinalCall()
Returns the call that remains active after the conference is completed.

getHeldConferenceController()

public javax.telephony.TerminalConnection getHeldConferenceController()
Returns the TerminalConnection which currently acts as the conference controller for this call —- the final call. This is the TerminalConnection that was in HELD state when conference was initiated. This method returns null if the conference controller is not being observed.

getTalkingConferenceController()

public javax.telephony.TerminalConnection getTalkingConferenceController()
Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.

CiscoConferenceStartEv

Declaration

public interface CiscoConferenceStartEv extends CiscoCallEv

All Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoConferenceStartEv event indicates that a conference operation has started. This event is reported via the CallControlCallObserver interface.

Member Summary
Fields
static int
ID
Methods
javax.telephony.Address
Returns the Address which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.Call
Returns the call that will be conferenced.
javax.telephony.Call
Returns the call that will remain active after the conference is completed.
javax.telephony.TerminalConnection
Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.TerminalConnection
Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QUALOFSERVNAVAIL, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface CallEv
getCall()
Methods inherited from interface CiscoCallEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getConferenceControllerAddress()

public javax.telephony.Address getConferenceControllerAddress()
Returns the Address which currently acts as the conference controller for this call —- the initiating call.

getConferencedCall()

public javax.telephony.Call getConferencedCall()
Returns the call that will be conferenced. This is the call that will be merged into the initiating call

getFinalCall()

public javax.telephony.Call getFinalCall()
Returns the call that will remain active after the conference is completed. This is the call all calls are finally merged into

getHeldConferenceController()

public javax.telephony.TerminalConnection getHeldConferenceController()
Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed.

getTalkingConferenceController()

public javax.telephony.TerminalConnection getTalkingConferenceController()
Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.

CiscoConnection

Declaration

public interface CiscoConnection extends javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer

All Superinterfaces

javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer, javax.telephony.Connection

Description

The CiscoConnection interface extends the CallControlConnection interface with additional CallManager-specific capabilities.
Applications can use the getReason method to obtain the reason for the creation of this Connection.

Member Summary
Fields
static int
This indicates that the redirect should be done using the search space of the redirect controller's address.
static int
This option indicates that the default behavior for Cisco JTAPI should apply.
static int
This option indicates that the calledAddress should be reset to the redirect destination.
static int
This option indicates that the calledAddress should remain unchanged after the redirect operation.
static int
This indicates that the redirect should be done using the search space of the calling address.
static int
This indicates that the redirect should be done using the search space that is the default for the implementation.
static int
This Connection was the result of a direct call.
static int
This Connection was the result of unconditional forwarding.
static int
This Connection was the result of a forwarding on busy.
static int
This Connection was the result of a forwarding on no answer.
static int
This Connection is an originating Connection, not a destination Connection.
static int
This Connection was the result of a redirection.
static int
This Connection was the result of a transfer.
static int
This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination.
static int
This redirect mode instructs the implementation to perform redirect if the destination is valid and available.
Methods
CiscoConnectionID
CiscoConnectionID is a unique object that identifier among all ACTIVE calls with the same CallManagerID.
int
Returns the reason for the creation of this Connection.
java.lang.String
This method parks the call at a system park port and returns the address of the port.
javax.telephony.Connection
This method overloads the CallControlConnection.redirect() method.
javax.telephony.Connection
This method overloads the CallControlConnection.redirect() method.
javax.telephony.Connection
This method overloads the CallControlConnection.redirect() method.

Inherited Member Summary
Fields inherited from interface CallControlConnection
ALERTING, DIALING, DISCONNECTED, ESTABLISHED, FAILED, IDLE, INITIATED, NETWORK_ALERTING, NETWORK_REACHED, OFFERED, OFFERING, QUEUED, UNKNOWN
Fields inherited from interface Connection
CONNECTED, INPROGRESS
Methods inherited from interface CallControlConnection
accept(), addToAddress(String), getCallControlState(), park(String), redirect(String), reject()
Methods inherited from interface CiscoObjectContainer
Methods inherited from interface Connection
disconnect(), getAddress(), getCall(), getCapabilities(), getConnectionCapabilities(Terminal, Address), getState(), getTerminalConnections()

Fields

ADDRESS_SEARCH_SPACE

public static final int ADDRESS_SEARCH_SPACE
This indicates that the redirect should be done using the search space of the redirect controller's address.

CALLED_ADDRESS_DEFAULT

public static final int CALLED_ADDRESS_DEFAULT
This option indicates that the default behavior for Cisco JTAPI should apply. Cisco JTAPI's default behavior is the same as CALLED_ADDRESS_UNCHANGED.

CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

public static final int CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
This option indicates that the calledAddress should be reset to the redirect destination.

CALLED_ADDRESS_UNCHANGED

public static final int CALLED_ADDRESS_UNCHANGED
This option indicates that the calledAddress should remain unchanged after the redirect operation.

CALLINGADDRESS_SEARCH_SPACE

public static final int CALLINGADDRESS_SEARCH_SPACE
This indicates that the redirect should be done using the search space of the calling address.

DEFAULT_SEARCH_SPACE

public static final int DEFAULT_SEARCH_SPACE
This indicates that the redirect should be done using the search space that is the default for the implementation. The default is to use the calling address's search space.

REASON_DIRECTCALL

public static final int REASON_DIRECTCALL
This Connection was the result of a direct call.

REASON_FORWARDALL

public static final int REASON_FORWARDALL
This Connection was the result of unconditional forwarding.

REASON_FORWARDBUSY

public static final int REASON_FORWARDBUSY
This Connection was the result of a forwarding on busy.

REASON_FORWARDNOANSWER

public static final int REASON_FORWARDNOANSWER
This Connection was the result of a forwarding on no answer.

REASON_OUTBOUND

public static final int REASON_OUTBOUND
This Connection is an originating Connection, not a destination Connection.

REASON_REDIRECT

public static final int REASON_REDIRECT
This Connection was the result of a redirection.

REASON_TRANSFERREDCALL

public static final int REASON_TRANSFERREDCALL
This Connection was the result of a transfer.

REDIRECT_DROP_ON_FAILURE

public static final int REDIRECT_DROP_ON_FAILURE
This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The original call will be dropped if the destination is not valid or if it's busy.

REDIRECT_NORMAL

public static final int REDIRECT_NORMAL
This redirect mode instructs the implementation to perform redirect if the destination is valid and available. Otherwise, the request will return error. The original call will not be dropped on failure.

Methods

getConnectionID()

public com.cisco.jtapi.extensions.CiscoConnectionID getConnectionID()
CiscoConnectionID is a unique object that identifier among all ACTIVE calls with the same CallManagerID.
Returns:
the CallID property of this Call

getReason()

public int getReason()
Returns the reason for the creation of this Connection.
In order to function properly, some applications need to know the reason why a Connection is created at an endpoint that the application is observing. For example, a voice mail application may want to know whether a caller is someone that wants to leave a message in a voice mailbox ( REASON_FORWARDNOANSWER), or whether the caller is trying to access a voice mail box ( REASON_DIRECTCALL).
The reason for a Connection's creation may be any of the following constants:
· CiscoConnection.REASON_DIRECTCALL
· CiscoConnection.REASON_TRANSFERREDCALL
· CiscoConnection.REASON_FORWARDNOANSWER
· CiscoConnection.REASON_FORWARDBUSY
· CiscoConnection.REASON_FORWARDALL
· CiscoConnection.REASON_REDIRECT
· CiscoConnection.REASON_NORMAL
All of the reasons except for REASON_TRANSFERORIGINATION and REASON_NORMAL are associated with inbound, or destination Connections. The REASON_NORMAL reason is associated without outbound, or originating Connections.
Returns:
the reason for the creation of this Connection

park()

public java.lang.String park()
throws InvalidArgumentException, PrivilegeViolationException, ResourceUnavailableException, InvalidStateException
This method parks the call at a system park port and returns the address of the port. The call can be unparked using this address.
Throws:
javax.telephony.InvalidStateException, javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentException

redirect(String, int)

public javax.telephony.Connection redirect( java.lang.String destinationAddress, int mode)
throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes a new parameter —- redirectMode. When this parameter is:
1. CiscoConnection.REDIRECT_DROP_ON_FAILURE This mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The original call will be dropped if the destination is not valid or if it's busy.
2. CiscoConnection.REDIRECT_NORMAL This mode instructs the implementation to perform redirect only after checking the validity or availability of the destination. This is the same as the CallControlConnection.redirect() method. The original call will not be dropped on failure.
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int)

public javax.telephony.Connection redirect( java.lang.String destinationAddress, int mode, int callingSearchSpace)
throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes two new parameters —- redirectMode and callingSearchSpace. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space.
The redirectMode parameter may be:
1. CiscoConnection.REDIRECT_DROP_ON_FAILURE
2. CiscoConnection.REDIRECT_NORMAL
Read above for a description of what each of these means.
The callingSearchSpace parameter may be:
1. CiscoConnection.DEFAULT_SEARCH_SPACE
2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
3. CiscoConnection.ADDRESS_SEARCH_SPACE
Read above for a description of what each of these means.
NOTE: The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int, int)

public javax.telephony.Connection redirect( java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption)
throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes three new parameters —- redirectMode, callingSearchSpace and calledAddressOption. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space. The calledAddressOption parameter is used to decide whether to reset the original called fiels or not.
The redirectMode parameter may be:
1. CiscoConnection.REDIRECT_DROP_ON_FAILURE
2. CiscoConnection.REDIRECT_NORMAL
Read above for a description of what each of these means.
The callingSearchSpace parameter may be:
1. CiscoConnection.DEFAULT_SEARCH_SPACE
2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
3. CiscoConnection.ADDRESS_SEARCH_SPACE
Read above for a description of what each of these means.
NOTE: The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.
* The calledAddressOption parameter may be:
1. CiscoConnection.CALLED_ADDRESS_DEFAULT
2. CiscoConnection.CALLED_ADDRESS_UNCHANGED
3. CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
Read above for a description of what each of these means.
Throws:
javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

CiscoConnectionID

Declaration

public interface CiscoConnectionID extends CiscoObjectContainer

All Superinterfaces

Description

The CiscoConnectionID object represents a unique object associated with each connection. Aplications may use the object itself or the integer representation of the object returned by the intValue() method.

Member Summary
Methods
CiscoConnection
int
Returns an integer representation of this object, currently the CallManager CallLeg ID.

Inherited Member Summary
Methods inherited from interface CiscoObjectContainer

Methods

getConnection()

public com.cisco.jtapi.extensions.CiscoConnection getConnection()

intValue()

public int intValue()
Returns an integer representation of this object, currently the CallManager CallLeg ID.
Returns:
an integer representation of this object

CiscoConsultCall

Declaration

public interface CiscoConsultCall extends CiscoCall

All Superinterfaces

javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoCall, CiscoObjectContainer

Description

The CiscoConsultCall interface extends the CiscoCall interface to expose certain properties of Calls that have been created as part of a consultative transfer or consultative conference.

See Also:

javax.telephony.Call

Member Summary
Methods
javax.telephony.Connection[]
From CallEvent perspective, this method behaves similar to CallControlCall.consult(TerminalConnection tc, String dialedDigits).
javax.telephony.TerminalConnection
Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.

Inherited Member Summary
Fields inherited from interface Call
ACTIVE, IDLE, INVALID
Methods inherited from interface Call
addObserver(CallObserver), connect(Terminal, Address, String), getCallCapabilities(Terminal, Address), getCapabilities(Terminal, Address), getConnections(), getObservers(), getProvider(), getState(), removeObserver(CallObserver)
Methods inherited from interface CallControlCall
addParty(String), conference(Call), consult(TerminalConnection), consult(TerminalConnection), drop(), getCalledAddress(), getCallingAddress(), getCallingTerminal(), getConferenceController(), getConferenceEnable(), getLastRedirectedAddress(), getTransferController(), getTransferEnable(), offHook(Address, Terminal), setConferenceController(TerminalConnection), setConferenceEnable(boolean), setTransferController(TerminalConnection), setTransferEnable(boolean), transfer(String), transfer(String)
Methods inherited from interface CiscoCall
Methods inherited from interface CiscoObjectContainer

Methods

consultWithoutMedia(TerminalConnection, String)

public javax.telephony.Connection[] consultWithoutMedia( javax.telephony.TerminalConnection tc, java.lang.String dialedDigits)
throws InvalidStateException, InvalidArgumentException, MethodNotSupportedException, ResourceUnavailableException, PrivilegeViolationException, InvalidPartyException
From CallEvent perspective, this method behaves similar to CallControlCall.consult(TerminalConnection tc, String dialedDigits). Creates a consultation between this Call and an active Call without establishing the media. This consult call may only be transferred, not conferenced.
The Consultation Purpose
This method does not support if invoked with CallControlCall.setConferneceEnable(). It only supports if invoked with CallControlCall.setTransferEnable().
Throws:
javax.telephony.InvalidPartyException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException

getConsultingTerminalConnection()

public javax.telephony.TerminalConnection getConsultingTerminalConnection()
Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.
If this Call was created as part of a consultative transfer or consultative conference, the TerminalConnection which was used to perform the consultation on the original Call is returned by the getConsultingTerminalConnection method. This may be useful to applications that wish to correlate a ConsultCall with its original Call. Note that the original Call does not have any methods which may be used to determine the ConsultCall, if any, to which it is related.
Returns:
null if this Call is not the result of a consultation, or the consulting TerminalConnection of the original Call if this Call is the result of a consultation.

CiscoConsultCallActiveEv

Declaration

public interface CiscoConsultCallActiveEv extends CiscoCallEv, javax.telephony.events.CallActiveEv

All Superinterfaces

javax.telephony.events.CallActiveEv, javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoConsultCallActiveEv event interface extends the JTAPI CallActiveEv. It indicates that the state of the Call object has changed to Call.ACTIVE and that the call was initiated as a result of a consultative transfer or consultative conference operation (manual or programmatic). Applications can obtain the consulting TerminalConnection on the original (consulting) call by using the CiscoConsultCall.getConsultingTerminalConnection method.
This event is reported to applications via the CallObserver interface.

See Also:

javax.telephony.Call, javax.telephony.CallObserver, javax.telephony.events.CallActiveEv

Member Summary
Fields
static int
ID
Methods
javax.telephony.TerminalConnection
Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QUALOFSERVNAVAIL, CAUSE_RECOVERYONTIMEREXPIRY, CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUSPCALLBUTNOTTHISONE, CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, CAUSE_USERBUSY
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface CallEv
getCall()
Methods inherited from interface CiscoCallEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getHeldTerminalConnection()

public javax.telephony.TerminalConnection getHeldTerminalConnection()
Deprecated.
replaced by CiscoConsultCall.getConsultingTerminalConnection ()
Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.
This may be useful to applications that wish to correlate a consultation Call with its original Call. Note that the original Call does not have any methods which may be used to determine the consultation Call, if any, to which it is related.
Returns:
the consulting TerminalConnection of the Call that created the Call referenced by this event

CiscoEv

Declaration

public interface CiscoEv extends javax.telephony.events.Ev

All Superinterfaces

javax.telephony.events.Ev

All Known Subinterfaces

Description

The CiscoEv interface, which extends JTAPI's core javax.telephony.events.Ev interface, serves as the base interface for all Cisco-extended JTAPI events. Every event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.Ev

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

CiscoG711MediaCapability

Declaration

public class CiscoG711MediaCapability extends CiscoMediaCapability
java.lang.Object
  |
  +-- com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +-- com.cisco.jtapi.extensions.CiscoG711MediaCapability

Description

The CiscoG711MediaCapability object specifies the properties for a G.711 encoded RTP stream. Applications that support G.711 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.
The default packet size is thirty milliseconds.

Member Summary
Fields
static int
The frames-per-packet value for 60 millisecond packets
static int
The frames-per-packet value for 30 millisecond packets
static int
The frames-per-packet value for 20 millisecond packets
Constructors
 
Constructs a CiscoG711MediaCapability</CODE object with a default thirty millisecond packet size.
 
Constructs a CiscoG711MediaCapability</CODE object with the specified packet size.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), wait(), wait(), wait()

Fields

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET
The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET
The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET
The frames-per-packet value for 20 millisecond packets

Constructors

CiscoG711MediaCapability()

public CiscoG711MediaCapability()
Constructs a CiscoG711MediaCapability</CODE object with a default thirty millisecond packet size.

CiscoG711MediaCapability(int)

public CiscoG711MediaCapability(int maxFramesPerPacket)
Constructs a CiscoG711MediaCapability</CODE object with the specified packet size.

CiscoG723MediaCapability

Declaration

public class CiscoG723MediaCapability extends CiscoMediaCapability
java.lang.Object
  |
  +-- com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +-- com.cisco.jtapi.extensions.CiscoG723MediaCapability

Description

The CiscoG723MediaCapability object specifies the properties for a G.723 encoded RTP stream. Applications that support G.723 media termination use this object to specify their preferred packet size and bit rate when registering a CiscoMediaTerminal.
The default packet size is thirty milliseconds and the default bit rate is 6.4k.

Member Summary
Fields
static int
The frames-per-packet value for 60 millisecond packets
static int
The frames-per-packet value for 30 millisecond packets
static int
The frames-per-packet value for 20 millisecond packets
Constructors
 
Constructs a CiscoG723MediaCapability</CODE object with a default thirty millisecond packet size and 6.4k bit rate.
 
Constructs a CiscoG723MediaCapability</CODE object with the specified packet size and bit rate.
Methods
int
Returns the bit rate specified by this capability object.
java.lang.String

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), wait(), wait(), wait()

Fields

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET
The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET
The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET
The frames-per-packet value for 20 millisecond packets

Constructors

CiscoG723MediaCapability()

public CiscoG723MediaCapability()
Constructs a CiscoG723MediaCapability</CODE object with a default thirty millisecond packet size and 6.4k bit rate.

CiscoG723MediaCapability(int, int)

public CiscoG723MediaCapability(int maxFramesPerPacket, int bitRate)
Constructs a CiscoG723MediaCapability</CODE object with the specified packet size and bit rate.

Methods

getBitRate()

public int getBitRate()
Returns the bit rate specified by this capability object.
Returns:
a bit rate from the RTPBitRate interface

toString()

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

CiscoG729MediaCapability

Declaration

public class CiscoG729MediaCapability extends CiscoMediaCapability
java.lang.Object
  |
  +-- com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +-- com.cisco.jtapi.extensions.CiscoG729MediaCapability

Description

The CiscoG729MediaCapability object specifies the properties for a G.729 encoded RTP stream. Applications that support G.729 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.
The default packet size is thirty milliseconds.

Member Summary
Fields
static int
The frames-per-packet value for 60 millisecond packets
static int
The frames-per-packet value for 30 millisecond packets
static int
The frames-per-packet value for 20 millisecond packets
Constructors
 
Constructs a CiscoG729MediaCapability</CODE object with a default G729 payload and thirty millisecond packet size.
 
Constructs a CiscoG729MediaCapability</CODE object with the specified packet size and payload.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), wait(), wait(), wait()

Fields

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET
The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET
The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET
The frames-per-packet value for 20 millisecond packets

Constructors

CiscoG729MediaCapability()

public CiscoG729MediaCapability()
Constructs a CiscoG729MediaCapability</CODE object with a default G729 payload and thirty millisecond packet size.

CiscoG729MediaCapability(int, int)

public CiscoG729MediaCapability(int payload, int maxFramesPerPacket)
Constructs a CiscoG729MediaCapability</CODE object with the specified packet size and payload. Choice of payload is specified in CiscoRTPPayload with the options CiscoRTPPayload.G729 and CiscoRTPPayload.G729ANNEXA

CiscoGSMMediaCapability

Declaration

public class CiscoGSMMediaCapability extends CiscoMediaCapability
java.lang.Object
  |
  +-- com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +-- com.cisco.jtapi.extensions.CiscoGSMMediaCapability

Description

The CiscoGSMMediaCapability object specifies the properties for a GSM encoded RTP stream. Applications that support GSM media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.
The default packet size is thirty milliseconds.

Member Summary
Fields
static int
The frames-per-packet value for 30 millisecond packets
Constructors
 
Constructs a CiscoGSMMediaCapability</CODE object with a default eighty millisecond packet size.
 
Constructs a CiscoGSMMediaCapability</CODE object with the specified packet size.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), wait(), wait(), wait()

Fields

FRAMESIZE_EIGHTY_MILLISECOND_PACKET

public static final int FRAMESIZE_EIGHTY_MILLISECOND_PACKET
The frames-per-packet value for 30 millisecond packets

Constructors

CiscoGSMMediaCapability()

public CiscoGSMMediaCapability()
Constructs a CiscoGSMMediaCapability</CODE object with a default eighty millisecond packet size.

CiscoGSMMediaCapability(int)

public CiscoGSMMediaCapability(int maxFramesPerPacket)
Constructs a CiscoGSMMediaCapability</CODE object with the specified packet size.

CiscoJtapiException

Declaration

public interface CiscoJtapiException

Description

The CiscoJtapiException interface defines CTI error codes. These are the error codes that may be returned by CTI requests. All the JTAPI exceptions have been extended to implement this interface. The Error codes can be got by casting the exception to CiscoJtapiException and calling the method getErrorCode(). if e is any exception caught in an application, then try to see if its an instanceof CiscoJtapiException.

try {
// some code here }
catch ( Exception e ) {
if( e instanceof CiscoJtapiException){
CiscoJtapiException ce = com.cisco.cti.client.CTIFAILURE.(CiscoJtapiException) e
int errorCode = com.cisco.cti.client.CTIFAILURE.ce.getErrorCode() //returns the ErrorCode.
}
}

Member Summary
Fields
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
The CTI error codes.
Methods
int
Returns the errorCode for this exception
java.lang.String
This method returns the detail description of the errorCode
java.lang.String
This method returns the detail description of the errorCode
java.lang.String
This method returns an exception in the string format.
java.lang.String
This method will return an exception in the string format.

Fields

ASSOCIATED_LINE_NOT_OPEN

public static final int ASSOCIATED_LINE_NOT_OPEN

CALL_ALREADY_EXISTS

public static final int CALL_ALREADY_EXISTS

CALLHANDLE_NOTINCOMINGCALL

public static final int CALLHANDLE_NOTINCOMINGCALL

CALLHANDLE_UNKNOWN_TO_LINECONTROL

public static final int CALLHANDLE_UNKNOWN_TO_LINECONTROL

CANNOT_OPEN_DEVICE

public static final int CANNOT_OPEN_DEVICE

CANNOT_TERMINATE_MEDIA_ON_PHONE

public static final int CANNOT_TERMINATE_MEDIA_ON_PHONE

CFWDALL_ALREADY_OFF

public static final int CFWDALL_ALREADY_OFF

CFWDALL_ALREADY_SET

public static final int CFWDALL_ALREADY_SET

CFWDALL_DESTN_INVALID

public static final int CFWDALL_DESTN_INVALID

CLUSTER_LINK_FAILURE

public static final int CLUSTER_LINK_FAILURE

COMMAND_NOT_IMPLEMENTED_ON_DEVICE

public static final int COMMAND_NOT_IMPLEMENTED_ON_DEVICE

CONFERENCE_ALREADY_PRESENT

public static final int CONFERENCE_ALREADY_PRESENT

CONFERENCE_FAILED

public static final int CONFERENCE_FAILED

CONFERENCE_FULL

public static final int CONFERENCE_FULL

CONFERENCE_INACTIVE

public static final int CONFERENCE_INACTIVE

CONFERENCE_INVALID_PARTICIPANT

public static final int CONFERENCE_INVALID_PARTICIPANT

CTIERR_INCORRECT_MEDIA_CAPABILITY

public static final int CTIERR_INCORRECT_MEDIA_CAPABILITY

CTIERR_INVALID_DTMFDIGITS

public static final int CTIERR_INVALID_DTMFDIGITS

CTIERR_OPERATION_FAILED_QUIETCLEAR

public static final int CTIERR_OPERATION_FAILED_QUIETCLEAR

DARES_INVALID_REQ_TYPE

public static final int DARES_INVALID_REQ_TYPE

DATA_SIZE_LIMIT_EXCEEDED

public static final int DATA_SIZE_LIMIT_EXCEEDED

DB_ERROR

public static final int DB_ERROR

DB_ILLEGAL_DEVICE_TYPE

public static final int DB_ILLEGAL_DEVICE_TYPE

DB_NO_MORE_DEVICES

public static final int DB_NO_MORE_DEVICES

DESTINATION_BUSY

public static final int DESTINATION_BUSY

DESTINATION_UNKNOWN

public static final int DESTINATION_UNKNOWN

DEVICE_ALREADY_REGISTERED

public static final int DEVICE_ALREADY_REGISTERED

DEVICE_NOT_OPEN

public static final int DEVICE_NOT_OPEN

DEVICE_OUT_OF_SERVICE

public static final int DEVICE_OUT_OF_SERVICE

DIGIT_GENERATION_ALREADY_IN_PROGRESS

public static final int DIGIT_GENERATION_ALREADY_IN_PROGRESS

DIGIT_GENERATION_CALLSTATE_CHANGED

public static final int DIGIT_GENERATION_CALLSTATE_CHANGED

DIGIT_GENERATION_WRONG_CALL_HANDLE

public static final int DIGIT_GENERATION_WRONG_CALL_HANDLE

DIGIT_GENERATION_WRONG_CALL_STATE

public static final int DIGIT_GENERATION_WRONG_CALL_STATE

DIRECTORY_LOGIN_FAILED

public static final int DIRECTORY_LOGIN_FAILED

DIRECTORY_LOGIN_NOT_ALLOWED

public static final int DIRECTORY_LOGIN_NOT_ALLOWED

DIRECTORY_TEMPORARY_UNAVAILABLE

public static final int DIRECTORY_TEMPORARY_UNAVAILABLE

EXISTING_FIRSTPARTY

public static final int EXISTING_FIRSTPARTY

HOLDFAILED

public static final int HOLDFAILED

ILLEGAL_CALLINGPARTY

public static final int ILLEGAL_CALLINGPARTY

ILLEGAL_CALLSTATE

public static final int ILLEGAL_CALLSTATE

ILLEGAL_HANDLE

public static final int ILLEGAL_HANDLE

ILLEGAL_MESSAGE_FORMAT

public static final int ILLEGAL_MESSAGE_FORMAT

INCOMPATIBLE_PROTOCOL_VERSION

public static final int INCOMPATIBLE_PROTOCOL_VERSION

INVALID_LINE_HANDLE

public static final int INVALID_LINE_HANDLE

INVALID_RING_OPTION

public static final int INVALID_RING_OPTION

LINE_INFO_DOES_NOT_EXIST

public static final int LINE_INFO_DOES_NOT_EXIST

LINE_NOT_PRIMARY

public static final int LINE_NOT_PRIMARY

LINECONTROL_FAILURE

public static final int LINECONTROL_FAILURE

MAX_NUMBER_OF_CTI_CONNECTIONS_REACHED

public static final int MAX_NUMBER_OF_CTI_CONNECTIONS_REACHED

MSGWAITING_DESTN_INVALID

public static final int MSGWAITING_DESTN_INVALID

NO_ACTIVE_DEVICE_FOR_THIRDPARTY

public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTY

NO_CONFERENCE_BRIDGE

public static final int NO_CONFERENCE_BRIDGE

NOT_INITIALIZED

public static final int NOT_INITIALIZED

PROTOCOL_TIMEOUT

public static final int PROTOCOL_TIMEOUT

PROVIDER_ALREADY_OPEN

public static final int PROVIDER_ALREADY_OPEN

PROVIDER_CLOSED

public static final int PROVIDER_CLOSED

PROVIDER_NOT_OPEN

public static final int PROVIDER_NOT_OPEN

REDIRECT_CALL_CALL_TABLE_FULL

public static final int REDIRECT_CALL_CALL_TABLE_FULL

REDIRECT_CALL_DESTINATION_BUSY

public static final int REDIRECT_CALL_DESTINATION_BUSY

REDIRECT_CALL_DESTINATION_OUT_OF_ORDER

public static final int REDIRECT_CALL_DESTINATION_OUT_OF_ORDER

REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT

public static final int REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT

REDIRECT_CALL_DOES_NOT_EXIST

public static final int REDIRECT_CALL_DOES_NOT_EXIST

REDIRECT_CALL_INCOMPATIBLE_STATE

public static final int REDIRECT_CALL_INCOMPATIBLE_STATE

REDIRECT_CALL_MEDIA_CONNECTION_FAILED

public static final int REDIRECT_CALL_MEDIA_CONNECTION_FAILED

REDIRECT_CALL_NORMAL_CLEARING

public static final int REDIRECT_CALL_NORMAL_CLEARING

REDIRECT_CALL_ORIGINATOR_ABANDONED

public static final int REDIRECT_CALL_ORIGINATOR_ABANDONED

REDIRECT_CALL_PARTY_TABLE_FULL

public static final int REDIRECT_CALL_PARTY_TABLE_FULL

REDIRECT_CALL_PENDING_REDIRECT_TRANSACTION

public static final int REDIRECT_CALL_PENDING_REDIRECT_TRANSACTION

REDIRECT_CALL_PROTOCOL_ERROR

public static final int REDIRECT_CALL_PROTOCOL_ERROR

REDIRECT_CALL_UNKNOWN_DESTINATION

public static final int REDIRECT_CALL_UNKNOWN_DESTINATION

REDIRECT_CALL_UNKNOWN_ERROR

public static final int REDIRECT_CALL_UNKNOWN_ERROR

REDIRECT_CALL_UNKNOWN_PARTY

public static final int REDIRECT_CALL_UNKNOWN_PARTY

REDIRECT_CALL_UNRECOGNIZED_MANAGER

public static final int REDIRECT_CALL_UNRECOGNIZED_MANAGER

REDIRECT_CALLINFO_ERR

public static final int REDIRECT_CALLINFO_ERR

REDIRECT_ERR

public static final int REDIRECT_ERR

RETRIEVEFAILED

public static final int RETRIEVEFAILED

RETRIEVEFAILED_ACTIVE_CALL_ON_LINE

public static final int RETRIEVEFAILED_ACTIVE_CALL_ON_LINE

SSAPI_NOT_REGISTERED

public static final int SSAPI_NOT_REGISTERED

TEMPORARY_FAILURE

public static final int TEMPORARY_FAILURE

TIMEOUT

public static final int TIMEOUT

TRANSFER_INACTIVE

public static final int TRANSFER_INACTIVE

TRANSFERFAILED

public static final int TRANSFERFAILED

TRANSFERFAILED_CALLCONTROL_TIMEOUT

public static final int TRANSFERFAILED_CALLCONTROL_TIMEOUT

TRANSFERFAILED_DESTINATION_BUSY

public static final int TRANSFERFAILED_DESTINATION_BUSY

TRANSFERFAILED_DESTINATION_UNALLOCATED

public static final int TRANSFERFAILED_DESTINATION_UNALLOCATED

TRANSFERFAILED_OUTSTANDING_TRANSFER

public static final int TRANSFERFAILED_OUTSTANDING_TRANSFER

UNDEFINED_LINE

public static final int UNDEFINED_LINE

UNKNOWN_GLOBAL_CALL_HANDLE

public static final int UNKNOWN_GLOBAL_CALL_HANDLE

UNRECOGNIZABLE_PDU

public static final int UNRECOGNIZABLE_PDU

UNSPECIFIED

public static final int UNSPECIFIED
The CTI error codes. These are the error codes that may be returned by CTI requests.

Methods

getErrorCode()

public int getErrorCode()
Returns the errorCode for this exception
Returns:
errorCode in an integer representation

getErrorDescription()

public java.lang.String getErrorDescription()
This method returns the detail description of the errorCode
Returns:
String detail description of the errorCode

getErrorDescription(int)

public java.lang.String getErrorDescription(int errorCode)
Deprecated.
instead use String getErrorDescription ();
This method returns the detail description of the errorCode
Returns:
String detail description of the errorCode

getErrorName()

public java.lang.String getErrorName()
This method returns an exception in the string format.
Returns:
String representation of the error code

getErrorName(int)

public java.lang.String getErrorName(int errorCode)
Deprecated.
instead use String getErrorName ();
This method will return an exception in the string format.
Returns:
String representation of the error code

CiscoJtapiPeer

Declaration

public interface CiscoJtapiPeer extends com.cisco.services.tracing.TraceModule, javax.telephony.JtapiPeer, CiscoObjectContainer

All Superinterfaces

CiscoObjectContainer, javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModule

Description

By extending the com.cisco.services.tracing.TraceModule interface, the CiscoJtapiPeer exposes trace information to applications. All instances of JtapiPeer objects created by the Cisco JTAPI implementation implement this interface. Applications that wish to manipulate the trace settings of the Cisco JTAPI implementation may use the CiscoJtapiPeer.getTraceManager method to obtain its TraceManager object. The TraceManager object may then be manipulated as described in the com.cisco.services.tracing package.

See Also:

com.cisco.services.tracing.TraceModule

Member Summary
Methods
CiscoJtapiProperties
CiscoJtapiProperties defines the various methods that applications can use to modify the parameters that the JTAPI layer will use.

Inherited Member Summary
Methods inherited from interface CiscoObjectContainer
Methods inherited from interface JtapiPeer
getName(), getProvider(String), getServices()
Methods inherited from interface TraceModule
getTraceManager(), getTraceModuleName()

Methods

getJtapiProperties()

public com.cisco.jtapi.extensions.CiscoJtapiProperties getJtapiProperties()
CiscoJtapiProperties defines the various methods that applications can use to modify the parameters that the JTAPI layer will use.
See Also:

CiscoJtapiProperties

Declaration

public interface CiscoJtapiProperties

Description

Cisco JTAPI's behaviour and functionality is tailored by many parameters which are read in from the jtapi.ini file when an instance of CiscoJtapiPeer is instantiated. These parameters are now exposed to applications for control via this CiscoJtapiproperties interface.
Applications can query the CiscoJtapiproperties properties object and change these parameters to better suit the application functionality. Exposing these properties via the CiscoJtapiproperties interface also allows applications to have a single point of administration (at the application end) for these parameters.
The most visible parameters are those describing the tracing levels and tracing destinations.
Usage:
JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );
if(peer instanceof CiscoJtapiPeer){
CiscoJtapiProperties jProps = ((CiscoJtapiPeer)peer).getJtapiProperties();
jProps.setTracePath("\\D:\\Traces\\WorkFlow");
jProps.setUseJavaConsoleTrace(false);
MyProviderObserver providerObserver = new MyProviderObserver ();
provider = peer.getProvider ( providerName );
}

In the above example an application has set the java console tracing to off and set the trace path to D:\Traces\WorkFlowApp1
When the peer is obtained an object implementing CiscoJtapiProperties is created by reading parameters set in the jtapi.ini file. If no jtapi.ini file exists in the classpath default settings are used to create this object.
The parameters used by Cisco Jtapi are read in and frozen when the first getProvider () call is made.

Member Summary
Methods
java.lang.String
get the alarm service host name
int
get the port number for the alarm service
int
get the timout for cti requests, other than the provider open (seconds)
java.lang.String[]
get names of supported debugging level jtapi traces
boolean
get the enabled or disabled state of a debugging level trace
int
get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds).
java.lang.String
the filename for individual log files.
java.lang.String
get the filename extension for log files
int
number of trace files before rollover
boolean
get the enabled state of periodic wake up
int
get the interval for periodic wakeup (milliseconds)
int
get the timout for a provider open request (seconds)
int
get the interval at which the connection to the CTI Manager will ge retried (seconds)
int
Get the threshold for the event queue size to trigger alarms
boolean
get the enabled state of event queue stats
int
get the route select timeout (milliseconds)
java.lang.String[]
Returns the services that this implementation supports.
java.lang.String
get the syslog collector hostname
int
get the syslog collector UDP port
java.lang.String
The directory in the path where trace files will be written
int
The size of the tracefiles before rollover
java.lang.String[]
get the names of supported jtapi traces
java.lang.String
get the path where the trace files will be located
boolean
get the enabled or disabled state of a trace
boolean
get the enabled/disabled state of the alarm service
boolean
get the enabled or disabled state of jtapi log file tracing
boolean
get the enabled or disabled state of jtapi console tracing
boolean
if UseSameDir is true this will cause the traces to go to a single directory.
boolean
get the enabled or disabled state of syslog tracing
void
set the alarm service host name
void
set the port number the alarm service is listening on
void
set the timeout for cti requests other than provider open (seconds)
void
enable or disable a particular debugging level trace
void
set the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds).
void
set the filename for log files
void
set the filename extension for log files
void
set the number of trace files before rollover
void
set the enable/disable state for periodic wake up
void
set the periodic wake up interval (milliseconds)
void
set the timeout for a provider open request (seconds)
void
set the interval at which the connection to the CTI Manager will ge retried (seconds)
void
Set the threshold for the event queue size to trigger alarms
void
enable / disable event queue statistics
void
set the route select timeout milliseconds
void
set a list of available services
void
set the syslog collector hostname
void
set the syslog collector UDP port
void
Set the directory where jtapi trace files should be written
void
Set the size of the trace file
void
set the directory root where jtapi traces will be written
void
enable or disable a particular trace
void
enable the alarm service
void
enable or disable jtapi log file tracing
void
enable or disable jtapi console tracing
void
if UseSameDir is true this will cause the traces to go to a single directory.
void
enable or disable syslog tracing

Methods

getAlarmServiceHostname()

public java.lang.String getAlarmServiceHostname()
get the alarm service host name

getAlarmServicePort()

public int getAlarmServicePort()
get the port number for the alarm service

getCtiRequestTimeout()

public int getCtiRequestTimeout()
get the timout for cti requests, other than the provider open (seconds)

getDebuggingNames()

public java.lang.String[] getDebuggingNames()
get names of supported debugging level jtapi traces

getDebuggingValue(String)

public boolean getDebuggingValue( java.lang.String debuggingName)
get the enabled or disabled state of a debugging level trace

getDesiredServerHeartbeatInterval()

public int getDesiredServerHeartbeatInterval()
get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.

getFileNameBase()

public java.lang.String getFileNameBase()
the filename for individual log files.

getFileNameExtension()

public java.lang.String getFileNameExtension()
get the filename extension for log files

getNumTraceFiles()

public int getNumTraceFiles()
number of trace files before rollover

getPeriodicWakeupEnabled()

public boolean getPeriodicWakeupEnabled()
get the enabled state of periodic wake up

getPeriodicWakeupInterval()

public int getPeriodicWakeupInterval()
get the interval for periodic wakeup (milliseconds)

getProviderOpenRequestTimeout()

public int getProviderOpenRequestTimeout()
get the timout for a provider open request (seconds)

getProviderRetryInterval()

public int getProviderRetryInterval()
get the interval at which the connection to the CTI Manager will ge retried (seconds)

getQueueSizeThreshold()

public int getQueueSizeThreshold()
Get the threshold for the event queue size to trigger alarms

getQueueStatsEnabled()

public boolean getQueueStatsEnabled()
get the enabled state of event queue stats

getRouteSelectTimeout()

public int getRouteSelectTimeout()
get the route select timeout (milliseconds)

getServices()

public java.lang.String[] getServices()
Returns the services that this implementation supports. Note: This is a static list administered in the jtapi.ini file. There is no automatic discovery mechanism to locate available cti services

getSyslogCollector()

public java.lang.String getSyslogCollector()
get the syslog collector hostname

getSyslogCollectorUDPPort()

public int getSyslogCollectorUDPPort()
get the syslog collector UDP port

getTraceDirectory()

public java.lang.String getTraceDirectory()
The directory in the path where trace files will be written

getTraceFileSize()

public int getTraceFileSize()
The size of the tracefiles before rollover

getTraceNames()

public java.lang.String[] getTraceNames()
get the names of supported jtapi traces

getTracePath()

public java.lang.String getTracePath()
get the path where the trace files will be located

getTraceValue(String)

public boolean getTraceValue( java.lang.String traceName)
get the enabled or disabled state of a trace

getUseAlarmService()

public boolean getUseAlarmService()
get the enabled/disabled state of the alarm service

getUseFileTrace()

public boolean getUseFileTrace()
get the enabled or disabled state of jtapi log file tracing

getUseJavaConsoleTrace()

public boolean getUseJavaConsoleTrace()
get the enabled or disabled state of jtapi console tracing

getUseSameDir()

public boolean getUseSameDir()
if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a seperate directory, indexed in sequence from the last directory written or available.

getUseSyslog()

public boolean getUseSyslog()
get the enabled or disabled state of syslog tracing

setAlarmServiceHostname(String)

public void setAlarmServiceHostname( java.lang.String hostname)
set the alarm service host name

setAlarmServicePort(int)

public void setAlarmServicePort(int portNumber)
set the port number the alarm service is listening on

setCtiRequestTimeout(int)

public void setCtiRequestTimeout(int seconds)
set the timeout for cti requests other than provider open (seconds)

setDebuggingValue(String, boolean)

public void setDebuggingValue( java.lang.String debuggingName, boolean value)
enable or disable a particular debugging level trace

setDesiredServerHeartbeatInterval(int)

public void setDesiredServerHeartbeatInterval(int seconds)
set the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.

setFileNameBase(String)

public void setFileNameBase( java.lang.String base)
set the filename for log files

setFileNameExtension(String)

public void setFileNameExtension( java.lang.String extn)
set the filename extension for log files

setNumTraceFiles(int)

public void setNumTraceFiles(int val)
set the number of trace files before rollover

setPeriodicWakeupEnabled(boolean)

public void setPeriodicWakeupEnabled(boolean enabled)
set the enable/disable state for periodic wake up

setPeriodicWakeupInterval(int)

public void setPeriodicWakeupInterval(int milliseconds)
set the periodic wake up interval (milliseconds)

setProviderOpenRequestTimeout(int)

public void setProviderOpenRequestTimeout(int seconds)
set the timeout for a provider open request (seconds)

setProviderRetryInterval(int)

public void setProviderRetryInterval(int seconds)
set the interval at which the connection to the CTI Manager will ge retried (seconds)

setQueueSizeThreshold(int)

public void setQueueSizeThreshold(int size)
Set the threshold for the event queue size to trigger alarms

setQueueStatsEnabled(boolean)

public void setQueueStatsEnabled(boolean enabled)
enable / disable event queue statistics

setRouteSelectTimeout(int)

public void setRouteSelectTimeout(int milliseconds)
set the route select timeout milliseconds

setServices(String[])

public void setServices( java.lang.String[] services)
set a list of available services

setSyslogCollector(String)

public void setSyslogCollector( java.lang.String value)
set the syslog collector hostname

setSyslogCollectorUDPPort(int)

public void setSyslogCollectorUDPPort(int port)
set the syslog collector UDP port

setTraceDirectory(String)

public void setTraceDirectory( java.lang.String dir)
Set the directory where jtapi trace files should be written

setTraceFileSize(int)

public void setTraceFileSize(int val)
Set the size of the trace file

setTracePath(String)

public void setTracePath( java.lang.String path)
set the directory root where jtapi traces will be written

setTraceValue(String, boolean)

public void setTraceValue( java.lang.String traceName, boolean value)
enable or disable a particular trace

setUseAlarmService(boolean)

public void setUseAlarmService(boolean value)
enable the alarm service

setUseFileTrace(boolean)

public void setUseFileTrace(boolean value)
enable or disable jtapi log file tracing

setUseJavaConsoleTrace(boolean)

public void setUseJavaConsoleTrace(boolean value)
enable or disable jtapi console tracing

setUseSameDir(boolean)

public void setUseSameDir(boolean value)
if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a seperate directory, indexed in sequence from the last directory written or available.

setUseSyslog(boolean)

public void setUseSyslog(boolean value)
enable or disable syslog tracing

CiscoJtapiVersion

Declaration

public class CiscoJtapiVersion
java.lang.Object
  |
  +-- com.cisco.jtapi.extensions.CiscoJtapiVersion

Description

This class gives the version information of the installed Cisco JTAPI . Programs can get the version number using the accessor methods. Cisco Jtapi Version is in a.b(x.y) format where a indicates the major version b indicates the minor version x indicates the revision number y indicates the build number

Member Summary
Constructors
 
Methods
java.lang.String
Returns 'release' if it is a release version or debug if it is not a release version
int
This returns the build number of the vesion
int
This method returns the major version number
int
This method returns the minor version number
int
This method returns the revision number of the version
java.lang.String
returns the version information in a.b(x.y) format without name
java.lang.String
returns the version information in a.b(x.y) format

Inherited Member Summary
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), wait(), wait(), wait()

Constructors

CiscoJtapiVersion()

public CiscoJtapiVersion()

Methods

getBuildDescription()

public java.lang.String getBuildDescription()
Returns 'release' if it is a release version or debug if it is not a release version

getBuildNumber()

public int getBuildNumber()
This returns the build number of the vesion

getMajorVersion()

public int getMajorVersion()
This method returns the major version number

getMinorVersion()

public int getMinorVersion()
This method returns the minor version number

getRevisionNumber()

public int getRevisionNumber()
This method returns the revision number of the version

getVersion()

public java.lang.String getVersion()
returns the version information in a.b(x.y) format without name

toString()

public java.lang.String toString()
returns the version information in a.b(x.y) format
Overrides:
toString in class Object

CiscoMediaCapability

Declaration

public class CiscoMediaCapability
java.lang.Object
  |
  +-- com.cisco.jtapi.extensions.CiscoMediaCapability

Direct Known Subclasses

Description

The CiscoMediaCapability object specifies the properties of a particular media format that an application can support for CiscoMediaTerminals that it registers. Because CiscoMediaCapability is an abstract class, applications may only construct its subclasses directly.

See Also:

Member Summary
Fields
static CiscoMediaCapability
G.711 capability with default parameters
static CiscoMediaCapability
G.723 capability with default parameters
static CiscoMediaCapability
G.729 capability with default parameters
static CiscoMediaCapability
GSM capability with default parameters
Constructors
 
CiscoMediaCapability(int, int) , int maxFramesPerPacket)
Constructs a CiscoMediaCapability object for the specified payload type and packet size.
Methods
int
Returns the packet size specified by this object.
int
Returns the payload type specified by this object.
java.lang.String

Inherited Member Summary
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), wait(), wait(), wait()

Fields

G711_64K_30_MILLISECONDS

public static final com.cisco.jtapi.extensions.CiscoMediaCapability G711_64K_30_MILLISECONDS
G.711 capability with default parameters

See Also:

G723_6K_30_MILLISECONDS

public static final com.cisco.jtapi.extensions.CiscoMediaCapability G723_6K_30_MILLISECONDS
G.723 capability with default parameters

See Also:

G729_30_MILLISECONDS

public static final com.cisco.jtapi.extensions.CiscoMediaCapability G729_30_MILLISECONDS
G.729 capability with default parameters

See Also:

GSM_80_MILLISECONDS

public static final com.cisco.jtapi.extensions.CiscoMediaCapability GSM_80_MILLISECONDS
GSM capability with default parameters

See Also:

Constructors

CiscoMediaCapability(int, int)

public CiscoMediaCapability(int payloadType, int maxFramesPerPacket)
Constructs a CiscoMediaCapability object for the specified payload type and packet size.

Methods

getMaxFramesPerPacket()

public int getMaxFramesPerPacket()
Returns the packet size specified by this object.
Returns:
the packet size, specified as a the number of frames within a single packet

getPayloadType()

public int getPayloadType()
Returns the payload type specified by this object.
Returns:
a payload type from the RTPPayload interface

toString()

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

CiscoMediaTerminal

Declaration

public interface CiscoMediaTerminal extends CiscoTerminal

All Superinterfaces

CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal

Description

A CiscoMediaTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoMediaTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoMediaTerminal is a logical telephony endpoint, which may be associated with any application that desires to terminate media. Such applications include voice mail systems, interactive voice response (IVR), and "soft" phones.

Note Only CTIPorts appear as CiscoMediaTerminals through JTAPI.


Terminating media is a two-step process. To terminate media for a particular terminal, an application adds an observer that implements the CiscoTerminalObserver interface using the Terminal.addObserver method. Finally, the application registers its IP address and port number to which the Terminal's incoming RTP streams are to be directed using the CiscoMediaTerminal.register method.

See Also:

Member Summary
Methods
void
Changes the default registration parameters to specified address and port.
boolean
This method returns true if the CiscoMediaTerminal is registered and false otherwise.
void
Registers a Terminal with the specified address and port, defaulting to G.711 64KHz u-law encoding with a thirty millisecond packet size.
void
The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state.
void
The CiscoMediaTerminal must not be registered and its Provider must be in the Provider.IN_SERVICE state.

Inherited Member Summary
Fields inherited from interface CiscoTerminal
Methods inherited from interface CiscoObjectContainer
Methods inherited from interface CiscoTerminal
Methods inherited from interface Terminal
addCallObserver(CallObserver), addObserver(TerminalObserver), getAddresses(), getCallObservers(), getCapabilities(), getName(), getObservers(), getProvider(), getTerminalCapabilities(Terminal, Address), getTerminalConnections(), removeCallObserver(CallObserver), removeObserver(TerminalObserver)

Methods

changeRTPDefaults(InetAddress, int)

public void changeRTPDefaults( java.net.InetAddress address, int port)
throws CiscoRegistrationException
Changes the default registration parameters to specified address and port. Only Registered application may invoke this method.
Parameters:
address - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
Throws:

isRegistered()

public boolean isRegistered()
This method returns true if the CiscoMediaTerminal is registered and false otherwise.

register(InetAddress, int)

public void register( java.net.InetAddress address, int port)
throws CiscoRegistrationException
Deprecated.
Registers a Terminal with the specified address and port, defaulting to G.711 64KHz u-law encoding with a thirty millisecond packet size.
Parameters:
address - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
Throws:

register(InetAddress, int, CiscoMediaCapability[])

public void register( java.net.InetAddress address, int port, com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities)
throws CiscoRegistrationException
The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal.
Method Arguments
This method has three arguments. The first argument specifies the internet address at which the RTP media stream for this Terminal will be terminated, the second indicates the UDP port at which RTP packets will be directed, and the final argument indicates the type of RTP encodings that the application is willing to support for this Terminal.
Method Post-conditions
This method returns successfully when the MediaTerminal is registered.
Parameters:
address - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
capabilities - the list of RTP encodings supported by this terminal
Throws:

unregister()

public void unregister()
throws CiscoUnregistrationException
The CiscoMediaTerminal must not be registered and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to unregister the MediaTerminal.
Method Post-conditions
This method returns successfully when the MediaTerminal is unregistered.
Throws:

CiscoObjectContainer

Declaration

public interface CiscoObjectContainer

All Known Subinterfaces

Description

The ApplicationObject interface allows applications to associate an application defined object to objects that implement this interface.

Member Summary
Methods
java.lang.Object
Gets the application-defined object.
java.lang.Object
Sets an application-defined object.

Methods

getObject()

public java.lang.Object getObject()
Gets the application-defined object.
Returns:
the CallID property of this Call

setObject(Object)

public java.lang.Object setObject( java.lang.Object reference)
Sets an application-defined object.
Returns:
the CallManagerID property of this Call

CiscoOutOfServiceEv

Declaration

public interface CiscoOutOfServiceEv extends CiscoEv

All Superinterfaces

CiscoEv, javax.telephony.events.Ev

All Known Subinterfaces

Description

The CiscoAddrOutOfServiceEv event


Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

CAUSE_CALLMANAGER_FAILURE

public static final int CAUSE_CALLMANAGER_FAILURE

CAUSE_CTIMANAGER_FAILURE

public static final int CAUSE_CTIMANAGER_FAILURE

CAUSE_DEVICE_FAILURE

public static final int CAUSE_DEVICE_FAILURE

CAUSE_DEVICE_UNREGISTERED

public static final int CAUSE_DEVICE_UNREGISTERED

CAUSE_NOCALLMANAGER_AVAILABLE

public static final int CAUSE_NOCALLMANAGER_AVAILABLE

CAUSE_REHOME_TO_HIGHER_PRIORITY_CM

public static final int CAUSE_REHOME_TO_HIGHER_PRIORITY_CM

CAUSE_REHOMING_FAILURE

public static final int CAUSE_REHOMING_FAILURE

ID

public static final int ID

CiscoProvCallParkEv

Declaration

public interface CiscoProvCallParkEv extends CiscoProvFeatureEv

All Superinterfaces

CiscoEv, CiscoProvEv, CiscoProvFeatureEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

Introduction
The CiscoTermSoftKeyPressedEv event

Member Summary
Fields
static int
ID
static int
Indicates that a call is parked
static int
Indicates that a call is unparked
static int
This event is due to call park
static int
This event is due to call park remainder
static int
This event is due to call being unparked
Methods
int
Returns an integer representation of this object
java.lang.String
This returns where the call is parked
java.lang.String
This returns the DN of the parked party
java.lang.String
This returns the DN of the parking party
int
This returns the reason of the event.
int
This returns the state of the call Possible states are CiscoProvCallParkEv.PARK_STATE_IDLE CiscoProvCallParkEv.PARK_STATE_ACTIVE

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface CiscoProvFeatureEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

PARK_STATE_ACTIVE

public static final int PARK_STATE_ACTIVE
Indicates that a call is parked

PARK_STATE_IDLE

public static final int PARK_STATE_IDLE
Indicates that a call is unparked

REASON_CALLPARK

public static final int REASON_CALLPARK
This event is due to call park

REASON_CALLPARKREMAINDER

public static final int REASON_CALLPARKREMAINDER
This event is due to call park remainder

REASON_CALLUNPARK

public static final int REASON_CALLUNPARK
This event is due to call being unparked

Methods

getintCallIDValue()

public int getintCallIDValue()
Returns an integer representation of this object

getParkDN()

public java.lang.String getParkDN()
This returns where the call is parked

getParkedParty()

public java.lang.String getParkedParty()
This returns the DN of the parked party

getParkingParty()

public java.lang.String getParkingParty()
This returns the DN of the parking party

getReason()

public int getReason()
This returns the reason of the event. Possible states are : CiscoProvCallParkEv.REASON_CALLPARK CiscoProvCallParkEv.REASON_CALLUNPARK CiscoProvCallParkEv.REASON_CALLPARKREMAINDER

getState()

public int getState()
This returns the state of the call Possible states are CiscoProvCallParkEv.PARK_STATE_IDLE CiscoProvCallParkEv.PARK_STATE_ACTIVE

CiscoProvEv

Declaration

public interface CiscoProvEv extends CiscoEv, javax.telephony.events.ProvEv

All Superinterfaces

CiscoEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

All Known Subinterfaces

Description

The CiscoProvEv interface, which extends JTAPI's core javax.telephony.events.ProvEv interface, serves as the base interface for all Cisco-extended JTAPI Provider events. Every Provider-related event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.ProvEv

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

CiscoProvFeatureEv

Declaration

public interface CiscoProvFeatureEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

All Known Subinterfaces

Member Summary
Methods
int
Feature ID for which application is interested in receiving events

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Methods

getFeatureID()

public int getFeatureID()
Feature ID for which application is interested in receiving events

CiscoProvFeatureID

Declaration

public interface CiscoProvFeatureID

Member Summary
Fields
static int

Fields

MONITOR_CALLPARK_DN

public static final int MONITOR_CALLPARK_DN

CiscoProvFeatureUnRegisteredEv

Declaration

public interface CiscoProvFeatureUnRegisteredEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoProvFeatureUnRegisteredEv event This event indicates the unregistration of a particular feature by Cisco CallManager

Member Summary
Fields
static int
ID
Methods
int
FeatureID for which application will no longer receive events

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getFeatureID()

public int getFeatureID()
FeatureID for which application will no longer receive events

CiscoProvider

Declaration

public interface CiscoProvider extends javax.telephony.Provider, CiscoObjectContainer

All Superinterfaces

CiscoObjectContainer, javax.telephony.Provider

Description

Member Summary
Methods
void
Deletes an un used call created by createCall().
boolean
Returns the current state of the callback guard feature
CiscoMediaTerminal
Returns an instance of the CiscoMediaTerminal class which corresponds to the given name.
CiscoMediaTerminal[]
Returns an array of CiscoMediaTerminals associated with the Provider and within the Provider's domain.
java.lang.String
Returns the current version of provider running if provider is inservice otherwise it will return empty string
void
used to register for a particular feature for which application will get Provider events.
void
Enables or disables try/ catch logic for observer callbacks
void
used to unregister a particular feature.

Inherited Member Summary
Fields inherited from interface Provider
IN_SERVICE, OUT_OF_SERVICE, SHUTDOWN
Methods inherited from interface CiscoObjectContainer
Methods inherited from interface Provider
addObserver(ProviderObserver), createCall(), getAddress(String), getAddressCapabilities(Terminal), getAddressCapabilities(Terminal), getAddresses(), getCallCapabilities(Terminal, Address), getCallCapabilities(Terminal, Address), getCalls(), getCapabilities(), getConnectionCapabilities(Terminal, Address), getConnectionCapabilities(Terminal, Address), getName(), getObservers(), getProviderCapabilities(Terminal), getProviderCapabilities(Terminal), getState(), getTerminal(String), getTerminalCapabilities(Terminal), getTerminalCapabilities(Terminal), getTerminalConnectionCapabilities(Terminal), getTerminalConnectionCapabilities(Terminal), getTerminals(), removeObserver(ProviderObserver), shutdown()

Methods

deleteCall(Call)

public void deleteCall( javax.telephony.Call call)
throws InvalidStateException
Deletes an un used call created by createCall(). An exception is generated if the call is not in IDLE state or if provider is not in Provider.IN_SERVICE state. Applications may use this interface to move un used calls to INVALID state and reclaim resources alloacated to the call.
Pre-conditions:
1. this.getState() == Provider.IN_SERVICE
2. call.getState() == Call.IDLE
Post-conditions: