|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CiscoAddress
The CiscoAddress
interface extends the Address
interface with additional Cisco-specific capabilities.
Address
Field Summary | |
---|---|
static int |
APPLICATION_CONTROLLED_RECORDING
Application controlled Recording is configured on the Address. |
static int |
AUTO_RECORDING
Auto Recording is configured on the Address. |
static int |
AUTOACCEPT_OFF
AutoAccept is off. |
static int |
AUTOACCEPT_ON
AutoAccept is on. |
static int |
AUTOANSWER_OFF
AutoAnswer is off. |
static int |
AUTOANSWER_UNKNOWN
AutoAnswer status is unknown. |
static int |
AUTOANSWER_WITHHEADSET
AutoAnswer is allowed with a headset. |
static int |
AUTOANSWER_WITHSPEAKERSET
AutoAnswer is allowed with a speaker set. |
static int |
EXTERNAL
This represents an external address with a valid name. |
static int |
EXTERNAL_UNKNOWN
This represents an external address with an unknown name. |
static int |
IN_SERVICE
The address is in service. |
static int |
INTERNAL
This is an internal address. |
static int |
MONITORING_TARGET
This represents an address with a monitoring target or agent. |
static int |
NO_RECORDING
Recording is off on the Address. |
static int |
OUT_OF_SERVICE
The address is out-of-service. |
static int |
RINGER_DEFAULT
Sets the ringer status to the 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 represents an address with an unknown name. |
Method Summary | |
---|---|
void |
clearCallConnections()
Use this interface to clear any phantom calls on the address. |
CiscoAddressCallInfo |
getAddressCallInfo(javax.telephony.Terminal terminal)
Use this Interface to get information about calls that are present at the Terminal. |
int |
getAutoAcceptStatus(javax.telephony.Terminal terminal)
Returns the AutoAccept status of the Address on the Terminal. |
int |
getAutoAnswerStatus(javax.telephony.Terminal term)
This interface returns the AutoAnswer status of this Address on given Terminal. |
javax.telephony.Terminal[] |
getInServiceAddrTerminals()
Use this interface to find out which Shared Lines are in service. |
java.lang.String |
getPartition()
It returns the partition associated with an Address. |
int |
getRecordingConfig(javax.telephony.Terminal term)
Returns the configured recording type on this Address. |
int |
getRegistrationState()
Deprecated. This method has been replaced by the getState() method. |
javax.telephony.Terminal[] |
getRestrictedAddrTerminals()
Returns the array of Terminals on which this Address is restricted. |
int |
getState()
Returns the state of this address. |
int |
getType()
Returns the type of this address. |
boolean |
isRestricted(javax.telephony.Terminal terminal)
This method returns true if this Address on Terminal is restricted. |
void |
setAutoAcceptStatus(int autoAcceptStatus,
javax.telephony.Terminal terminal)
This method lets an application enable AutoAccept for this Address 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 status)
Changes the ringer status on this address. |
Methods inherited from interface javax.telephony.Address |
---|
addCallObserver, addObserver, getAddressCapabilities, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeCallObserver, removeObserver |
Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer |
---|
getObject, setObject |
Field Detail |
---|
static final int INTERNAL
static final int EXTERNAL
static final int EXTERNAL_UNKNOWN
static final int UNKNOWN
static final int MONITORING_TARGET
static final int OUT_OF_SERVICE
static final int IN_SERVICE
static final int RINGER_DEFAULT
static final int RINGER_DISABLE
static final int RINGER_ENABLE
static final int AUTOACCEPT_OFF
static final int AUTOACCEPT_ON
static final int AUTOANSWER_OFF
static final int AUTOANSWER_WITHHEADSET
static final int AUTOANSWER_WITHSPEAKERSET
static final int AUTOANSWER_UNKNOWN
static final int NO_RECORDING
static final int AUTO_RECORDING
static final int APPLICATION_CONTROLLED_RECORDING
Method Detail |
---|
int getType()
int getRegistrationState()
The state may be any of the following constants:
int getState()
The state may be any of the following constants:
void setRingerStatus(int status) throws javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException
javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
javax.telephony.InvalidArgumentException
void clearCallConnections() throws javax.telephony.PrivilegeViolationException
javax.telephony.PrivilegeViolationException
CiscoAddressCallInfo getAddressCallInfo(javax.telephony.Terminal terminal)
void setMessageWaiting(java.lang.String destination, boolean enable) throws javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.PrivilegeViolationException
destination
.
If enable
is true, message-waiting gets
activated if not already activated. If enable
is false, message-waiting gets
deactivated if not already deactivated.
Pre-conditions:
destination
- DN/Address whose message-waiting indicator should be activated/deactivatedenable
- True to activate message-waiting, false to deactivate
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.javax.telephony.Terminal[] getInServiceAddrTerminals()
javax.telephony.Terminal[] getRestrictedAddrTerminals()
Returns the array of Terminals on which this Address is restricted.
In shared lines, few lines on Terminals may be restricted. This method returns all the Terminals on which this Address is restricted. Applications will not be able to see any call events for restricted Addresses. If a restricted Address is involved in a call with any other controlled Terminal, the system creates an Connection for the restricted Address, but there will not be any TerminalConnection for the restricted Address.
If none is restricted, this method returns null.
boolean isRestricted(javax.telephony.Terminal terminal)
This method returns true if this Address on Terminal is restricted.
void setAutoAcceptStatus(int autoAcceptStatus, javax.telephony.Terminal terminal) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
Pre-conditions:
autoAcceptStatus
- 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
- The Terminal on which AutoAccept will be enabled
javax.telephony.InvalidStateException
- The Provider or Address is not "In_Service".
javax.telephony.PlatformException
- The Terminal does not have this Address.
javax.telephony.MethodNotSupportedException
- If the Terminal is not CiscoMediaTerminal or CiscoRouteTerminal.int getAutoAcceptStatus(javax.telephony.Terminal terminal) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
Pre-conditions:
terminal
- The Terminal on which the AutoAccept status
of the Address will be returned
javax.telephony.InvalidStateException
- The Provider or Address is not "IN_SERVICE".
javax.telephony.PlatformException
- The Address is not on the Terminal.
javax.telephony.MethodNotSupportedException
- If the Terminal is not CiscoMediaTerminal or CiscoRouteTerminal.java.lang.String getPartition()
int getAutoAnswerStatus(javax.telephony.Terminal term) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
This interface returns the AutoAnswer status of this Address on given Terminal. If return value is AUTOANSWER_OFF, that means AutoAnswer is disabled. If return value is AUTOANSWER_WITHHEADSET, that means AutoAnswer is enabled with HEADSET. If return value is AUTOANSWER_WITHSPEAKERSET, that means AutoAnswer is enabled with SPEAKERSET. If return value is AUTOANSWER_UNKNOWN, that means AutoAnswer status is UNKNOWN.
Pre-conditions:
term
- Terminal at which AutoAnswer is checked
javax.telephony.InvalidStateException
- The Provider or Address is not"IN_SERVICE".
javax.telephony.PlatformException
- If Address is not on Terminal term
javax.telephony.MethodNotSupportedException
- If Address is an External Addressint getRecordingConfig(javax.telephony.Terminal term) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
- The Provider or Address is not"IN_SERVICE".
javax.telephony.PlatformException
- If Address is not on Terminal term
javax.telephony.MethodNotSupportedException
- If Address is an External Address
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |