Table Of Contents

Cisco JTAPI Implementation

Cisco JTAPI Extensions Hierarchy

Class Hierarchy

class java.lang.Object

Interface Hierarchy

Class com.cisco.jtapi.extensions

CiscoAddrAddedToTerminalEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrAutoAcceptStatusChangedEv

Declaration

All Superinterfaces

Description

Fields

Methods

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

Methods

CiscoAddrOutOfServiceEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrRemovedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrRemovedFromTerminalEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoCall

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Methods

CiscoCallChangedEv

Declaration

All Superinterfaces

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

CiscoJtapi Version

Declaration

Description

Constructors

Methods

CiscoMediaCapability

Declaration

Direct Known Subclasses

Description

Fields

Constructors

Methods

CiscoMediaOpenLogicalChannelEv

Declaration

All Known Subinterfaces

Description

Fields

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

Description

Fields

CiscoProvFeatureUnRegisteredEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoProvider

Declaration

All Superinterfaces

Description

Methods

CiscoProviderCapabilities

Declaration

All Superinterfaces

Description

Methods

CiscoProviderObserver

Declaration

All Superinterfaces

Description

CiscoRegistrationException

Declaration

All Implemented Interfaces

Description

Constructors

CiscoRouteAddress

Declaration

All Superinterfaces

Methods

CiscoRouteSession

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRouteTerminal

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRouteUsedEvent

Declaration

All Superinterfaces

Description

Methods

CiscoRTPBitRate

Declaration

Description

Fields

CiscoRTPHandle

Declaration

Description

Methods

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

CiscoTermButtonPressedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermConnPrivacyChangedEv

Declaration

Description

Fields

Methods

CiscoTermCreatedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermDataEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermDeviceStateActiveEv

Declaration

All Super-Interfaces

Description

Methods

CiscoTermDeviceStateAlertingEv

Declaration

All Super-Interfaces

Description

Methods

CiscoTermDeviceStateHeldEv

Declaration

All Super-Interfaces

Description

Methods

CiscoTermDeviceStateIdleEv

Declaration

All Superinterfaces

Description

Methods

CiscoTermEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoTermEvFilter

Declaration

Description

Methods

CiscoTerminal

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Fields

Methods

CiscoTerminalConnection

Declaration

All Superinterfaces

Description

Methods

CiscoTerminalObserver

Declaration

All Superinterfaces:

Description

CiscoTermInServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoTermOutOfServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoTermRegistrationFailedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermRemovedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoToneChangedEv

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

CiscoWideBandMediaCapability

Description

Fields

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.)

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.

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.

CiscoAddrAddedToTerminalEv

Declaration

public interface CiscoAddrAddedToTerminalEv extends CiscoProvEv

All Superinterfaces

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

Description

The CiscoAddrAddedToTerminalEv event gets sent under the following conditions:

•When User adds a Terminal/Device into the user controlList that contains SharedDN, this event will be sent to application. If a user has an address in control list, and we add new device with same address in control list, this event will be sent.

•When EM(Extension mobility) user logs into a Terminal with a profile that contains SharedDN, this event notifies that a new Terminal is added to an already existing Address.

•A new SharedDN is added to a Device in a user control list. Interface getTerminal() returns the terminal that gets added to Address. Interface getAddress() will return the address on which the new terminal is added.

Member Summary
Fields
static int	ID
Methods
javax.telephony.Address	getAddress()
javax.telephony.Terminal	getTerminal()

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()

getTerminal()

public javax.telephony.Address getTerminal()

CiscoAddrAutoAcceptStatusChangedEv

Declaration

public interface CiscoAddrAutoAcceptStatusChangedEv extends 
CiscoAddrEv

All Superinterfaces

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

Description

The CiscoAddrAutoAcceptStatusChangedEv event is send to Applications whenever AutoAccept status for the Address on the Terminal is changed. If an Address has multiple Terminals, then this event will be sent for Address's AutoAccept status on each individual Terminals.

Member Summary
Fields
static int	ID
Methods
int	getAutoAcceptStatus() CiscoAddrAutoAcceptStatusChangedEv.getAutoAcceptStatus() returns following value of AutoAccept status of Address on Terminal CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON
CiscoTerminal	getTerminal() Returns the terminal at which this address is going InService.

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

Methods

getAutoAcceptStatus()

public int getAutoAcceptStatus()

CiscoAddrAutoAcceptStatusChangedEv.getAutoAcceptStatus() returns following value of AutoAccept status of Address on Terminal CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON

See Also:

CiscoAddress.getAutoAcceptStatus()

getTerminal()

public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()

Returns the terminal at which this address is going InService

In Shared Lines, applications may receive multiple CiscoAddressInService events and the same Address appears on different Terminals. In order for Application to find out which Shared Line is going in service, Applications can use this interface. This interface returns the terminal on which Address is going in Service.

Returns:

the terminal at which this address is going InService

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	getAddress()

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	AUTOACCEPT_OFF AutoAccept is off.
static int	AUTOACCEPT_ON AutoAccept is on.
static int	EXTERNAL This is an external address with a valid name.
static int	EXTERNAL_UNKNOWN This is an external address with an unknown name.
static int	IN_SERVICE The address is out-of-service
static int	INTERNAL This is an internal address.
static int	OUT_OF_SERVICE The address is in-service
static int	RINGER_DEFAULT Sets the ringer status to configured value
static int	RINGER_DISABLE Disables the ringer for the address
static int	RINGER_ENABLE Enables the ringer for the address
static int	UNKNOWN This is an external address with an unknown name.
Methods
void	clearCallConnections() Use this interface to clear off any phantom calls on the address
CiscoAddressCallInfo	getAddressCallInfo(Terminal) Use this Interface to get info of calls present at the terminal
int	getAutoAcceptStatus(Terminal) Returns the AutoAccept status of the Address on the terminal
javax.telephony.Terminal	getInServiceAddrTerminals() Returns an array of terminals for which this address is InService.
int	getRegistrationState() Returns the state of this address.
int	getState() Returns the state of this address.
int	getType() Returns the type of this address.
void	setAutoAcceptStatus(int, Terminal) Allows the application to enable AutoAccept for addresses on CiscoMediaTerminal and/or CiscoRouteTerminal.
void	setMessageWaiting(java.lang.String destination, boolean enable) Specifies whether the message-waiting indicator should be activated or deactivated for the Address specified by the destination.
void	setRingerStatus(int) 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
getObject(), setObject(Object)

Fields

AUTOACCEPT_OFF

public static final int AUTOACCEPT_OFF

AutoAccept is off.

AUTOACCEPT_ON

public static final int AUTOACCEPT_ON

AutoAccept is on.

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

getAutoAcceptStatus(Terminal)

public void getAutoAcceptStatus(javax.telephony.Terminal terminal)

throws PlatformException, InvalidStateException, MethodNotSuppo
rtedException, 

CiscoAddress.getAutoAccept(Terminal iterminal) returns AutoAccept status of Address on Terminal. It may return one of the following constants: CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON.

Pre-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Post-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Parameters:

terminal - Terminal on which AutoAccept status of Address will be returned.

Throws:

javax.telephony.InvalidStateException - The Provider is not "in service".

javax.telephony.PlatformException - Terminal is not on the Address.

javax.telephony.MethodNotSupportedException - This method is not supported ExtraProviderAddresses.

getInServiceAddrTerminals()

public javax.telephony.Terminal[] getInServiceAddrTerminals() 

Use this interface to find out which Shared Lines are in service. In Shared Lines, the same address appears on different Terminals.

Returns:

an array of terminals on which address is in service

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

setAutoAcceptStatus(int, Terminal)

public void getAutoAcceptStatus(int autoAcceptStatus, 
javax.telephony.Terminal terminal)

throws PlatformException, InvalidStateException, MethodNotSuppo
rtedException

This allows Application to enable AutoAccept for Addresses on CiscoMediaTerminal and/or CiscoRouteTerminal. Addresses on CiscoTerminal other than CiscoMediaTerminal or CiscoRouteTerminal will always have AutoAccept on. If Terminal passed in the parameter is not CiscoMediaTerminal or CiscoRouteTerminal, it will throw exception. For the CiscoMediaTerminal that have Shared Address with CiscoTerminal, it is recommended to enable AutoAccept on CiscoMediaTerminal.

Pre-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Post-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Parameters:

value - Can be either CiscoAddress.AUTOACCEPT_OFF or CiscoAddress.AUTOACCEPT_ON. If autoAcceptStatus is AUTOACCEPT_ON, it will enable AutoAccept for address on Terminal. If autoAcceptStatus is AUTOACCEPT_OFF, it will disable AutoAccept for address on Terminal.

terminal. - It the terminal on which AutoAccept will be enabled

Throws:

javax.telephony.InvalidStateException - The Provider is not "in service".

javax.telephony.PlatformException - Terminal is not on the Address.

javax.telephony.MethodNotSupportedException - This method is not supported ExtraProviderAddresses.

setMessageWaiting(java.lang.String destination, boolean enable)

public void setMessageWaiting(java.lang.String destination, 
boolean enable)

throws MethodNotSupportedException, InvalidStateException, Priv
ilegeViolationException

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 privileges to invoke the message waiting indicator for this destination

setRingerStatus(int)

public void setRingerStatus(int status)

throws MethodNotSupportedException, InvalidStateException, Inva
lidArgumentException

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[]	getCalls()
int	getMaxActiveCalls()
int	getMaxCallsOnHold()
int	getNumActiveCalls()
int	getNumCallsOnHold()

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:

CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv

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

CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv

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
Methods
CiscoTerminal	getTerminal() Returns the terminal at which this address is going InService.

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

Methods

getTerminal()

public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()

Returns the terminal at which this address is going InService

In Shared Lines, applications may receive multiple CiscoAddressInService events and the same Address appears on different Terminals. In order for Application to find out which Shared Line is going in service, Applications can use this interface. This interface returns the terminal on which Address is going in Service.

Returns:

the terminal at which this address is going InService

See Also:

CiscoAddress.getInServiceAddressTerminal()

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
Methods
CiscoTerminal	getTerminal() Returns the terminal at which this address is going OutOfService.

Inherited Member Summary
Fields inherited from interface CiscoOutOfServiceEv
CAUSE_CALLMANAGER_FAILURE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DEVICE_FAILURE, CAUSE_DEVICE_UNREGISTERED, CAUSE_NOCALLMANAGER_AVAILABLE, CAUSE_REHOME_TO_HIGHER_PRIORITY_CM, CAUSE_REHOMING_FAILURE
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

Methods

getTerminal()

public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()

Returns the terminal at which this address is going OutOfService

In Shared Lines, applications may receive multiple CiscoAddressOutOfService events and the same Address appears on different Terminals. Applications use this interface to find out which Shared Line is going out of service.

Returns:

the terminal at which this address is going OutOfService

See Also:

CiscoAddress.getInServiceAddressTerminal()

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	getAddress()

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()

CiscoAddrRemovedFromTerminalEv

Declaration

public interface CiscoAddrRemovedEv extends CiscoProvEv

All Superinterfaces

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

Description

The CiscoAddrRemovedFromTerminalEv event gets sent under the following conditions:

•When User removes a Terminal/Device into the user controlList that contains SharedDN, this event will be sent to application. If a user has an address in control list, and we remove a device with same address in control list, this event will be sent.

•When EM(Extension mobility) user logs out from Terminal with a profile that contains SharedDN, this event notifies that one of the Terminals is removed from an existing Address.

•A new SharedDN is removed from a Device in a user control list. Interface getTerminal() returns the terminal that is removed from the Address. Interface getAddress() will return the address from where the terminal is removed.

Member Summary
Fields
static int	ID
Methods
javax.telephony.Address	getAddress()

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()

getTerminal()

public javax.telephony.Terminal getTerminal()

CiscoCall

Declaration

public interface CiscoCall extends

javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer

All Superinterfaces

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

All Known Subinterfaces

CiscoConsultCall

Description

The CiscoCall interface extends the CallControlCall interface with additional CallManager-specific capabilities.

In Cisco 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
void	conference(Call[]) Merges N calls together, resulting in the union of the participants of all the calls being placed on a single call.
javax.telephony.Connection []	connect(Terminal, Address, String, CiscoRTPParams) From the CallEvent perspective, this method behaves similar to Call.connect(Terminal terminal, Address origaddr, String dialedDigits).
boolean	getCalledAddressPI() Returns Presentation Indicator(PI) associated with getCalledAddressPI. If it returns true, Application can display this Address name to end users. If it returns false, Applications should not display this Address name to end user.
CiscoCallID	getCallID() CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.
boolean	getCallingAddressPI() Returns Presentation Indicator(PI) associated with getCallingAddressPI. If it returns true, Application can display this Address name to end users. If it returns false, Applications should not display this Address name to the end user.
javax.telephony.Address	getCurrentCalledAddress() Returns the current calling address for the call.
boolean	getCurrentCalledAddressPI() Returns Presentation Indicator(PI) associated with CurrentCalledAddress. If it returns true, Application can display this Address to end users. If it returns false, Applications should not display this Address name to end user.
boolean	getCurrentCallingDisplayNamePI() Returns Presentation Indicator(PI) associated with getCurredCalledDisplayNamePI. If it returns true, Application can display this DisplayName to end users. If it returns false, Applications should not display this DisplayName to end user.
java.lang.String	getCurrentCalledPartyDisplayName() This interface returns the display of the called party in the call.
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. For example, in the CiscoJtapi implementation, CallControlCall.getCallingAddress() returns the first calling party of the call.
boolean	getCurrentCallingAddressPI() returns Presentation Indicator(PI) associated with getCurrentCallingAddressPI If it returns true, Application can display this Address name to end users if it returns false, Applications should not display this Address name to end user
boolean	getCurrentCallingDisplayNamePI() returns Presentation Indicator(PI) associated with getCurrentCalledDisplayNamePI If it returns true, Application can display this DisplayName to end users if it returns false, Applications should not display this DisplayName to end user
java.lang.String	getCurrentCallingPartyDisplayName() This interface returns the display name of the calling party.
boolean	getLastRedirectingAddressPI() returns Presentation Indicator(PI) associated with getLastRedirectingAddressPI If it returns true, Application can display this Address name to end users if it returns false, Applications should not display this Address name to end user
javax.telephony.Address	getModifiedCalledAddress() This interface returns modified called address for the call if an application modifies its calling party using from selectRoute API.
javax.telephony.Address	getModifiedCallingAddress() This interface returns modified calling address for the call if an application modifies its calling party using from selectRoute API.
javax.telephony.Connection	transfer(String, String, String) This method overloads the CallControlCall.transfer(String) method.

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
getObject(), setObject(Object)

Methods

conference(Call[])

public void

converence(javax.telephony.Call[] otherCalls)

Throws:

InvalidStateException, InvalidArgumentException, MethodNotSupportedE xception, PrivilegeViolationException, ResourceUnavailableException

Merges N Calls together, resulting in the union of the participants of all the Calls being placed on a single Call. This method takes list of Calls as argument, referred to hereafter as the "secondary" Calls. All of the participants from the secondary call are moved to the Call on which this method is invoked.

The Conference Controller

In order for the conferencing feature to happen, there must be a common participant to all the Calls, as represented by a single Terminal and multiple TerminalConnections, one on all of the Calls. These TerminalConnections are known as the conference controllers. In the real-world, only one of the Calls would be active with respect to the controlling Terminal, and hence, the TerminalConnection on the secondary Call should be in the CallControlTerminalConnection.HELD state. The N conference controlling TerminalConnections are merged into one as a result of this method.

Applications may control which TerminalConnection acts as the conference controller via the CallControlCall.setConferenceController() method. The CallControlCall.getConferenceController() method returns the current conference controller, null if there is none. If no conference controller is set, the implementation chooses a suitable TerminalConnection when the conferencing feature is invoked.

The Telephone Call Argument

All of the participants from the secondary Calls, passed as the argument to this method, are "moved" to the Call on which this method was invoked. That is, new Connections and TerminalConnections are created on this Call which are found on the secondary Calls. Those Connections and TerminalConnections on the secondary Calls are removed from the Call and the Call moves into the Call.INVALID state.

The conference controller TerminalConnections are merged into one on this Call. That is, the existing TerminalConnection controller on this Call remains unchanged, while the TerminalConnection on the secondary Calls gets removed from that Call.

Other Shared Participants

There may exist Address and Terminals which are part of some telephone calls in addition to the designated conference controller. In these instances, those participants which are shared between both Calls are merged into one. That is, the Connections and TerminalConnections on this Calls are left unchanged. The corresponding Connections and TerminalConnections on the secondary Calls are removed from that Call.

Pre-conditions:

1. Let tc1 be the conference controller on this Call

2. Let connection1 = tc1.getConnection()

3. Let tc2 to tcN be the conference controllers on otherCalls

4. (this.getProvider()).getState() == Provider.IN_SERVICE

5. (this.getState() == Call.ACTIVE

6. tc1.getTerminal() == tc2.getTerminal()...=tcN.getTerminal

7. tc1.getCallControlState() == CallControlTerminalConnection.TALKING/HELD

8. tc2-tcN.getCallControlState() == CallControlTerminalConnection.HELD/TALKING

9. this != otherCalls

Post-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. this.getState() == Call.ACTIVE

3. otherCall.getState() == INVALID

4. Let c[] be the Connections to be merged from otherCall

5. Let tc[] be the TerminalConnections to be merged from otherCall

6. Let new(c) be the set of new Connections created on this Call

7. Let new(tc) be the set of new TerminalConnections created on this Call

8. new(c) element of this.getConnections()

9. new(c).getCallState() == c.getCallState()

10. new(tc) element of (this.getConnections()).getTerminalConnections()

11. new(tc).getCallState() == tc.getCallState()

12. c[i].getCallControlState() == CallControlConnection.DISCONNECTED for all i

13. tc[i].getCallControlState() == CallControlTerminalConnection.DROPPED for all i

14. CallInvalidEv is delivered for otherCall

15. CallCtlConnDisconnectedEv/ConnDisconnectedEv is delivered for all c[i]

16. CallCtlTermConnDroppedEv/TermConnDroppedEv is delivered for all tc[i]

17. ConnCreatedEv is delivered for all new(c)

18. TermConnCreatedEv is delivered for all new(tc)

19. Appropriate events are delivered for all new(c) and new(tc)

Parameters:

otherCall - The second Call which to merge with this Call object.

Throws:

javax.telephony.InvalidArgumentException - The Call object provided is not valid for the conference

javax.telephony.InvalidStateException - Either the Provider is not "in service", the Call is not "active", or the conference controllers are not in the proper state.

javax.telephony.MethodNotSupportedException - This method is not supported by the implementation.

javax.telephony.PrivilegeViolationException - The application does not have the proper authority to invoke this method.

javax.telephony.ResourceUnavailableException - An internal resource necessary for the successful invocation of this method is not available.

See Also:

javax.telephony.events.ConnCreatedEv, javax.telephony.events.TermConnCreatedEv, javax.telephony.events.ConnDisconnectedEv, javax.telephony.events.TermConnDroppedEv, javax.telephony.events.CallInvalidEv, javax.telephony.callcontrol.events.CallCtlConnDisconnectedEv, javax.telephony.callcontrol.events.CallCtlTermConnDroppedEv

connect(Terminal, Address, String, CiscoRTPParams)

public javax.telephony.Connection[]

connect(javax.telephony.Terminal origterm, 
javax.telephony.Address origaddr, java.lang.String 
dialedDigits, com.cisco.jtapi.extensions.CiscoRTPParams 
rtpParams)throws ResourceUnavailableException, 
PrivilegeViolationException, InvalidPartyException, 
InvalidArgumentException, InvalidStateException, MethodNotSup 
portedException

From CallEvent perspective, this method behaves similar to Call.connect(Terminal terminal, Address origaddr, String dialedDigits). This method may only be invoked when making a call from CiscoMediaTerminal want to specify media parameters for this call. Establishes the media at the specified CiscoRTPParams parameters if the request is successful.

Throws:

javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidPartyException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException

getCalledAddressPI()

public boolean getCallAddressPI()

Returns Presentation Indicator (PI) associated with getCalledAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

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

getCallingAddressPI()

public boolean getCallingAddressPI()

Returns Presentation Indicator (PI) associated with getCallingAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

getCurrentCalledAddress()

public javax.telephony.Address getCurrentCalledAddress()

This interface returns current calling address for the call this will return updated called address every time call gets redirected or transferred.

For example, in the CiscoJtapi implementation, CallControlCall.getCalledAddress() returns the first called party of the call.

getCurrentCalledAddressPI()

public javax.telephony.Address getCurrentCalledAddressPI()

Returns Presentation Indicator (PI) associated with getCalledAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

getCurrentCalledDisplayNamePI()

public boolean getCurrentCalledDisplayNamePI()

Returns Presentation Indicator (PI) associated with CurrentCalledAddress. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

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 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

getCurrentCallingAddressPI()

public boolean getCurrentCallingAddressPI()

Returns Presentation Indicator(PI) associated with getCurrentCallingAddress. If it returns true, Application can display this Address to end users. If it returns false, Applications should not display this Address name to end user

getCurrentCallingDisplayNamePI()

public boolean getCurrentCallingDisplayNamePI()

Returns Presentation Indicator(PI) associated with getCurrentCalledDisplayNamePI. If it returns true, Application can display this DisplayName to end users. If it returns false, Applications should not display this DisplayName to end user

getCurrentCallingPartyDisplayName()

public java.lang.String getCurrentCallingPartyDisplayName()

This interface returns the display name of the calling party. It returns null if display name is unknown.

getLastRedirectingAddressPI()

public boolean getLastRedirectingAddressPI()

Returns Presentation Indicator(PI) associated with getLastRedirectingAddressPI. If it returns true, Application can display this Address name to end users. If it returns false, Applications should not display this Address name to end user

getModifiedCalledAddress()

public javax.telephony.Address getModifiedCalledAddress()

This interface returns modified called address for the call if an application modifies its calling party using from selectRoute API. However, this information may not be accurate if an application is only controlling the Route Point that is modifying the calling number. If no modified calling number is performed, this is similar to getCurrentCalledAddress interface. Typically, this is varied from getCurrentCalledAddress when a feature is invoked after modified calling number modifications.

Usage:

 if ( call instanceof CiscoCall ) {

Address currentCalled = ((CiscoCall)call).getModifiedCalledAddress 
();

 }

See Also:

javax.telephony.callcontrol.CallControlCall

getModifiedCallingAddress()

public javax.telephony.Address getModifiedCallingAddress()

This interface returns modified calling address for the call if an application modifies its calling party using from selectRoute API. However, this information may not be accurate if an application is only controlling the RP that is modifying the calling number. If no modified calling number is performed, this is similar to getCurrentCallingAddress interface.

Usage:

 if ( call instanceof CiscoCall ) {

Address currentCalled = 
((CiscoCall)call).getModifiedCallingAddress ();

 }

See Also:

javax.telephony.callcontrol.CallControlCall

transfer(String, String, String)

javax.telephony.Connection transfer

(java.lang.String destinationAddress, java.lang.String facCode, 
java.lang.String cmcCode) 

This method overloads the CallControlCall.transfer(String) method. It takes two new parameters: facCode and cmcCode. The facCode is the forced authorization code (FAC), and cmcCode is the client matter code (CMC).

See Also:

javax.telephony.callcontrol.CallControlCall

CiscoCallChangedEv

Declaration

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

All Superinterfaces

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

Description

The CiscoCallChangedEv event is delivered to the call observer whenever the Global Call ID (GCID) of the call is changed due to path replacement. In the case of shared lines, multiple CiscoCallChangedEv events would be delivered.

Member Summary
Methods
CiscoCall	getSurvivingCall() Returns a reference to the new call, which would be the surviving call.
CiscoCall	getOriginalCall() Returns a reference to the old call, which will go to INVALID state.
	getCiscoCause() Returns CiscoCaqllEv.CAUSE_QSIG_PR when GCID is changed QSIG Path replacement.
CiscoConnection	getConnection() Returns the connection of the call on which the change has occurred.
TerminalConnection	getTerminalConnection() Returns the terminal connection of the on which the GCID has changed. A Null is returned if there is no terminal connection.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, 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
getCiscoCause()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Methods

getSurvivingCall()

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

Returns a reference to the new call, which would be the surviving call.

getOriginalCall()

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

Returns a reference to the old call, which will go to INVALID state.

getCiscoCause()

public int getCiscoCause()

Returns CiscoCallEv.CAUSE_QSIG_PR when the GCID is changed by QSIG path replacement.

getConnection()

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

Returns the connection of the call on which the change has occurred.

getTerminalConnection()

public javax.telephony.TerminalConnection getTerminalConnection()

Returns the terminal connection of the call on which the GCID has changed. A Null is returned if there is no terminal connection.

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

CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoTransferEndEv, CiscoTransferStartEv, CiscoCallChangedEv

Description

The CiscoCallEv interface, which extends the JTAPI 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	CAUSE_ACCESSINFORMATIONDISCARDED
static int	CAUSE_BARGE
static int	CAUSE_BCBPRESENTLYAVAIL
static int	CAUSE_BCNAUTHORIZED
static int	CAUSE_BEARERCAPNIMPL
static int	CAUSE_CALLBEINGDELIVERED
static int	CAUSE_CALLIDINUSE
static int	CAUSE_CALLMANAGER_FAILURE
static int	CAUSE_CALLREJECTED
static int	CAUSE_CALLSPLIT
static int	CAUSE_CHANTYPENIMPL
static int	CAUSE_CHANUNACCEPTABLE
static int	CAUSE_CTIMANAGER_FAILURE
static int	CAUSE_DESTINATIONOUTOFORDER
static int	CAUSE_DESTNUMMISSANDDCNOTSUB
static int	CAUSE_FACILITYREJECTED
static int	CAUSE_IDENTIFIEDCHANDOESNOTEXIST
static int	CAUSE_IENIMPL
static int	CAUSE_INBOUNDBLINDTRANSFER
static int	CAUSE_INBOUNDCONFERENCE
static int	CAUSE_INBOUNDTRANSFER
static int	CAUSE_INCOMINGCALLBARRED
static int	CAUSE_INCOMPATABLEDDESTINATION
static int	CAUSE_INTERWORKINGUNSPECIFIED
static int	CAUSE_INVALIDCALLREFVALUE
static int	CAUSE_INVALIDIECONTENTS
static int	CAUSE_INVALIDMESSAGEUNSPECIFIED
static int	CAUSE_INVALIDNUMBERFORMAT
static int	CAUSE_INVALIDTRANSITNETSEL
static int	CAUSE_MANDATORYIEMISSING
static int	CAUSE_MSGNCOMPATABLEWCS
static int	CAUSE_MSGTYPENCOMPATWCS
static int	CAUSE_MSGTYPENIMPL
static int	CAUSE_NETOUTOFORDER
static int	CAUSE_NOANSWERFROMUSER
static int	CAUSE_NOCALLSUSPENDED
static int	CAUSE_NOCIRCAVAIL
static int	CAUSE_NOERROR
static int	CAUSE_NONSELECTEDUSERCLEARING
static int	CAUSE_NORMALCALLCLEARING
static int	CAUSE_NORMALUNSPECIFIED
static int	CAUSE_NOROUTETODDESTINATION
static int	CAUSE_NOROUTETOTRANSITNET
static int	CAUSE_NOUSERRESPONDING
static int	CAUSE_NUMBERCHANGED
static int	CAUSE_ONLYRDIVEARERCAPAVAIL
static int	CAUSE_OUTBOUNDCONFERENCE
static int	CAUSE_OUTBOUNDTRANSFER
static int	CAUSE_PROTOCOLERRORUNSPECIFIED
static int	CAUSE_QUALOFSERVNAVAIL
static int	CAUSE_RECOVERYONTIMEREXPIRY
static int	CAUSE_REDIRECTED
static int	CAUSE_REQCALLIDHASBEENCLEARED
static int	CAUSE_REQCIRCNAVIL
static int	CAUSE_REQFACILITYNIMPL
static int	CAUSE_REQFACILITYNOTSUBSCRIBED
static int	CAUSE_RESOURCESNAVAIL
static int	CAUSE_RESPONSETOSTATUSENQUIRY
static int	CAUSE_SERVNOTAVAILUNSPECIFIED
static int	CAUSE_SERVOPERATIONVIOLATED
static int	CAUSE_SERVOROPTNAVAILORIMPL
static int	CAUSE_SUSPCALLBUTNOTTHISONE
static int	CAUSE_SWITCHINGEQUIPMENTCONGESTION
static int	CAUSE_TEMPORARYFAILURE
static int	CAUSE_UNALLOCATEDNUMBER
static int	CAUSE_USERBUSY
Methods
int	getCiscoCause() 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_BARGE

public static final int CAUSE_BARGE

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

CiscoObjectContainer

Description

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

Member Summary
Methods
CiscoCall	getCall()
int	getCallManagerID() returns the call manager nodeID of the call
int	getGlobalCallID() returns the GlobalCallID of the call
int	intValue() 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
getObject(), setObject(Object)

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	getConferenceControllerAddress() Returns the Address, which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.Call	getConferencedCall() Returns the call that have merged.
javax.telephony.Call[]	getFailedCalls() Returns a list of the calls that could not be conferenced.
javax.telephony.Call	getFinalCall() Returns the call that remains active after the conference completes.
javax.telephony.TerminalCo nnection	getHeldConferenceController() Returns the TerminalConnection, which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.TerminalCo nnection[]	getHeldConferenceControllers() Returns the TerminalConnection, which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.TerminalCo nnection	getTalkingConferenceController() Returns the TerminalConnection, which currently acts as the conference controller for this call —- the initiating call.
boolean	isSuccess() Returns True or False depending on whether Conference is successful or failed.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, 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
getCiscoCause()
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.

getFailedCalls()

public favax.telephony.Call[] getFailedCalls{}

Returns the list of the calls that could not be conferenced.

Returns:

Null, if conference is successful.

See Also:

isSuccess()

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.

getHeldConferenceControllers()

public javax.telephony.TerminalConnection[]

getHeldConferenceControllers()

Returns the TerminalConnection which currently acts as the conference controller for this call: the initiating call. This is the TerminalConnection that was in the HELD state. This method returns null if the conference controller is not being observed. This method returns the first held Controller for multiple call join scenario.

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.

isSuccess()

public boolean isSuccess()

Returns True or False depending on whether the Conference successful or failed. Application can use interface to find whether Conference is successful. The following are defined as Conference Fail:

•If application issues request Call.conferece(otherCalls[]) this Conference would be considered failed, if one or more than one Calls could Join into Conference. Application can use interface getFailedCalls() to find Failed Call.

•If no Conference Bridge available and conference could not be completed at all. Again Application can use interface getFailedCalls() to get list of Calls that could not Join into Conference.

•Party being Conferenced Dropped out before conference could be completed.

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	getConferenceControllerAddress() Returns the Address which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.Call	getConferencedCall() Returns the call that will be conferenced.
javax.telephony.Call[]	getConferencedCalls() Returns the list of the calls that will be conferenced.
javax.telephony.Call	getFinalCall() Returns the call that will remain active after the conference is completed.
javax.telephony.TerminalCo nnection	getHeldConferenceController() Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call.
javax.telephony.TerminalCo nnection[]	getHeldConferenceControllers() Returns the TerminalConnection that currently acts as the conference controller for this call — the initiating call.
javax.telephony.TerminalCo nnection	getTalkingConferenceController() 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_BARGE, 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
getCiscoCause()
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.

getConferencedCalls()

public javax.telephony.Call getConferencedCalls()

Returns the list of calls that will be conferenced. This is the call that will be merged into the final 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 that 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.

getHeldConferenceControllers()

public javax.telephony.TerminalConnection

getHeldConferenceControllers()

Returns the TerminalConnection that 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. This method returns all held controllers joining into the finalCall.

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	ADDRESS_SEARCH_SPACE This indicates that the redirect should be done using the search space of the redirect controller's address.
static int	CALLED_ADDRESS_DEFAULT This option indicates that the default behavior for Cisco JTAPI should apply.
static int	CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION This option indicates that the calledAddress should be reset to the redirect destination.
static int	CALLED_ADDRESS_UNCHANGED This option indicates that the calledAddress should remain unchanged after the redirect operation.
static int	CALLINGADDRESS_SEARCH_SPACE This indicates that the redirect should be done using the search space of the calling address.
static int	DEFAULT_SEARCH_SPACE This indicates that the redirect should be done using the search space that is the default for the implementation.
static int	REASON_DIRECTCALL This Connection was the result of a direct call.
static int	REASON_FORWARDALL This Connection was the result of unconditional forwarding.
static int	REASON_FORWARDBUSY This Connection was the result of a forwarding on busy.
static int	REASON_FORWARDNOANSWER This Connection was the result of a forwarding on no answer.
static int	REASON_OUTBOUND This Connection is an originating Connection, not a destination Connection.
static int	REASON_REDIRECT This Connection was the result of a redirection.
static int	REASON_TRANSFERREDCALL This Connection was the result of a transfer.
static int	REDIRECT_DROP_ON_FAILURE This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination.
static int	REDIRECT_NORMAL This redirect mode instructs the implementation to perform redirect if the destination is valid and available.
Methods
CiscoConnectionID	getConnectionID() CiscoConnectionID is a unique object that identifier among all ACTIVE calls with the same CallManagerID.
int	getReason() Returns the reason for the creation of this Connection.
javax.telephony.TerminalC onnection	getRedirectController() This method returns the current redirectController for the connection.
java.lang.String	park() This method parks the call at a system park port and returns the address of the port.
javax.telephony.Connectio n	redirect(String, int) This method overloads the CallControlConnection.redirect() method.
javax.telephony.Connectio n	redirect(String, int, int) This method overloads the CallControlConnection.redirect() method.
javax.telephony.Connectio n	redirect(String, int, int, int) 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
getObject(), setObject(Object)
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

getAddressPI()

public boolean getAddressPI()

Returns Presentation Indicator(PI) associated with Address on which the connection is created. If it returns true, Application can display this Address Name to end users. If it returns false, Applications should not display this Address Name to end user

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 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

getRedirectController()

public javax.telephony.TerminalConnection getRedirectController()

Returns the current redirectController for the 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, MethodNotS
upportedException, PrivilegeViolationException, ResourceUnavail
ableException

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, MethodNotS
upportedException, PrivilegeViolationException, ResourceUnavail
ableException

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

---

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, MethodNotS
upportedException, PrivilegeViolationException, ResourceUnavail
ableException

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 fields or not.

The redirectMode parameter may be:

1. CiscoConnection.REDIRECT_DROP_ON_FAILURE

2. CiscoConnection.REDIRECT_NORMAL

The callingSearchSpace parameter may be:

1. CiscoConnection.DEFAULT_SEARCH_SPACE

2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

3. CiscoConnection.ADDRESS_SEARCH_SPACE

---

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

Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int, String)

public javax.telephony.Connection redirect(java.lang.String

destinationAddress, int mode, int callingSearchSpace, 
java.lang.String preferredOriginalCalledParty)

throws InvalidStateException, InvalidPartyException, 
MethodNotSupportedException, PrivilegeViolationException, 
ResourceUnavailableException

This method overloads the CallControlConnection.redirect() method. It takes three new parameters -- redirectMode, callingSearchSpace, preferredOriginalCalledParty.

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.

---

PreferredOriginalCalledParty parameter may be: a DN which will be the originalCalledParty field when call is offered to destinationAddress.

Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int, int, String, String, String)

public javax.telephony.Connection redirect

(java.lang.String destinationAddress, int mode, 
int callingSearchSpace, int calledAddressOption, 
java.lang.String preferredOriginalCalledParty, 
java.lang.String facCode, java.lang.String cmcCode)

This method overloads the CallControlConnection.redirect() method. It takes five new parameters —- redirectMode, callingSearchSpace, calledAddressOption, facCode, and cmcCode. 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 fields or not.

The redirectMode parameter may be:

1. CiscoConnection.REDIRECT_DROP_ON_FAILURE

2. CiscoConnection.REDIRECT_NORMAL

The callingSearchSpace parameter may be:

1. CiscoConnection.DEFAULT_SEARCH_SPACE

2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

3. CiscoConnection.ADDRESS_SEARCH_SPACE

---

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

Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

PreferredOriginalCalledParty parameter may be a DN that will be the originalCalledParty field when the call is offered to destinationAddress.

The facCode is the forced account code (FAC), and cmcCode is the client matter code (CMC).

setRequestController(TerminalConnection)

public void

setRequestController(javax.telephony.TerminalConnection tc)

throws InvalidArgumentException, InvalidStateException

This interface is provided to Requesting TerminalConnection. Applications are required to call this method prior to redirecting /Parking/disconnecting the Call for a Connection for a SharedLine Call. On a SharedLine address, there will be more that one TerminalConnection for a connection.

When there is only one active terminalConnection, applications may not specify RequestController, however if there is more that one active TerminalConnection in same connection e.g for BargedCall/ConferenceCall then Applications must specify RequestController. RequestController is the TerminalConnection which will be used for completing request. RequestController will be set to null/0 after request is completed/executed.

The following examples show how this interface can be used.

Example 2-1 Redirect: Address A has two active terminalConnection TC1 and TC2 Application want to redirect Call T2 to C.

CiscoConnection.setRequqestController(TC2);

CiscoConnection.redirect(C);

Example 2-2 Park: Address A have two active TerminalConnection TC1 and TC2 Application want to Park the Call at T2

CiscoConnection.setRequestController(TC2);

CiscoConnection.park();

Throws:

javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException

CiscoConnectionID

Declaration

public interface CiscoConnectionID extends CiscoObjectContainer

All Superinterfaces

CiscoObjectContainer

Description

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

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

Inherited Member Summary
Methods inherited from interface CiscoObjectContainer
getObject(), setObject(Object)

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.Connectio n[]	consultWithoutMedia(TerminalConnection, String) From CallEvent perspective, this method behaves similar to CallControlCall.consult(TerminalConnection tc, String dialedDigits).
javax.telephony.TerminalC onnection	getConsultingTerminalConnection() 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
conference(Call[]), connect(Terminal, Address, String, CiscoRTPParams), getCallID(), getCalledAddressPI(), getCallingAddressPI(), getCurrentCalledAddress(), getCurrentCalledAddressPI(), getCurrentCalledDisplayNamePI(), getCurrentCalledPartyDisplayName(), getCurrentCallingAddress(), getCurrentCallingAddressPI(), getCurrentCallingDisplayNamePI(), getCurrentCallingPartyDisplayName(), getLastRedirectingAddressPI(), getModifiedCalledAddress(), getModifiedCallingAddress()
Methods inherited from interface CiscoObjectContainer
getObject(), setObject(Object)

Methods

consultWithoutMedia(TerminalConnection, String)

public javax.telephony.Connection[]

consultWithoutMedia(javax.telephony.TerminalConnection tc, 
java.lang.String dialedDigits) 
throws InvalidStateException, InvalidArgumentException, MethodN
otSupportedException, ResourceUnavailableException, PrivilegeVi
olationException, 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.TerminalC onnection	getHeldTerminalConnection() Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, 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
getCiscoCause()
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

CiscoAddrAddedToTerminalEv, CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrCreatedEv, CiscoAddrEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv, CiscoAddrRemovedEv, CiscoCallEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoOutOfServiceEv, CiscoProvCallParkEv, CiscoProvEv, CiscoProvFeatureEv, CiscoProvFeatureUnRegisteredEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputStoppedEv, CiscoRTPOutputStartedEv, CiscoTermButtonPressedEv, CiscoTermButtonPressedEv, CiscoTermCreatedEv, CiscoTermDataEv, CiscoTermEv, CiscoTerminal, CiscoTerminal, CiscoTermInServiceEv, CiscoTermOutOfServiceEv, CiscoTermRemovedEv, CiscoTransferEndEv, CiscoTransferStartEv

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	FRAMESIZE_SIXTY_MILLISECOND_PACKET The frames-per-packet value for 60 millisecond packets
static int	FRAMESIZE_THIRTY_MILLISECOND_PACKET The frames-per-packet value for 30 millisecond packets
static int	FRAMESIZE_TWENTY_MILLISECOND_PACKET The frames-per-packet value for 20 millisecond packets
Constructors
	CiscoG711MediaCapability() Constructs a CiscoG711MediaCapability</CODE object with a default thirty millisecond packet size.
	CiscoG711MediaCapability(int) Constructs a CiscoG711MediaCapability</CODE object with the specified packet size.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS
Methods inherited from class CiscoMediaCapability
getMaxFramesPerPacket(), getPayloadType(), toString(), isSupported()
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	FRAMESIZE_SIXTY_MILLISECOND_PACKET The frames-per-packet value for 60 millisecond packets
static int	FRAMESIZE_THIRTY_MILLISECOND_PACKET The frames-per-packet value for 30 millisecond packets
static int	FRAMESIZE_TWENTY_MILLISECOND_PACKET The frames-per-packet value for 20 millisecond packets
Constructors
	CiscoG723MediaCapability() Constructs a CiscoG723MediaCapability</CODE object with a default thirty millisecond packet size and 6.4k bit rate.
	CiscoG723MediaCapability(int, int) Constructs a CiscoG723MediaCapability</CODE object with the specified packet size and bit rate.
Methods
int	getBitRate() Returns the bit rate specified by this capability object.
java.lang.String	toString()

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS
Methods inherited from class CiscoMediaCapability
getMaxFramesPerPacket(), getPayloadType(), isSupported()
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), witty 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	FRAMESIZE_SIXTY_MILLISECOND_PACKET The frames-per-packet value for 60 millisecond packets
static int	FRAMESIZE_THIRTY_MILLISECOND_PACKET The frames-per-packet value for 30 millisecond packets
static int	FRAMESIZE_TWENTY_MILLISECOND_PACKET The frames-per-packet value for 20 millisecond packets
Constructors
	CiscoG729MediaCapability() Constructs a CiscoG729MediaCapability</CODE object with a default G729 payload and thirty millisecond packet size.
	CiscoG729MediaCapability(int, int) Constructs a CiscoG729MediaCapability</CODE object with the specified packet size and payload.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS
Methods inherited from class CiscoMediaCapability
getMaxFramesPerPacket(), getPayloadType(), isSupported(), toString()
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), witty 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. The 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	FRAMESIZE_EIGHTY_MILLISECOND_PACKET The frames-per-packet value for 30 millisecond packets
Constructors
	CiscoGSMMediaCapability() Constructs a CiscoGSMMediaCapability</CODE object with a default eighty millisecond packet size.
	CiscoGSMMediaCapability(int) Constructs a CiscoGSMMediaCapability</CODE object with the specified packet size.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, GSM_80_MILLISECONDS, WIDEBAND_256K_10_MILLISECONDS
Methods inherited from class CiscoMediaCapability
getMaxFramesPerPacket(), getPayloadType(), isSupported(), toString()
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, see if its an instance of 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	ASSOCIATED_LINE_NOT_OPEN
static int	CALL_ALREADY_EXISTS
public static final int	CALL_DROPPED
static int	CALLHANDLE_NOTINCOMINGCALL
static int	CALLHANDLE_UNKNOWN_TO_LINECONTROL
static int	CANNOT_OPEN_DEVICE
static int	CANNOT_TERMINATE_MEDIA_ON_PHONE
static int	CFWDALL_ALREADY_OFF
static int	CFWDALL_ALREADY_SET
static int	CFWDALL_DESTN_INVALID
static int	CLUSTER_LINK_FAILURE
static int	COMMAND_NOT_IMPLEMENTED_ON_DEVICE
static int	CONFERENCE_ALREADY_PRESENT
static int	CONFERENCE_FAILED
static int	CONFERENCE_FULL
static int	CONFERENCE_INACTIVE
static int	CONFERENCE_INVALID_PARTICIPANT
static int	CTIERR_ACCESS_TO_DEVICE_DENIED
static int	CTIERR_APP_SOFTKEYS_ALREADY_CONTROLLED
static int	CTIERR_APPLICATION_DATA_SIZE_EXCEEDED
static int	CTIERR_CALL_MANAGER_NOT_AVAILABLE
static int	CTIERR_CALL_NOT_EXISTED
static int	CTIERR_CALL_PARK_NO_DN
static int	CTIERR_CALL_REQUEST_ALREADY_OUTSTANDING
static int	CTIERR_CALL_UNPARK_FAILED
static int	CTIERR_CAPABILITIES_DO_NOT_MATCH
static int	CTIERR_CLOSE_DELAY_NOT_SUPPORTED_WITH_REG_TYPE
static int	CTIERR_CONFERENCE_ALREADY_EXISTED
static int	CTIERR_CONFERENCE_NOT_EXISTED
static int	CTIERR_CONSULT_CALL_FAILURE
static int	CTIERR_CONSULTCALL_ALREADY_OUTSTANDING
static int	CTIERR_CTIHANDLER_PROCESS_CREATION_FAILED
static int	CTIERR_DEVICE_ALREADY_OPENED
static int	CTIERR_DEVICE_NOT_OPENED_YET
static int	CTIERR_DEVICE_OWNER_ALIVE_TIMER_STARTED
static int	CTIERR_DEVICE_SHUTTING_DOWN
static int	CTIERR_DUPLICATE_CALL_REFERENCE
static int	CTIERR_FAC_CMC_REASON_FAC_NEEDED
static int	CTIERR_FAC_CMC_REASON_CMC_NEEDED
static int	CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED
static int	CTIERR_FAC_CMC_REASON_FAC_INVALID
static int	CTIERR_FAC_CMC_REASON_CMC_INVALID
static int	CTIERR_FEATURE_ALREADY_REGISTERED
static int	CTIERR_FEATURE_DATA_REJECT
static int	CTIERR_ILLEGAL_DEVICE_TYPE
static int	CTIERR_INCOMPATIBLE_AUTOINSTALL_PROTOCOL_VERSION
static int	CTIERR_INCORRECT_MEDIA_CAPABILITY
static int	CTIERR_INFORMATION_NOT_AVAILABLE
static int	CTIERR_INTERNAL_FAILURE
static int	CTIERR_INVALID_DEVICE_NAME
static int	CTIERR_INVALID_DTMFDIGITS
static int	CTIERR_INVALID_MEDIA_DEVICE
static int	CTIERR_INVALID_MEDIA_PARAMETER
static int	CTIERR_INVALID_MEDIA_PROCESS
static int	CTIERR_INVALID_MEDIA_RESOURCE_ID
static int	CTIERR_INVALID_MESSAGE_HEADER_INFO
static int	CTIERR_INVALID_MESSAGE_LENGTH
static int	CTIERR_INVALID_MONITOR_DN_TYPE
static int	CTIERR_INVALID_PARAMETER
static int	CTIERR_INVALID_PARK_DN
static int	CTIERR_INVALID_PARK_REGISTRATION_HANDLE
static int	CTIERR_INVALID_RESOURCE_TYPE
static int	CTIERR_MAXCALL_LIMIT_REACHED
static int	CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC
static int	CTIERR_MEDIA_ALREADY_TERMINATED_NONE
static int	CTIERR_MEDIA_ALREADY_TERMINATED_STATIC
static int	CTIERR_MEDIA_CAPABILITY_MISMATCH
static int	CTIERR_MEDIA_RESOURCE_NAME_SIZE_EXCEEDED
static int	CTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCH
static int	CTIERR_MESSAGE_TOO_BIG
static int	CTIERR_MORE_ACTIVE_CALLS_THAN_RESERVED
static int	CTIERR_NO_EXISTING_CALLS
static int	CTIERR_NO_EXISTING_CONFERENCE
static int	CTIERR_NO_RESPONSE_FROM_MP
static int	CTIERR_NOT_PRESERVED_CALL
static int	CTIERR_OPERATION_FAILED_QUIETCLEAR
static int	CTIERR_OPERATION_NOT_ALLOWED
static int	CTIERR_OWNER_NOT_ALIVE
static int	CTIERR_PENDING_ACCEPT_OR_ANSWER_REQUEST
static int	CTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGE
static int	CTIERR_REGISTER_FEATURE_ACTIVATION_FAILED
static int	CTIERR_RESOURCE_NOT_AVAILABLE
static int	CTIERR_STATION_SHUT_DOWN
static int	CTIERR_SYSTEM_ERROR
static int	CTIERR_UNKNOWN_EXCEPTION
static int	CTIERR_UNSUPPORTED_CALL_PARK_TYPE
static int	DARES_INVALID_REQ_TYPE
static int	DATA_SIZE_LIMIT_EXCEEDED
static int	DB_ERROR
static int	DB_ILLEGAL_DEVICE_TYPE
static int	DB_NO_MORE_DEVICES
static int	DESTINATION_BUSY
static int	DESTINATION_UNKNOWN
static int	DEVICE_ALREADY_REGISTERED
static int	DEVICE_NOT_OPEN
static int	DEVICE_OUT_OF_SERVICE
static int	DIGIT_GENERATION_ALREADY_IN_PROGRESS
static int	DIGIT_GENERATION_CALLSTATE_CHANGED
static int	DIGIT_GENERATION_WRONG_CALL_HANDLE
static int	DIGIT_GENERATION_WRONG_CALL_STATE
static int	DIRECTORY_LOGIN_FAILED
static int	DIRECTORY_LOGIN_NOT_ALLOWED
static int	DIRECTORY_TEMPORARY_UNAVAILABLE
static int	EXISTING_FIRSTPARTY
static int	HOLDFAILED
static int	ILLEGAL_CALLINGPARTY
static int