com.cisco.jtapi.extensions
Interface CiscoProviderCapabilities

All Superinterfaces:
javax.telephony.capabilities.ProviderCapabilities

public interface CiscoProviderCapabilities
extends javax.telephony.capabilities.ProviderCapabilities

Introduction

This interface defines the Cisco-specific provider capabilities that Cisco Unified JTAPI offers.


Method Summary
 boolean canAutoPickup()
          This interface returns true if the Service Parameter "Auto Pickup Enabled" is true.
 boolean canModifyCallingParty()
          This method checks whether the user has been provisioned in the Cisco Unified Communications Manager to modify the calling party number of a call.
 boolean canMonitor()
          This method checks whether a user has been provisioned in the Cisco Unified Communications Manager to monitor calls.
 boolean canMonitorParkDNs()
          This method checks whether the user has been provisioned in the Cisco Unified Communications Manager to monitor park DNs.
 boolean canObserveAnyTerminal()
           This method checks whether the user has been provisioned in the Cisco Unified Communications Manager with the privilege to observe any Terminal (and its addresses) in the system.
 boolean canObserveTerminalsWithRollOverMode()
          This method returns true if 'Standard CTI Allow Control of Phones supporting Rollover Mode' role is assigned to the user.
 boolean canRecord()
          This method checks whether the user has been provisioned in the Cisco Unified Communications Manager to record calls.
 boolean canSupportConnectedTransferConference()
          This method checks whether or not a user has been provisioned in the Cisco Unified Communications Manager to support connected Transfer and Conference calls.
 boolean canSupportIPv6()
          This interface returns true if Enterprise Parameter "Enable IPv6" is enabled and false otherwise
 
Methods inherited from interface javax.telephony.capabilities.ProviderCapabilities
isObservable
 

Method Detail

canObserveAnyTerminal

boolean canObserveAnyTerminal()

This method checks whether the user has been provisioned in the Cisco Unified Communications Manager with the privilege to observe any Terminal (and its addresses) in the system. Such Terminals and Addresses do not get returned as part of the list that JTAPI initializes at startup. The provider obtained with the login for a user with such privileges can be determined from the canObserverAnyTerminal method call in ProviderCapabilities.

Example:
 Provider p = peer.getProvider(loginString);
 ProviderCapabilities caps = p.getCapabilities();
 if (caps instanceof CiscoProviderCapabilities) {
     boolean canObserveAnyTerminal = ((CiscoProviderCapabilities) caps).canObserveAnyTerminal();
     boolean canMonitorParkDN = ((CiscoProviderCapabilities) caps).canMonitorParkDNs();
     boolean canModifyCallingPN = ((CiscoProviderCapabilities) caps).canModifyCallingParty();
     boolean canRecordCalls = ((CiscoProviderCapabilities) caps).canRecord();
     boolean canMonitorCalls = ((CiscoProviderCapabilities) caps).canMonitor();
 }
 

Returns:
True if the user can observe any Terminal in the system, or false if the user can only observe Terminals and Addresses in the control list

canMonitorParkDNs

boolean canMonitorParkDNs()
This method checks whether the user has been provisioned in the Cisco Unified Communications Manager to monitor park DNs.

Returns:
True if the user can monitor park DNs, or false otherwise
See Also:
canObserveAnyTerminal()

canModifyCallingParty

boolean canModifyCallingParty()
This method checks whether the user has been provisioned in the Cisco Unified Communications Manager to modify the calling party number of a call.

Returns:
True if the user can modify the calling party number, or false otherwise
See Also:
canObserveAnyTerminal()

canRecord

boolean canRecord()
This method checks whether the user has been provisioned in the Cisco Unified Communications Manager to record calls. Only users in 'Standard CTI Allow Call Recording' user group can record calls.

Returns:
True if the user belongs to the group

canMonitor

boolean canMonitor()
This method checks whether a user has been provisioned in the Cisco Unified Communications Manager to monitor calls. Only users in 'Standard CTI Allow Call Monitoring' user group can initiate call monitoring request.

Returns:
True if the user belongs to the group

canSupportIPv6

boolean canSupportIPv6()
This interface returns true if Enterprise Parameter "Enable IPv6" is enabled and false otherwise

Returns:
boolean
Since:
7.0

canSupportConnectedTransferConference

boolean canSupportConnectedTransferConference()
This method checks whether or not a user has been provisioned in the Cisco Unified Communications Manager to support connected Transfer and Conference calls. Only users in the Standard Supports Connected Xfer/Conf user group can control/observe devices that support connected Transfer/Confernce. If the user is not associated with this user group then the devices that support this feature are restricted

Returns:
True if the user belongs to the Standard Supports Connected Xfer/Conf user group.
Since:
7.1

canObserveTerminalsWithRollOverMode

boolean canObserveTerminalsWithRollOverMode()
This method returns true if 'Standard CTI Allow Control of Phones supporting Rollover Mode' role is assigned to the user. Applications can observer terminals configured with roll over mode only when this role is enabled. If the user is not associated with this role then the terminals with roll over mode are restricted.

Returns:
True if the user belongs to the 'Standard CTI Allow Control of Phones supporting Rollover Mode' group.
Since:
7.1

canAutoPickup

boolean canAutoPickup()
This interface returns true if the Service Parameter "Auto Pickup Enabled" is true.

Returns:
boolean value representing the status of the service parameter.
Since:
8.0