com.cisco.jtapi.extensions
Interface CiscoIntercomAddress

All Superinterfaces:

javax.telephony.Address, CiscoAddress, CiscoObjectContainer

public interface CiscoIntercomAddress
extends CiscoAddress

Introduction

The CiscoIntercomAddress interface extends the CiscoAddress interface with additional Unified CM-specific capabilities for intercom addresses. This interface lets applications initiate intercom calls and take advantage of other intercom-specific features.

See Also:

CiscoAddress

Field Summary

Fields inherited from interface com.cisco.jtapi.extensions.CiscoAddress

APPLICATION_CONTROLLED_RECORDING, AUTO_RECORDING, AUTOACCEPT_OFF, AUTOACCEPT_ON, AUTOANSWER_OFF, AUTOANSWER_UNKNOWN, AUTOANSWER_WITHHEADSET, AUTOANSWER_WITHSPEAKERSET, DEVICE_CONTROLLED_RECORDING, EXTERNAL, EXTERNAL_UNKNOWN, HUNT_PILOT, IN_SERVICE, INTERNAL, MONITORING_TARGET, NO_RECORDING, OUT_OF_SERVICE, RINGER_DEFAULT, RINGER_DISABLE, RINGER_ENABLE, UNKNOWN

Method Summary

javax.telephony.Connection[]	connectIntercom(javax.telephony.Terminal terminal, java.lang.String targetNumber) Places an intercom call from an originating intercom address to a destination intercom address.
java.lang.String	getDefaultIntercomTargetAsciiLabel() Returns the default intercom target label that is configured through Unified CM administration.
java.lang.String	getDefaultIntercomTargetNumber() Returns the default intercom target DN that is configured through Unified CM administration.
java.lang.String	getDefaultIntercomTargetUnicodeLabel() Returns the default intercom target label that is configured through Unified CM administration.
java.lang.String	getIntercomTargetAsciiLabel() Returns the current intercom target label that the application set.
java.lang.String	getIntercomTargetNumber() Returns the current intercom target DN that the application set.
java.lang.String	getIntercomTargetUnicodeLabel() Returns the current intercom target Unicode label that the application set.
boolean	isIntercomTargetSet() Returns true if an application has overridden the current value, or false if the current value matches the default value configured in the database
void	resetIntercomTarget() Resets the intercom target DN, intercom target label, and intercom target Unicode label to their default values.
void	setIntercomTarget(java.lang.String targetDN, java.lang.String targetAsciiLabel, java.lang.String targetUnicodeLabel) Sets the intercom target DN, intercom target label, and intercom target Unicode label that appear next to the intercom line on the phone.

Methods inherited from interface com.cisco.jtapi.extensions.CiscoAddress

clearCallConnections, getAddressCallInfo, getAsciiLabel, getAutoAcceptStatus, getAutoAnswerStatus, getBusyTrigger, getButtonPosition, getFilter, getInServiceAddrTerminals, getMaxCalls, getPartition, getPickupGroup, getRecordingConfig, getRegistrationState, getRestrictedAddrTerminals, getState, getType, getUnicodeLabel, getVoiceMailPilot, isRestricted, setAutoAcceptStatus, setFilter, setMessageSummary, setMessageSummary, setMessageWaiting, setRingerStatus

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

Method Detail

setIntercomTarget

void setIntercomTarget(java.lang.String targetDN,
                       java.lang.String targetAsciiLabel,
                       java.lang.String targetUnicodeLabel)
                       throws javax.telephony.InvalidPartyException,
                              javax.telephony.InvalidStateException

Sets the intercom target DN, intercom target label, and intercom target Unicode label that appear next to the intercom line on the phone. The phone displays the Unicode label if the phone has that capability; otherwise, the phone displays the ASCII target label.

Parameters:

targetDN - Destination DN for the intercom call

targetAsciiLabel - ASCII display label shown next to the intercom line on the phone

targetUnicodeLabel - Unicode display label shown on the phone

Throws:

javax.telephony.InvalidPartyException - The target DN is not a valid number.

javax.telephony.InvalidStateException - The address, terminal, or provider is not in service.

isIntercomTargetSet

boolean isIntercomTargetSet()

Returns true if an application has overridden the current value, or false if the current value matches the default value configured in the database

Returns:

True or false

resetIntercomTarget

void resetIntercomTarget()
                         throws javax.telephony.InvalidPartyException,
                                javax.telephony.InvalidStateException

Resets the intercom target DN, intercom target label, and intercom target Unicode label to their default values.

Throws:

javax.telephony.InvalidPartyException

javax.telephony.InvalidStateException

getIntercomTargetNumber

java.lang.String getIntercomTargetNumber()

Returns the current intercom target DN that the application set. If the application has not set the intercom target DN, this interface returns the default intercom target DN that is configured in Unified CM administration.

Returns:

The intercom target DN number, as a String

getIntercomTargetAsciiLabel

java.lang.String getIntercomTargetAsciiLabel()

Returns the current intercom target label that the application set. If the application has not set the intercom target label, this interface returns the default intercom target label that is configured in Unified CM administration.

Returns:

The intercom target label string

getIntercomTargetUnicodeLabel

java.lang.String getIntercomTargetUnicodeLabel()

Returns the current intercom target Unicode label that the application set. If the application has not set the Unicode label, this interface returns the default intercom target Unicode label that is configured in Unified CM administration.

Returns:

The intercom Unicode target label string

getDefaultIntercomTargetNumber

java.lang.String getDefaultIntercomTargetNumber()

Returns the default intercom target DN that is configured through Unified CM administration.

Returns:

The default intercom target DN number, as a String

getDefaultIntercomTargetAsciiLabel

java.lang.String getDefaultIntercomTargetAsciiLabel()

Returns the default intercom target label that is configured through Unified CM administration.

Returns:

The default intercom target label string

getDefaultIntercomTargetUnicodeLabel

java.lang.String getDefaultIntercomTargetUnicodeLabel()

Returns the default intercom target label that is configured through Unified CM administration.

Returns:

The default Unicode intercom target label string

connectIntercom

javax.telephony.Connection[] connectIntercom(javax.telephony.Terminal terminal,
                                             java.lang.String targetNumber)
                                             throws javax.telephony.ResourceUnavailableException,
                                                    javax.telephony.InvalidPartyException,
                                                    javax.telephony.InvalidArgumentException,
                                                    javax.telephony.InvalidStateException,
                                                    javax.telephony.PrivilegeViolationException

Places an intercom call from an originating intercom address to a destination intercom address.

Returns:

A connection list for the calling and called intercom addresses

Throws:

javax.telephony.InvalidPartyException - The target DN is not a valid number.

javax.telephony.InvalidArgumentException - The address is not a CiscoIntercomAddress or the terminal is not a Terminal.

javax.telephony.InvalidStateException - The address, terminal, or provider is not in service.

javax.telephony.ResourceUnavailableException - A resource is not available to complete the operation.

javax.telephony.PrivilegeViolationException - The application does not have sufficient privileges to execute this operation.