com.cisco.jtapi.extensions
Interface CiscoTerminal

All Superinterfaces:
CiscoObjectContainer, javax.telephony.Terminal
All Known Subinterfaces:
CiscoBaseMediaTerminal, CiscoMediaTerminal, CiscoRemoteTerminal, CiscoRouteTerminal

public interface CiscoTerminal
extends javax.telephony.Terminal, CiscoObjectContainer

Introduction

Standard JTAPI does not support the notion of dynamic terminal registration. The CiscoTerminal interface extends the standard terminal interface to do so. All Cisco Unified Communications Manager devices are represented by CiscoTerminals, and you can query all CiscoTerminals to determine whether they are currently IN_SERVICE or OUT_OF_SERVICE.

If the Cisco Unified Communications Manager device represented by the CiscoTerminal is an IP telephone, for instance, it goes OUT_OF_SERVICE if it loses its network connection. Other types of devices, such as CiscoMediaTerminal, get registered on demand by applications, and may be IN_SERVICE or OUT_OF_SERVICE accordingly.

See Also:
Terminal, CiscoMediaTerminal

Field Summary
static int APPLICATION
          This indicates that capability of application is requested
static int ASCII_ENCODING
          Indicates that the CiscoTerminal.getSupportedEncoding () for this terminal is ASCII and that this terminal supports only ASCII_ENCODING.
static int DEVICESTATE_ACTIVE
          This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one active call on an Address.
static int DEVICESTATE_ALERTING
          This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one alerting call, but no active call, on an Address.
static int DEVICESTATE_HELD
          This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one held call, but no alerting or active calls, on an Address.
static int DEVICESTATE_IDLE
          This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal currently has no calls on any Addresses.
static int DEVICESTATE_UNKNOWN
          This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal DeviceState is Unknown.
static int DEVICESTATE_WHISPER
          This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one intercom call with one-way media, but has no held, alerting, or active calls on an Address.
static int DEVICETYPE_12S
          12S (Cisco 12 S) device type
static int DEVICETYPE_12SP
          12SP (Cisco 12 SP) device type
static int DEVICETYPE_14_BUTTON_SIDECAR
          14_BUTTON_SIDECAR (7914 14-Button Line Expansion Module) device type
static int DEVICETYPE_30SPP
          30SPP (Cisco 30 SP+) device type
static int DEVICETYPE_7915_12_BUTTON_SIDECAR
          7915_12_BUTTON_SIDECAR (7915 12-Button Line Expansion Module) device type
static int DEVICETYPE_7915_24_BUTTON_SIDECAR
          7915_24_BUTTON_SIDECAR (7915 24-Button Line Expansion Module) device type
static int DEVICETYPE_7916_12_BUTTON_SIDECAR
          7916_12_BUTTON_SIDECAR (7916 12-Button Line Expansion Module) device type
static int DEVICETYPE_7916_24_BUTTON_SIDECAR
          7916_24_BUTTON_SIDECAR (7916 24-Button Line Expansion Module) device type
static int DEVICETYPE_7920
          7920 (Cisco 7920) device type
static int DEVICETYPE_7931
          7931 (Cisco 7931) device type
static int DEVICETYPE_9951
          9951 (Cisco 9951) device type
static int DEVICETYPE_ANALOG_PHONE
          ANALOG_PHONE (Analog Phone) device type
static int DEVICETYPE_ATA_186
          ATA_186 (Cisco ATA 186) device type
static int DEVICETYPE_CISCO_6901
          CISCO_6901 (Cisco 6901) device type
static int DEVICETYPE_CISCO_6911
          CISCO_6911 (Cisco 6911) device type
static int DEVICETYPE_CISCO_6921
          CISCO_6921 (Cisco 6921) device type
static int DEVICETYPE_CISCO_6941
          CISCO_6941 (Cisco 6941) device type
static int DEVICETYPE_CISCO_6945
          CISCO_6945 (Cisco 6945) device type
static int DEVICETYPE_CISCO_6961
          CISCO_6961 (Cisco 6961) device type
static int DEVICETYPE_CISCO_7902
          CISCO_7902 (Cisco 7902) device type
static int DEVICETYPE_CISCO_7906
          CISCO_7906 (Cisco 7906) device type
static int DEVICETYPE_CISCO_7911
          CISCO_7911 (Cisco 7911) device type
static int DEVICETYPE_CISCO_7912
          CISCO_7912 (Cisco 7912) device type
static int DEVICETYPE_CISCO_7925
          CISCO_7925 (Cisco 7925) device type
static int DEVICETYPE_CISCO_7926
          CISCO_7926 (Cisco 7926) device type
static int DEVICETYPE_CISCO_7936
          CISCO_7936 (Cisco 7936) device type
static int DEVICETYPE_CISCO_7937
          CISCO_7937 (Cisco 7937) device type
static int DEVICETYPE_CISCO_7941
          CISCO_7941 (Cisco 7941) device type
static int DEVICETYPE_CISCO_7941G_GE
          CISCO_7941G_GE (Cisco 7941G-GE) device type
static int DEVICETYPE_CISCO_7942
          CISCO_7942 (Cisco 7942) device type
static int DEVICETYPE_CISCO_7945
          CISCO_7945 (Cisco 7945) device type
static int DEVICETYPE_CISCO_7961
          CISCO_7961 (Cisco 7961) device type
static int DEVICETYPE_CISCO_7961G_GE
          CISCO_7961G_GE (Cisco 7961G-GE ) device type
static int DEVICETYPE_CISCO_7962
          CISCO_7962 (Cisco 7962) device type
static int DEVICETYPE_CISCO_7965
          CISCO_7965 (Cisco 7965) device type
static int DEVICETYPE_CISCO_7970
          CISCO_7970 (Cisco 7970) device type
static int DEVICETYPE_CISCO_7971
          CISCO_7971 (Cisco 7971) device type
static int DEVICETYPE_CISCO_7975
          CISCO_7975 (Cisco 7975) device type
static int DEVICETYPE_CISCO_7989
          CISCO_7989 (Cisco 7985) device type
static int DEVICETYPE_CISCO_8941
          CISCO_8941 (Cisco 8941) device type
static int DEVICETYPE_CISCO_8945
          CISCO_8945 (Cisco 8945) device type
static int DEVICETYPE_CISCO_8961
          CISCO_8961 (Cisco 8961) device type
static int DEVICETYPE_CISCO_9971
          Cisco_9971 (Cisco 9971) device type
static int DEVICETYPE_CISCO_ATA_187
          CISCO_ATA_187 (Cisco ATA 187) device type
static int DEVICETYPE_CISCO_CIUS
          CISCO_CIUS (Cisco Cius) device type
static int DEVICETYPE_CISCO_CIUS_SP
          CISCO_CIUS_SP (Cisco Cius SP) device type
static int DEVICETYPE_CISCO_IP_PHONE_7905
          CISCO_IP_PHONE_7905 (Cisco 7905) device type
static int DEVICETYPE_CISCO_SOFTPHONE_SE_M
          CISCO_SOFTPHONE_SE_M (Cisco IP Communicator) device type
static int DEVICETYPE_CISCO_UNIFIED_COMMUNICATIONS_FOR_RTX
          CISCO_UNIFIED_COMMUNICATIONS_FOR_RTX (Cisco Unified Communications for RTX) device type
static int DEVICETYPE_CISCO_UNIFIED_COMMUNICATOR
          CISCO_UNIFIED_COMMUNICATOR (Cisco Unified Personal Communicator) device type
static int DEVICETYPE_CISCO_UNIFIED_MOBILE_COMMUNICATOR
          CISCO_UNIFIED_MOBILE_COMMUNICATOR (Cisco Unified Mobile Communicator) device type
static int DEVICETYPE_CKEM_36_BUTTON
          CKEM_36_BUTTON (CKEM 36-Button Line Expansion Module) device type
static int DEVICETYPE_CLIENT_SERVICES_FRAMEWORK
          CLIENT_SERVICES_FRAMEWORK (Cisco Unified Client Services Framework) device type
static int DEVICETYPE_CP7921
          CP7921 (Cisco 7921) device type
static int DEVICETYPE_CTI_PORT
          CTI_PORT (CTI Port) device type
static int DEVICETYPE_CTI_REMOTE_DEVICE
          CTI_REMOTE_DEVICE (CTI Remote Device) device type
static int DEVICETYPE_CTI_ROUTE_POINT
          CTI_ROUTE_POINT (Route Point) device type
static int DEVICETYPE_DEVICE_PILOT
          DEVICE_PILOT (Device Pilot) device type
static int DEVICETYPE_IP_CONFERENCE_PHONE
          IP_CONFERENCE_PHONE (Cisco 7935) device type
static int DEVICETYPE_ISDN_BRI_PHONE
          ISDN_BRI_PHONE (ISDN BRI Phone) device type
static int DEVICETYPE_TELECASTER_BID
          TELECASTER_BID (Cisco 7910) device type
static int DEVICETYPE_TELECASTER_BUSINESS
          TELECASTER_BUSINESS (Cisco 7940) device type
static int DEVICETYPE_TELECASTER_MGR
          TELECASTER_MGR (Cisco 7960) device type
static int DEVICETYPE_UNKNOWN
          Unknown device type
static int DEVICETYPE_VGC_PHONE
          VGC_PHONE (Cisco VGC Phone) device type
static int DND_OPTION_CALL_REJECT
          This constant value returned by the getDNDOptions() interface on CiscoTerminal indicates that the DND option configured is Call Reject.
static int DND_OPTION_NONE
          This constant value returned by the getDNDOption() interface on CiscoTerminal indicates that the DND option configured is None.
static int DND_OPTION_RINGER_OFF
          This constant value returned by the getDNDOption() interface on CiscoTerminal indicates that the DND option configured is Ringer Off.
static int IN_SERVICE
          This constant value returned by the getState() interface on CiscoTerminal indicates that the CiscoTerminal is in service.
static int IP_ADDRESSING_MODE_IPV4
          This indicates that IPAddressing mode is IPv4
static int IP_ADDRESSING_MODE_IPV4_V6
          This indicates that IPAddressing mode is dual stack (IPv4 and IPv6 both)
static int IP_ADDRESSING_MODE_IPV6
          This indicates that IPAddressing mode is IPv6
static int IP_ADDRESSING_MODE_UNKNOWN
          This indicates that IPAddressing mode is Unknown
static int IP_ADDRESSING_MODE_UNKNOWN_ANATRED
          This is reserved IPAddressing constant for ANAT in CUCM, not used in JTAPI
static int NATIVE_LOGIN
          This indicates that the terminal is part of the local cluster when an EM login is done into it with a profile that belongs to the same cluster
static int NO_LOGIN
          This indicates there has been no EM login done on the terminal.
static int NO_ROLLOVER
          This indicates that no roll over is configured on the Terminal
static int NOT_APPLICABLE
          Indicates that the CiscoTerminal.getSupportedEncoding () for this CiscoMediaTerminal or RoutePoint is NOT_APPLICABLE.
static int OUT_OF_SERVICE
          This constant value returned by the getState() interface on CiscoTerminal indicates that the CiscoTerminal is out of service.
static int PHONE_USER
          This indicates that capability of phone user is requested
static int ROLLOVER_ANY_DN
          This indicates that Terminal is configured to roll over calls to any dn on the terminal
static int ROLLOVER_SAME_DN
          This indicates that Terminal is configured to roll over calls to same dn on the terminal
static int UCS2UNICODE_ENCODING
          Indicates that the CiscoTerminal.getSupportedEncoding () for this terminal is UCS2UNICODE_ENCODING.
static int UNKNOWN_ENCODING
          Indicates that the CiscoTerminal.getSupportedEncoding () for this terminal is UNKNOWN.
static int VISITOR_LOGIN
          This indicates that the terminal is part of the visiting cluster when an EM login is done into it with a profile that is not local to the cluster.
 
Method Summary
 boolean canConsultCallRollOver(int which_user)
          Returns true if Terminal allows consult call to Roll over
 boolean canDirectTransferAcrossLines(int which_user)
          Returns true if Terminal allows calls on different addresses on this Terminal to be transferred else false
 boolean canDirectTransferOnSameLine(int which_user)
          Returns true if Terminal allows calls on same address on this Terminal to be transferred else false
 boolean canJoinAcrossLines(int which_user)
          Returns true if Terminal allows calls on different addresses on this Terminal to be joined(conference) else false
 boolean canJoinOnSameLine(int which_user)
          Returns true if Terminal allows calls on same address on this Terminal to be joined(conferenced) else false
 boolean canOutBoundCallRollOver(int which_user)
          Returns true if Terminal allows out bound calls to Roll over
 void createSnapshot()
          Generates a CiscoTermSnapshotEv event, which contains the security status of the current active call on the terminal.
 CiscoCall directedPickup(javax.telephony.Address pickingAddress, java.lang.String ringingDN)
          This method will pickup the call from the specified ringingDN at the pickingAddress.
 java.lang.String getAltScript()
          Returns the locale alternate script that this terminal supports.
 int getDeviceState()
          Returns the DeviceState of this terminal.
 int getDNDOption()
          Returns the value of the DND option.
 boolean getDNDStatus()
          Reports the DND status.
 java.lang.String getEMLoginUsername()
          Returns Extension mobility(EM) Login UserName If no EM user has logged into Terminal, this interface will return null/empty string
 CiscoTermEvFilter getFilter()
          Retrieves the filter object associated with the terminal.
 int getIPAddressingMode()
          Application can invoke this API to query the IP Addressing Mode of the CiscoTerminal Addressing mode may be any of the following constants: CiscoTerminal.IP_ADDRESSING_MODE_IPv4 CiscoTerminal.IP_ADDRESSING_MODE_IPv6 CiscoTerminal.IP_ADDRESSING_MODE_IPv4_v6
 java.net.InetAddress getIPV4Address()
          Returns the IPV4 address of the Terminal or null
 java.net.InetAddress getIPV6Address()
          Returns the IPV6 address of the Terminal or null
 int getLocale()
          Returns the locale that this terminal supports.
 int getLoginType()
          This method will return the login type of the terminal, to indicate if terminal is local to the cluster or not, when EM login is done CiscoTerminal.NO_EM_LOGIN CiscoTerminal.NATIVE_LOGIN CiscoTerminal.VISITOR_LOGIN
 int getProtocol()
          Reports the terminal protocol (SCCP, SIP, CTI_REMOTE_DEVICE, or NONE).
 int getRegistrationState()
          Deprecated. This method has been replaced by the getState() method.
 int getRollOverConfig()
          Returns the configured out bound RollOver mode on the Terminal
 CiscoRTPInputProperties getRTPInputProperties()
          Returns the properties to be used for the RTP input stream associated with the ACTIVE TerminalConnection on this terminal.
 CiscoRTPOutputProperties getRTPOutputProperties()
          Returns the properties to be used for the RTP output stream associated with the ACTIVE TerminalConnection on this terminal.
 int getState()
          Returns the state of this terminal.
 int getSupportedEncoding()
          Returns the supported encoding types for this terminal.
 int getType()
          This method returns the device type of Terminal, which can be one of the following contants.
 java.lang.String getTypeName()
          This method returns the device type name of Terminal (i.e.
 CiscoCall groupPickup(javax.telephony.Address pickingAddress, java.lang.String pickupGroupNumber)
          This method will pickup the longest ringing call from the specified pickupGroupNumber at the pickingAddress.
 boolean isBuiltInBridgeEnabled()
          Returns true if the Built-In-Bridge is enabled on this terminal otherwise returns false
 boolean isRegistered()
          Returns true if Terminal is registered else false
 boolean isRestricted()
          Returns the restriction status of this terminal.
 CiscoCall otherPickup(javax.telephony.Address pickingAddress)
          This method will pickup a call based upon the priority of the associated pickupgroups.
 CiscoCall pickup(javax.telephony.Address pickingAddress)
          This method will pickup the longest ringing call from the Pickup Group to which pickingAddress belongs to.
 void register()
          Deprecated. This method is being deprecated from 9.1.1 and later due to removal of extend and connect support in CUCSF.
 byte[] sendData(byte[] terminalData)
          Sends data to the phone.
 java.lang.String sendData(java.lang.String terminalData)
          Deprecated.  
 void setDNDStatus(boolean dndStatus)
          Sets the DND status, which enables or disables the DND feature.
 void setFilter(CiscoTermEvFilter terminalEvFilter)
          Filters the events that get delivered to the TerminalObserver.
 javax.telephony.TerminalConnection unPark(javax.telephony.Address unParkAddress, java.lang.String parkedAt)
          Unparks a call at a terminal and returns a terminalConnection.
 void unregister()
          Deprecated. This method is being deprecated from 9.1.1 and later due to removal of extend and connect support in CUCSF.
 
Methods inherited from interface javax.telephony.Terminal
addCallObserver, addObserver, getAddresses, getCallObservers, getCapabilities, getName, getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, removeCallObserver, removeObserver
 
Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
 

Field Detail

OUT_OF_SERVICE

static final int OUT_OF_SERVICE
This constant value returned by the getState() interface on CiscoTerminal indicates that the CiscoTerminal is out of service.

See Also:
Constant Field Values

IN_SERVICE

static final int IN_SERVICE
This constant value returned by the getState() interface on CiscoTerminal indicates that the CiscoTerminal is in service.

See Also:
Constant Field Values

DEVICESTATE_IDLE

static final int DEVICESTATE_IDLE
This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal currently has no calls on any Addresses.

See Also:
Constant Field Values

DEVICESTATE_ACTIVE

static final int DEVICESTATE_ACTIVE
This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one active call on an Address.

See Also:
Constant Field Values

DEVICESTATE_ALERTING

static final int DEVICESTATE_ALERTING
This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one alerting call, but no active call, on an Address.

See Also:
Constant Field Values

DEVICESTATE_HELD

static final int DEVICESTATE_HELD
This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one held call, but no alerting or active calls, on an Address.

See Also:
Constant Field Values

DEVICESTATE_UNKNOWN

static final int DEVICESTATE_UNKNOWN
This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal DeviceState is Unknown. This state may get returned if the device state filters are disabled.

See Also:
CiscoTermEvFilter, Constant Field Values

DEVICESTATE_WHISPER

static final int DEVICESTATE_WHISPER
This constant value returned by the getDeviceState() interface on CiscoTerminal indicates that the CiscoTerminal has at least one intercom call with one-way media, but has no held, alerting, or active calls on an Address.

See Also:
Constant Field Values

UNKNOWN_ENCODING

static final int UNKNOWN_ENCODING
Indicates that the CiscoTerminal.getSupportedEncoding () for this terminal is UNKNOWN.

See Also:
Constant Field Values

NOT_APPLICABLE

static final int NOT_APPLICABLE
Indicates that the CiscoTerminal.getSupportedEncoding () for this CiscoMediaTerminal or RoutePoint is NOT_APPLICABLE.

See Also:
Constant Field Values

ASCII_ENCODING

static final int ASCII_ENCODING
Indicates that the CiscoTerminal.getSupportedEncoding () for this terminal is ASCII and that this terminal supports only ASCII_ENCODING.

See Also:
Constant Field Values

UCS2UNICODE_ENCODING

static final int UCS2UNICODE_ENCODING
Indicates that the CiscoTerminal.getSupportedEncoding () for this terminal is UCS2UNICODE_ENCODING.

See Also:
Constant Field Values

DND_OPTION_NONE

static final int DND_OPTION_NONE
This constant value returned by the getDNDOption() interface on CiscoTerminal indicates that the DND option configured is None.

See Also:
Constant Field Values

DND_OPTION_RINGER_OFF

static final int DND_OPTION_RINGER_OFF
This constant value returned by the getDNDOption() interface on CiscoTerminal indicates that the DND option configured is Ringer Off. If DND is enabled on the phone, the phone would not ring if a call lands there.

See Also:
Constant Field Values

DND_OPTION_CALL_REJECT

static final int DND_OPTION_CALL_REJECT
This constant value returned by the getDNDOptions() interface on CiscoTerminal indicates that the DND option configured is Call Reject. If DND is enabled on the phone, all calls to the phone will get rejected, except for shared lines.

See Also:
Constant Field Values

NO_LOGIN

static final int NO_LOGIN
This indicates there has been no EM login done on the terminal.

Since:
8.0
See Also:
Constant Field Values

NATIVE_LOGIN

static final int NATIVE_LOGIN
This indicates that the terminal is part of the local cluster when an EM login is done into it with a profile that belongs to the same cluster

Since:
8.0
See Also:
Constant Field Values

VISITOR_LOGIN

static final int VISITOR_LOGIN
This indicates that the terminal is part of the visiting cluster when an EM login is done into it with a profile that is not local to the cluster.

Since:
8.0
See Also:
Constant Field Values

DEVICETYPE_UNKNOWN

static final int DEVICETYPE_UNKNOWN
Unknown device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_ANALOG_PHONE

static final int DEVICETYPE_ANALOG_PHONE
ANALOG_PHONE (Analog Phone) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_12S

static final int DEVICETYPE_12S
12S (Cisco 12 S) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_12SP

static final int DEVICETYPE_12SP
12SP (Cisco 12 SP) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_30SPP

static final int DEVICETYPE_30SPP
30SPP (Cisco 30 SP+) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_6901

static final int DEVICETYPE_CISCO_6901
CISCO_6901 (Cisco 6901) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_6911

static final int DEVICETYPE_CISCO_6911
CISCO_6911 (Cisco 6911) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_6921

static final int DEVICETYPE_CISCO_6921
CISCO_6921 (Cisco 6921) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_6941

static final int DEVICETYPE_CISCO_6941
CISCO_6941 (Cisco 6941) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_6945

static final int DEVICETYPE_CISCO_6945
CISCO_6945 (Cisco 6945) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_6961

static final int DEVICETYPE_CISCO_6961
CISCO_6961 (Cisco 6961) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7902

static final int DEVICETYPE_CISCO_7902
CISCO_7902 (Cisco 7902) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_IP_PHONE_7905

static final int DEVICETYPE_CISCO_IP_PHONE_7905
CISCO_IP_PHONE_7905 (Cisco 7905) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7906

static final int DEVICETYPE_CISCO_7906
CISCO_7906 (Cisco 7906) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_TELECASTER_BID

static final int DEVICETYPE_TELECASTER_BID
TELECASTER_BID (Cisco 7910) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7911

static final int DEVICETYPE_CISCO_7911
CISCO_7911 (Cisco 7911) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7912

static final int DEVICETYPE_CISCO_7912
CISCO_7912 (Cisco 7912) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_14_BUTTON_SIDECAR

static final int DEVICETYPE_14_BUTTON_SIDECAR
14_BUTTON_SIDECAR (7914 14-Button Line Expansion Module) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_7915_12_BUTTON_SIDECAR

static final int DEVICETYPE_7915_12_BUTTON_SIDECAR
7915_12_BUTTON_SIDECAR (7915 12-Button Line Expansion Module) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_7915_24_BUTTON_SIDECAR

static final int DEVICETYPE_7915_24_BUTTON_SIDECAR
7915_24_BUTTON_SIDECAR (7915 24-Button Line Expansion Module) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_7916_12_BUTTON_SIDECAR

static final int DEVICETYPE_7916_12_BUTTON_SIDECAR
7916_12_BUTTON_SIDECAR (7916 12-Button Line Expansion Module) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_7916_24_BUTTON_SIDECAR

static final int DEVICETYPE_7916_24_BUTTON_SIDECAR
7916_24_BUTTON_SIDECAR (7916 24-Button Line Expansion Module) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CKEM_36_BUTTON

static final int DEVICETYPE_CKEM_36_BUTTON
CKEM_36_BUTTON (CKEM 36-Button Line Expansion Module) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_7920

static final int DEVICETYPE_7920
7920 (Cisco 7920) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CP7921

static final int DEVICETYPE_CP7921
CP7921 (Cisco 7921) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7925

static final int DEVICETYPE_CISCO_7925
CISCO_7925 (Cisco 7925) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7926

static final int DEVICETYPE_CISCO_7926
CISCO_7926 (Cisco 7926) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_7931

static final int DEVICETYPE_7931
7931 (Cisco 7931) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_IP_CONFERENCE_PHONE

static final int DEVICETYPE_IP_CONFERENCE_PHONE
IP_CONFERENCE_PHONE (Cisco 7935) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7936

static final int DEVICETYPE_CISCO_7936
CISCO_7936 (Cisco 7936) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7937

static final int DEVICETYPE_CISCO_7937
CISCO_7937 (Cisco 7937) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_TELECASTER_BUSINESS

static final int DEVICETYPE_TELECASTER_BUSINESS
TELECASTER_BUSINESS (Cisco 7940) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7941

static final int DEVICETYPE_CISCO_7941
CISCO_7941 (Cisco 7941) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7941G_GE

static final int DEVICETYPE_CISCO_7941G_GE
CISCO_7941G_GE (Cisco 7941G-GE) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7942

static final int DEVICETYPE_CISCO_7942
CISCO_7942 (Cisco 7942) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7945

static final int DEVICETYPE_CISCO_7945
CISCO_7945 (Cisco 7945) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_TELECASTER_MGR

static final int DEVICETYPE_TELECASTER_MGR
TELECASTER_MGR (Cisco 7960) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7961

static final int DEVICETYPE_CISCO_7961
CISCO_7961 (Cisco 7961) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7961G_GE

static final int DEVICETYPE_CISCO_7961G_GE
CISCO_7961G_GE (Cisco 7961G-GE ) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7962

static final int DEVICETYPE_CISCO_7962
CISCO_7962 (Cisco 7962) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7965

static final int DEVICETYPE_CISCO_7965
CISCO_7965 (Cisco 7965) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7970

static final int DEVICETYPE_CISCO_7970
CISCO_7970 (Cisco 7970) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7971

static final int DEVICETYPE_CISCO_7971
CISCO_7971 (Cisco 7971) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7975

static final int DEVICETYPE_CISCO_7975
CISCO_7975 (Cisco 7975) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_7989

static final int DEVICETYPE_CISCO_7989
CISCO_7989 (Cisco 7985) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_8941

static final int DEVICETYPE_CISCO_8941
CISCO_8941 (Cisco 8941) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_8945

static final int DEVICETYPE_CISCO_8945
CISCO_8945 (Cisco 8945) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_8961

static final int DEVICETYPE_CISCO_8961
CISCO_8961 (Cisco 8961) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_9951

static final int DEVICETYPE_9951
9951 (Cisco 9951) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_9971

static final int DEVICETYPE_CISCO_9971
Cisco_9971 (Cisco 9971) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_ATA_186

static final int DEVICETYPE_ATA_186
ATA_186 (Cisco ATA 186) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_ATA_187

static final int DEVICETYPE_CISCO_ATA_187
CISCO_ATA_187 (Cisco ATA 187) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_CIUS

static final int DEVICETYPE_CISCO_CIUS
CISCO_CIUS (Cisco Cius) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_CIUS_SP

static final int DEVICETYPE_CISCO_CIUS_SP
CISCO_CIUS_SP (Cisco Cius SP) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_SOFTPHONE_SE_M

static final int DEVICETYPE_CISCO_SOFTPHONE_SE_M
CISCO_SOFTPHONE_SE_M (Cisco IP Communicator) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_UNIFIED_COMMUNICATOR

static final int DEVICETYPE_CISCO_UNIFIED_COMMUNICATOR
CISCO_UNIFIED_COMMUNICATOR (Cisco Unified Personal Communicator) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_UNIFIED_MOBILE_COMMUNICATOR

static final int DEVICETYPE_CISCO_UNIFIED_MOBILE_COMMUNICATOR
CISCO_UNIFIED_MOBILE_COMMUNICATOR (Cisco Unified Mobile Communicator) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CISCO_UNIFIED_COMMUNICATIONS_FOR_RTX

static final int DEVICETYPE_CISCO_UNIFIED_COMMUNICATIONS_FOR_RTX
CISCO_UNIFIED_COMMUNICATIONS_FOR_RTX (Cisco Unified Communications for RTX) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CLIENT_SERVICES_FRAMEWORK

static final int DEVICETYPE_CLIENT_SERVICES_FRAMEWORK
CLIENT_SERVICES_FRAMEWORK (Cisco Unified Client Services Framework) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_VGC_PHONE

static final int DEVICETYPE_VGC_PHONE
VGC_PHONE (Cisco VGC Phone) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CTI_PORT

static final int DEVICETYPE_CTI_PORT
CTI_PORT (CTI Port) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CTI_ROUTE_POINT

static final int DEVICETYPE_CTI_ROUTE_POINT
CTI_ROUTE_POINT (Route Point) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_DEVICE_PILOT

static final int DEVICETYPE_DEVICE_PILOT
DEVICE_PILOT (Device Pilot) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_ISDN_BRI_PHONE

static final int DEVICETYPE_ISDN_BRI_PHONE
ISDN_BRI_PHONE (ISDN BRI Phone) device type

Since:
9.0.1
See Also:
Constant Field Values

DEVICETYPE_CTI_REMOTE_DEVICE

static final int DEVICETYPE_CTI_REMOTE_DEVICE
CTI_REMOTE_DEVICE (CTI Remote Device) device type

Since:
9.0.1
See Also:
Constant Field Values

IP_ADDRESSING_MODE_UNKNOWN

static final int IP_ADDRESSING_MODE_UNKNOWN
This indicates that IPAddressing mode is Unknown

Since:
7.0
See Also:
Constant Field Values

IP_ADDRESSING_MODE_IPV4

static final int IP_ADDRESSING_MODE_IPV4
This indicates that IPAddressing mode is IPv4

Since:
7.0
See Also:
Constant Field Values

IP_ADDRESSING_MODE_IPV6

static final int IP_ADDRESSING_MODE_IPV6
This indicates that IPAddressing mode is IPv6

Since:
7.0
See Also:
Constant Field Values

IP_ADDRESSING_MODE_IPV4_V6

static final int IP_ADDRESSING_MODE_IPV4_V6
This indicates that IPAddressing mode is dual stack (IPv4 and IPv6 both)

Since:
7.0
See Also:
Constant Field Values

IP_ADDRESSING_MODE_UNKNOWN_ANATRED

static final int IP_ADDRESSING_MODE_UNKNOWN_ANATRED
This is reserved IPAddressing constant for ANAT in CUCM, not used in JTAPI

Since:
7.0
See Also:
Constant Field Values

NO_ROLLOVER

static final int NO_ROLLOVER
This indicates that no roll over is configured on the Terminal

Since:
7.1.3
See Also:
Constant Field Values

ROLLOVER_SAME_DN

static final int ROLLOVER_SAME_DN
This indicates that Terminal is configured to roll over calls to same dn on the terminal

Since:
7.1.3
See Also:
Constant Field Values

ROLLOVER_ANY_DN

static final int ROLLOVER_ANY_DN
This indicates that Terminal is configured to roll over calls to any dn on the terminal

Since:
7.1.3
See Also:
Constant Field Values

PHONE_USER

static final int PHONE_USER
This indicates that capability of phone user is requested

Since:
7.1.3
See Also:
Constant Field Values

APPLICATION

static final int APPLICATION
This indicates that capability of application is requested

Since:
7.1.3
See Also:
Constant Field Values
Method Detail

getRegistrationState

int getRegistrationState()
Deprecated. This method has been replaced by the getState() method.

Returns the state of this terminal.

The state may be any of the following constants:

Returns:
The state of this terminal

getState

int getState()
Returns the state of this terminal.

The state may be any of the following constants:

Returns:
the state of this terminal

getRTPInputProperties

CiscoRTPInputProperties getRTPInputProperties()
                                              throws javax.telephony.InvalidStateException
Returns the properties to be used for the RTP input stream associated with the ACTIVE TerminalConnection on this terminal. The CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state, and Terminal.getTerminalConnections () must return at least one terminal connection in the TerminalConnection.ACTIVE state.

Returns:
RTP input stream properties that are associated with the ACTIVE TerminalConnection on this terminal
Throws:
javax.telephony.InvalidStateException

getRTPOutputProperties

CiscoRTPOutputProperties getRTPOutputProperties()
                                                throws javax.telephony.InvalidStateException
Returns the properties to be used for the RTP output stream associated with the ACTIVE TerminalConnection on this terminal. The CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state, and Terminal.getTerminalConnections () must return at least one terminal connection in the TerminalConnection.ACTIVE state.

Returns:
RTP output stream properties that are associated with the ACTIVE TerminalConnection on this terminal
Throws:
javax.telephony.InvalidStateException

sendData

java.lang.String sendData(java.lang.String terminalData)
                          throws javax.telephony.InvalidStateException,
                                 javax.telephony.MethodNotSupportedException
Deprecated. 

Deprecated. Use CiscoTerminal.sendData ( byte[] ).

Throws:
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException

sendData

byte[] sendData(byte[] terminalData)
                throws javax.telephony.InvalidStateException,
                       javax.telephony.MethodNotSupportedException
Sends data to the phone. The CiscoTerminal must be in the CiscoTerminal.IN_SERVICE state, and its Provider must be in the Provider.IN_SERVICE state. Applications can push the XSI object in the byte format to the phone with this interface. If the phone receives the data, this method returns successfully. Applications may only send 2000 bytes of data with this interface. Requests carrying excess data get rejected.

Throws:
javax.telephony.PlatformException - The data did not get sent successfully.
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException

getFilter

CiscoTermEvFilter getFilter()
Retrieves the filter object associated with the terminal.


setFilter

void setFilter(CiscoTermEvFilter terminalEvFilter)
Filters the events that get delivered to the TerminalObserver. You can call this method at any time, but the typical usage is to set up the terminal events as part of initialization or when a CiscTermCreatedEv indicates that the system created a new terminal.

Example 1: One use might be to turn on the button-pressed events that normally do not get not delivered.

 Terminal term = provider.getTerminal(name);
 if (term instanceof CiscoTerm) {
     CiscoTerm ciscoTerm = (CiscoTerm) term;
     CiscoTermEvFilter filter = ciscoTerm.getFilter();
     filter.setButtonPressedEnabled(true);
 }
 term.addObserver(terminalObserver);
 

Example 2: Another use might be turning off events that are not of interest to an application. For example, an application doing pure call control could turn off the media (RTP) events as follows:

 Terminal term = provider.getTerminal(name);
 if (term instanceof CiscoTerm) {
     CiscoTerm ciscoTerm = (CiscoTerm) term;
     CiscoTermEvFilter filter = ciscoTerm.getFilter();
     filter.setRTPEventsEnabled(false);
     ciscoTerm.setFilter(filter);
 }
 term.addObserver(terminalObserver);
 term.getAddresses()[0].addCallObserver(callObserver);
 

Note:
Adding a CallObserver (without explicitly setting a filter) turns the RTP events on. This behaviour of Cisco JTAPI Release 1.4 and earlier is still preserved. If an explicit setFilter call gets made, the filter settings will take effect. The RTP events will not get delivered for the previous code snippet, but will get delivered for the following example:

 Terminal term = provider.getTerminal(name);
 term.addObserver(terminalObserver);
 term.getAddresses()[0].addCallObserver(callObserver);
 


unPark

javax.telephony.TerminalConnection unPark(javax.telephony.Address unParkAddress,
                                          java.lang.String parkedAt)
                                          throws javax.telephony.InvalidStateException,
                                                 javax.telephony.InvalidArgumentException,
                                                 javax.telephony.ResourceUnavailableException
Unparks a call at a terminal and returns a terminalConnection. The CiscoTerminal must be in the CiscoTerminal.IN_SERVICE state and its Provider must be in the Provider.IN_SERVICE state. This method takes an address and string as input.

Parameters:
unParkAddress - Any address on the terminal
parkedAt - A string identifying is system park port where a call was previously parked. The system returns this string when the call gets parked.
Throws:
javax.telephony.InvalidStateException - The CiscoTerminal.getState() is not IN_SERVICE.
javax.telephony.PlatformException - Any other error occurred while unparking (for example, the Unpark number is not valid).
javax.telephony.InvalidArgumentException
javax.telephony.ResourceUnavailableException

getDeviceState

int getDeviceState()
                   throws javax.telephony.InvalidStateException
Returns the DeviceState of this terminal. The DeviceState is the accumulative call state of all the addresses on the terminal. The state may be any of the following constants:

Returns:
The DeviceState of this terminal
Throws:
javax.telephony.InvalidStateException - CiscoTerminal.getState() is not IN_SERVICE.

getSupportedEncoding

int getSupportedEncoding()
                         throws javax.telephony.InvalidStateException
Returns the supported encoding types for this terminal. Use this method to check whether a terminal supports Unicode. To access this information, the terminal must be in the CiscoTerminal.IN_SERVICE state. The supportedEncoding is one of the following constants:

Returns:
The supportedEncoding of this terminal
Throws:
javax.telephony.InvalidStateException

getLocale

int getLocale()
              throws javax.telephony.InvalidStateException
Returns the locale that this terminal supports. To access this method, the terminal must be in the CiscoTerminal.IN_SERVICE state.

Throws:
javax.telephony.InvalidStateException - CiscoTerminal.getState() is not IN_SERVICE.

isRestricted

boolean isRestricted()
Returns the restriction status of this terminal. If a terminal is restricted, all associated addresses on the terminal are also restricted.

Returns:
True if terminal is restricted; otherwise false
See Also:
CiscoAddress.getRestrictedAddrTerminals()

createSnapshot

void createSnapshot()
                    throws javax.telephony.InvalidStateException
Generates a CiscoTermSnapshotEv event, which contains the security status of the current active call on the terminal. To access this method, the terminal must be in the CiscoTerminal.IN_SERVICE state and CiscoTermEvFilter.setSnapshotEnabled () must be set to true.

Throws:
javax.telephony.InvalidStateException - CiscoTerminal.getState() is not IN_SERVICE.

getAltScript

java.lang.String getAltScript()
                              throws javax.telephony.InvalidStateException
Returns the locale alternate script that this terminal supports. An empty return value indicates that this terminal does not support or is not configured with an alternate script. To access this method, the terminal must be in the CiscoTerminal.IN_SERVICE state.

Throws:
javax.telephony.InvalidStateException - CiscoTerminal.getState() is not IN_SERVICE.

getProtocol

int getProtocol()
Reports the terminal protocol (SCCP, SIP, CTI_REMOTE_DEVICE, or NONE).

Returns:
The protocol of this terminal, one of the following constants:
  • CiscoTerminalProtocol.PROTOCOL_NONE
  • CiscoTerminalProtocol.PROTOCOL_SCCP
  • CiscoTerminalProtocol.PROTOCOL_SIP
  • CiscoTerminalProtocol.PROTOCOL_CTI_REMOTE_DEVICE

setDNDStatus

void setDNDStatus(boolean dndStatus)
                  throws javax.telephony.InvalidStateException
Sets the DND status, which enables or disables the DND feature. This feature does not apply to route points.

Parameters:
dndStatus -
Throws:
javax.telephony.InvalidStateException - CiscoTerminal.getState() is not IN_SERVICE.

getDNDStatus

boolean getDNDStatus()
                     throws javax.telephony.InvalidStateException
Reports the DND status.

Returns:
boolean dndStatus
Throws:
javax.telephony.InvalidStateException - CiscoTerminal.getState() is not IN_SERVICE.

getDNDOption

int getDNDOption()
                 throws javax.telephony.InvalidStateException
Returns the value of the DND option. This value is not significant for a CiscoMediaTerminal or CiscoRouteTerminal because the DND feature applies only to physical phones. The DND option can be any of the following constants:

Returns:
int The value of the DND option currently set for this CiscoTerminal.
Throws:
javax.telephony.InvalidStateException - CiscoTerminal.getState() is not IN_SERVICE.

getIPAddressingMode

int getIPAddressingMode()
Application can invoke this API to query the IP Addressing Mode of the CiscoTerminal Addressing mode may be any of the following constants:

getEMLoginUsername

java.lang.String getEMLoginUsername()
                                    throws javax.telephony.InvalidStateException
Returns Extension mobility(EM) Login UserName If no EM user has logged into Terminal, this interface will return null/empty string

Returns:
String with ExtensionMobility User login name
Throws:
javax.telephony.InvalidStateException - if CiscoTerminal.getState() is not IN_SERVICE.

pickup

CiscoCall pickup(javax.telephony.Address pickingAddress)
                 throws javax.telephony.InvalidStateException
This method will pickup the longest ringing call from the Pickup Group to which pickingAddress belongs to.

Parameters:
pickingAddress - the Address on the Terminal where the Call is picked up.
Returns:
The Final Call object that results from the pickup operation.
Throws:
javax.telephony.InvalidStateException
Since:
8.0

groupPickup

CiscoCall groupPickup(javax.telephony.Address pickingAddress,
                      java.lang.String pickupGroupNumber)
                      throws javax.telephony.InvalidStateException
This method will pickup the longest ringing call from the specified pickupGroupNumber at the pickingAddress.

Parameters:
pickingAddress - the Address on the Terminal where the Call is picked up. To invoke groupPickup, the pickingAddress must belong to any pickup group.
pickupGroupNumber -
Returns:
The Final Call object that results from the group pickup operation.
Throws:
javax.telephony.InvalidStateException
Since:
8.0

directedPickup

CiscoCall directedPickup(javax.telephony.Address pickingAddress,
                         java.lang.String ringingDN)
                         throws javax.telephony.InvalidStateException
This method will pickup the call from the specified ringingDN at the pickingAddress. The ringingDN must be in the same Pickup Group as the pickingAddress.

Parameters:
pickingAddress - the Address on the Terminal where the Call is picked up.
Returns:
The Final Call object that results from the other pickup operation.
Throws:
javax.telephony.InvalidStateException
Since:
8.0

otherPickup

CiscoCall otherPickup(javax.telephony.Address pickingAddress)
                      throws javax.telephony.InvalidStateException
This method will pickup a call based upon the priority of the associated pickupgroups. Within the group, if there are more than one call, the longest ringing call will be picked up.

Parameters:
pickingAddress -
Returns:
The Final Call object that results from the directed pickup operation.
Throws:
javax.telephony.InvalidStateException
Since:
8.0

getLoginType

int getLoginType()
                 throws javax.telephony.InvalidStateException
This method will return the login type of the terminal, to indicate if terminal is local to the cluster or not, when EM login is done

getIPV4Address

java.net.InetAddress getIPV4Address()
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.MethodNotSupportedException
Returns the IPV4 address of the Terminal or null

Throws:
javax.telephony.InvalidStateException - if CiscoTerminal is not registered
javax.telephony.MethodNotSupportedException - if Terminal is a CiscoMediaTerminal or CiscoRouteTerminal
Since:
7.1.3

getIPV6Address

java.net.InetAddress getIPV6Address()
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.MethodNotSupportedException
Returns the IPV6 address of the Terminal or null

Throws:
javax.telephony.InvalidStateException - if CiscoTerminal is not registered
javax.telephony.MethodNotSupportedException - if Terminal is a CTIPort or RP
Since:
7.1.3

isRegistered

boolean isRegistered()
Returns true if Terminal is registered else false

Since:
7.1.3

getRollOverConfig

int getRollOverConfig()
                      throws javax.telephony.InvalidStateException
Returns the configured out bound RollOver mode on the Terminal

Throws:
javax.telephony.InvalidStateException - CiscoTerminal is not registered
Since:
7.1.3

canConsultCallRollOver

boolean canConsultCallRollOver(int which_user)
                               throws javax.telephony.InvalidStateException
Returns true if Terminal allows consult call to Roll over

Parameters:
which_user - one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
Returns:
boolean
Throws:
javax.telephony.InvalidStateException - CiscoTerminal is not registered

canOutBoundCallRollOver

boolean canOutBoundCallRollOver(int which_user)
                                throws javax.telephony.InvalidStateException
Returns true if Terminal allows out bound calls to Roll over

Parameters:
which_user - one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
Returns:
boolean
Throws:
javax.telephony.InvalidStateException - CiscoTerminal is not registered

canJoinAcrossLines

boolean canJoinAcrossLines(int which_user)
                           throws javax.telephony.InvalidStateException
Returns true if Terminal allows calls on different addresses on this Terminal to be joined(conference) else false

Parameters:
which_user - one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
Returns:
boolean
Throws:
javax.telephony.InvalidStateException - CiscoTerminal is not registered

canDirectTransferAcrossLines

boolean canDirectTransferAcrossLines(int which_user)
                                     throws javax.telephony.InvalidStateException
Returns true if Terminal allows calls on different addresses on this Terminal to be transferred else false

Parameters:
which_user - one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
Returns:
boolean
Throws:
javax.telephony.InvalidStateException - CiscoTerminal is not registered

canJoinOnSameLine

boolean canJoinOnSameLine(int which_user)
                          throws javax.telephony.InvalidStateException
Returns true if Terminal allows calls on same address on this Terminal to be joined(conferenced) else false

Parameters:
which_user - one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
Returns:
boolean
Throws:
javax.telephony.InvalidStateException - CiscoTerminal is not registered

canDirectTransferOnSameLine

boolean canDirectTransferOnSameLine(int which_user)
                                    throws javax.telephony.InvalidStateException
Returns true if Terminal allows calls on same address on this Terminal to be transferred else false

Parameters:
which_user - one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
Returns:
boolean
Throws:
javax.telephony.InvalidStateException - CiscoTerminal is not registered

isBuiltInBridgeEnabled

boolean isBuiltInBridgeEnabled()
                               throws javax.telephony.InvalidStateException,
                                      javax.telephony.MethodNotSupportedException
Returns true if the Built-In-Bridge is enabled on this terminal otherwise returns false

Returns:
boolean
Throws:
javax.telephony.InvalidStateException - If terminal is not registered
javax.telephony.MethodNotSupportedException - If the terminal is a CiscoMediaTerminal or a CiscoRouteTerminal
Since:
8.5.1

register

void register()
              throws CiscoRegistrationException,
                     javax.telephony.MethodNotSupportedException
Deprecated. This method is being deprecated from 9.1.1 and later due to removal of extend and connect support in CUCSF.

This method registers Cisco Unified Client Services Framework terminal to Extend mode, which will be represented as a CiscoRemoteTerminal. This is intended to be used by application monitoring Cisco Unified Client Services Framework terminal to enable its Extend mode from its softphone(SIP)/deskphone mode. The successful effect of this method is to register the terminal and present as a CiscoRemoteTerminal terminal type (if it is not already a CiscoRemoteTerminal), and be able to use CTI Extend & Connect (CTI Remote Device) supported features with remote destinations. In any case when it switches in between Softphone/Deskphone & Extend modes that results in a terminal switching (e.g. CiscoTerminal->CiscoRemoteTerminal), there will be provider events sent to application: CiscoAddrRemovedEv, CiscoTermRemovedEv, CiscoAddrCreatedEv, CiscoTermCreatedEv. Any observers on the terminal and address will be removed, application needs to de-reference the old terminal object and re-add any desired observers. Note that CiscoProvider must be in Provider.IN_SERVICE state, otherwise a CiscoRegistrationException about InvalidStateException will be thrown; or if terminal is already registered by this application in Extend mode or the registration fails for any reason, a CiscoRegistrationException will be thrown. And if terminal type is not CiscoTerminal or CiscoRemoteTerminal and if terminal is not a Cisco Unified Client Services Framework terminal, then MethodNotSupportedException will be thrown.

Throws:
CiscoRegistrationException
javax.telephony.MethodNotSupportedException
Since:
9.0.1

unregister

void unregister()
                throws CiscoUnregistrationException,
                       javax.telephony.MethodNotSupportedException
Deprecated. This method is being deprecated from 9.1.1 and later due to removal of extend and connect support in CUCSF.

This method unregisters Cisco Unified Client Services Framework terminal from Extend mode. Its terminal type will remain as CiscoRemoteTerminal, and application can explicitly register to CUCM to switch back to its softphone/deskphone mode. This is intended to be used by application monitoring Cisco Unified Client Services Framework terminal in Cisco Extend Connect mode to disable its Cisco Extend Connect mode. The successful effect of this method is to unregister the terminal but retains as a CiscoRemoteTerminal. Note that CiscoProvider must be in Provider.IN_SERVICE state, otherwise a CiscoUnregistrationException about InvalidStateException will be thrown; or if terminal is not registered in Extend mode by this application or the unregistration fails for any reason, a CiscoUnregistrationException will be thrown. And if terminal type is not CiscoRemoteTerminal and if terminal is not a Cisco Unified Client Services Framework terminal, then MethodNotSupportedException will be thrown.

Throws:
CiscoUnregistrationException
javax.telephony.MethodNotSupportedException
Since:
9.0.1

getType

int getType()
This method returns the device type of Terminal, which can be one of the following contants. It will return CiscoTerminal.DEVICETYPE_UNKNOWN if type of device cannot be found or device/terminal is invalid.

Returns:
int
Since:
9.0.1

getTypeName

java.lang.String getTypeName()
This method returns the device type name of Terminal (i.e. The display name of the device type). It will return an empty string if device type name cannot be found, or return null if device/terminal is invalid.

Returns:
String
Since:
9.0.1