|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CiscoTerminal
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.
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 |
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_IPv4 CiscoTerminal.IP_ADDRESSING_IPv6 CiscoTerminal.IP_ADDRESSING_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, 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. |
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. |
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. |
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 |
---|
static final int OUT_OF_SERVICE
static final int IN_SERVICE
static final int DEVICESTATE_IDLE
static final int DEVICESTATE_ACTIVE
static final int DEVICESTATE_ALERTING
static final int DEVICESTATE_HELD
static final int DEVICESTATE_UNKNOWN
CiscoTermEvFilter
,
Constant Field Valuesstatic final int DEVICESTATE_WHISPER
static final int UNKNOWN_ENCODING
CiscoTerminal.getSupportedEncoding ()
for this terminal is
UNKNOWN.
static final int NOT_APPLICABLE
CiscoTerminal.getSupportedEncoding ()
for this
CiscoMediaTerminal or RoutePoint is NOT_APPLICABLE.
static final int ASCII_ENCODING
CiscoTerminal.getSupportedEncoding ()
for this terminal is
ASCII and that this terminal supports only ASCII_ENCODING.
static final int UCS2UNICODE_ENCODING
CiscoTerminal.getSupportedEncoding ()
for this terminal is
UCS2UNICODE_ENCODING.
static final int DND_OPTION_NONE
static final int DND_OPTION_RINGER_OFF
static final int DND_OPTION_CALL_REJECT
static final int NO_LOGIN
static final int NATIVE_LOGIN
static final int VISITOR_LOGIN
static final int IP_ADDRESSING_MODE_UNKNOWN
static final int IP_ADDRESSING_MODE_IPV4
static final int IP_ADDRESSING_MODE_IPV6
static final int IP_ADDRESSING_MODE_IPV4_V6
static final int IP_ADDRESSING_MODE_UNKNOWN_ANATRED
static final int NO_ROLLOVER
static final int ROLLOVER_SAME_DN
static final int ROLLOVER_ANY_DN
static final int PHONE_USER
static final int APPLICATION
Method Detail |
---|
int getRegistrationState()
int getState()
CiscoRTPInputProperties getRTPInputProperties() throws javax.telephony.InvalidStateException
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.
ACTIVE
TerminalConnection on this terminal
javax.telephony.InvalidStateException
CiscoRTPOutputProperties getRTPOutputProperties() throws javax.telephony.InvalidStateException
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.
ACTIVE
TerminalConnection on this terminal
javax.telephony.InvalidStateException
java.lang.String sendData(java.lang.String terminalData) throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
CiscoTerminal.sendData ( byte[] )
.
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException
byte[] sendData(byte[] terminalData) throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
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.
javax.telephony.PlatformException
- The data did not get sent successfully.
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException
CiscoTermEvFilter getFilter()
void setFilter(CiscoTermEvFilter terminalEvFilter)
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);
javax.telephony.TerminalConnection unPark(javax.telephony.Address unParkAddress, java.lang.String parkedAt) throws javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException, javax.telephony.ResourceUnavailableException
CiscoTerminal.IN_SERVICE
state and its Provider must be in the
Provider.IN_SERVICE
state. This method takes an address and string as input.
unParkAddress
- Any address on the terminalparkedAt
- A string identifying is system park port where a call was previously parked. The
system returns this string when the call gets parked.
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
int getDeviceState() throws javax.telephony.InvalidStateException
javax.telephony.InvalidStateException
- CiscoTerminal.getState() is not IN_SERVICE.int getSupportedEncoding() throws javax.telephony.InvalidStateException
CiscoTerminal.IN_SERVICE
state. The supportedEncoding is one of the following
constants:
javax.telephony.InvalidStateException
int getLocale() throws javax.telephony.InvalidStateException
CiscoTerminal.IN_SERVICE
state.
javax.telephony.InvalidStateException
- CiscoTerminal.getState() is not IN_SERVICE.boolean isRestricted()
CiscoAddress.getRestrictedAddrTerminals()
void createSnapshot() throws javax.telephony.InvalidStateException
CiscoTerminal.IN_SERVICE
state and
CiscoTermEvFilter.setSnapshotEnabled ()
must be set to true.
javax.telephony.InvalidStateException
- CiscoTerminal.getState() is not IN_SERVICE.java.lang.String getAltScript() throws javax.telephony.InvalidStateException
CiscoTerminal.IN_SERVICE
state.
javax.telephony.InvalidStateException
- CiscoTerminal.getState() is not IN_SERVICE.int getProtocol()
void setDNDStatus(boolean dndStatus) throws javax.telephony.InvalidStateException
dndStatus
-
javax.telephony.InvalidStateException
- CiscoTerminal.getState() is not IN_SERVICE.boolean getDNDStatus() throws javax.telephony.InvalidStateException
javax.telephony.InvalidStateException
- CiscoTerminal.getState() is not IN_SERVICE.int getDNDOption() throws javax.telephony.InvalidStateException
javax.telephony.InvalidStateException
- CiscoTerminal.getState() is not IN_SERVICE.int getIPAddressingMode()
java.lang.String getEMLoginUsername() throws javax.telephony.InvalidStateException
javax.telephony.InvalidStateException
- if CiscoTerminal.getState() is not IN_SERVICE.CiscoCall pickup(javax.telephony.Address pickingAddress) throws javax.telephony.InvalidStateException
pickingAddress
- the Address on the Terminal where the Call is picked up.
javax.telephony.InvalidStateException
CiscoCall groupPickup(javax.telephony.Address pickingAddress, java.lang.String pickupGroupNumber) throws javax.telephony.InvalidStateException
pickingAddress
- the Address on the Terminal where the Call is picked up. To invoke groupPickup,
the pickingAddress must belong to any pickup group.pickupGroupNumber
-
javax.telephony.InvalidStateException
CiscoCall directedPickup(javax.telephony.Address pickingAddress, java.lang.String ringingDN) throws javax.telephony.InvalidStateException
pickingAddress
- the Address on the Terminal where the Call is picked up.
javax.telephony.InvalidStateException
CiscoCall otherPickup(javax.telephony.Address pickingAddress) throws javax.telephony.InvalidStateException
pickingAddress
-
javax.telephony.InvalidStateException
int getLoginType() throws javax.telephony.InvalidStateException
javax.telephony.InvalidStateException
java.net.InetAddress getIPV4Address() throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
- if CiscoTerminal is not registered
javax.telephony.MethodNotSupportedException
- if Terminal is a CiscoMediaTerminal or CiscoRouteTerminaljava.net.InetAddress getIPV6Address() throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
- if CiscoTerminal is not registered
javax.telephony.MethodNotSupportedException
- if Terminal is a CTIPort or RPboolean isRegistered()
int getRollOverConfig() throws javax.telephony.InvalidStateException
javax.telephony.InvalidStateException
- CiscoTerminal is not registeredboolean canConsultCallRollOver(int which_user) throws javax.telephony.InvalidStateException
which_user
- one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
javax.telephony.InvalidStateException
- CiscoTerminal is not registeredboolean canOutBoundCallRollOver(int which_user) throws javax.telephony.InvalidStateException
which_user
- one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
javax.telephony.InvalidStateException
- CiscoTerminal is not registeredboolean canJoinAcrossLines(int which_user) throws javax.telephony.InvalidStateException
which_user
- one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
javax.telephony.InvalidStateException
- CiscoTerminal is not registeredboolean canDirectTransferAcrossLines(int which_user) throws javax.telephony.InvalidStateException
which_user
- one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
javax.telephony.InvalidStateException
- CiscoTerminal is not registeredboolean canJoinOnSameLine(int which_user) throws javax.telephony.InvalidStateException
which_user
- one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
javax.telephony.InvalidStateException
- CiscoTerminal is not registeredboolean canDirectTransferOnSameLine(int which_user) throws javax.telephony.InvalidStateException
which_user
- one of CiscoTerminal.PHONE_USER or CiscoTerminal.APPLICATION
javax.telephony.InvalidStateException
- CiscoTerminal is not registeredboolean isBuiltInBridgeEnabled() throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
- If terminal is not registered
javax.telephony.MethodNotSupportedException
- If the terminal is a CiscoMediaTerminal or a CiscoRouteTerminal
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |