CiscoCall[]

getCalls()

Returns the array of Cisco calls on the CiscoAddress.

CiscoCall[]

getTerminal()

Returns the terminal on which the address got activated (i.e. marked unrestricted)

int

getMaxActiveCalls()

Returns the maximum number of active calls supported on the CiscoAddress, as an integer.

int

getMaxCallsOnHold()

Returns the maximum number of calls that can be put on hold on the CiscoAddress, as an integer.

int

getNumActiveCalls()

Returns the number of active calls on the CiscoAddress, as an integer.

int

getNumCallsOnHold()

Returns the number of held calls on the CiscoAddress, as an integer.

public

CiscoG711MediaCapability(intrtpPacketFrameSize)

Constructs a CiscoG711MediaCapability.

public

CiscoG711MediaCapability()

Constructs a CiscoG711MediaCapability.

public static final int

FRAMESIZE_TWENTY_MILLISECOND_PACKET

RTP Packet Framesize: Twenty millisecond RTP packet.

public static final int

FRAMESIZE_THIRTY_MILLISECOND_PACKET

RTP Packet Framesize: Thirty millisecond RTP packet.

public static final int

FRAMESIZE_SIXTY_MILLISECOND_PACKET

RTP Packet Framesize: Sixty millisecond RTP packet.

public

CiscoG723MediaCapability (intrtpPacketFrameSize, intbitRate)

Constructs a CiscoG723MediaCapability.

public static final int

FRAMESIZE_TWENTY_MILLISECOND_PACKET

RTP Packet Framesize: Twenty millisecond RTP packet.

public static final int

FRAMESIZE_THIRTY_MILLISECOND_PACKET

RTP Packet Framesize: Thirty millisecond RTP packet.

public static final int

FRAMESIZE_SIXTY_MILLISECOND_PACKET

RTP Packet Framesize: Sixty millisecond RTP packet.

public int

getBitRate()

Returns the bit rate specified by this capability object. Returns: a bit rate from the RTPBitRate interface.

public java.lang.String

toString()

Overwrites the Object.toString() method. Overrides: toString in class CiscoMediaCapability.

CiscoG729MediaCapability(int payload, int rtpPacketFrameSize)

Constructs a CiscoG729MediaCapability.

staticint

FRAMESIZE_SIXTY_MILLISECOND_PACKET

RTP Packet Framesize: Sixty millisecond RTP packet.

staticint

FRAMESIZE_THIRTY_MILLISECOND_PACKET

RTP Packet Framesize: Thirty millisecond RTP packet.

staticint

FRAMESIZE_TWENTY_MILLISECOND_PACKET

RTP Packet Framesize: Twenty millisecond RTP packet.

public

CiscoGSMMediaCapability()

Constructs a CiscoGSMMediaCapability

public

CiscoGSMMediaCapability(int rtpPacketFrameSize)

Constructs a CiscoGSMMediaCapability.

staticint

FRAMESIZE_EIGHTY_MILLISECOND_PACKET

RTP Packet Framesize: Eighty millisecond RTP packet

java.lang.String

getBuildDescription()

Returns "release" if it is a release version or debug if it is not a release version.

int

getBuildNumber()

Returns the build number of the version.

int

getExtendedBuildNumber()

Returns the extended build number of the version.

int

getMajorVersion()

Returns the major version number.

int

getMinorVersion()

Returns the minor version number.

int

getRevisionNumber()

Returns the revision number of the version.

public java.lang.String

getVersion()

Returns the version information in a.b(x.y)-z format without a name.

public java.lang.String

toString()

Returns the version information in a.b(x.y)-z format. Overrides toString in class java.lang.Object.

public

CiscoMediaCapability(intpayloadType, intmaxFramesPerPacket)

Constructs a CiscoMediaCapability object for the specified payload type and packet size (in milliseconds).

static

G711_64K_30_MILLISECONDS

G.711 capability with default parameters.

static

G723_6K_30_MILLISECONDS

G.723 capability with default parameters.

static

G729_30_MILLISECONDS

G.729 capability with default parameters.

static

GSM_80_MILLISECONDS

GSM capability with default parameters.

static

WIDEBAND_256K_10_MILLISECONDS

Wideband capability with default parameters.

int

getMaxFramesPerPacket(

Returns the packet size (in milliseconds) that this object specifies.The maxFramesPerPacket parameter is a carryover from the H.245 protocol definition.

Cisco Unified Communications Manager does not use this field as the number of frames per RTP packet, but rather as the number of milliseconds of audio per RTP packet that the device can receive.

Third-party IP phones may use different (higher) rates even though these rates may not be exceeded to and or from Cisco Unified IP phones.

int

getPayloadType()

Returns a payload type from the RTPPayload interface that this object specifies.

boolean

isSupported()

Returns whether the payload of this object is supported or not. True if the payloadType is supported, or otherwise false

java.lang.String

toString()

Overrides toString in class java.lang.Object.

static final int

NONE

Indicates that the CiscoMultiMediaCapabilityInfo.getVideoCapability () for this terminal is NONE.

static final int

VIDEO_ENABLED

CiscoMultiMediaCapabilityInfo.getVideoCapability () for this terminal is VIDEO_ENABLED.

static final int

TELEPRESENCEINTEROP_NONE

Indicates that the CiscoMultiMediaCapabilityInfo.getTelepresenceInfo() for this terminal is TELEPRESENCEINTEROP_NONE.

static final int

TELEPRESENCEINTEROP_ENABLED

CiscoMultiMediaCapabilityInfo. getTelepresenceInfo () for this terminal is TELEPRESENCEINTEROP_ENABLED

int

getVideoCapability()

Returns the video capability of the Terminal. The video capability can be NONE or VIDEO_ENABLED

int

getTelepresenceInfo()

Returns the telepresence capability of the Terminal. The telepresence capability can be TELEPRESENCEINTEROP_NONE or TELEPRESENCEINTEROP_ENABLED

int

getScreenCount()

Returns the number of screens present on the Terminal.

public

CiscoRegistrationException (java.lang.Stringdescription)

Takes the description of the exception as a parameter.

java.net.InetAddress

getRTPAddress()

Returns the Internet address for the inbound RTP stream of the associated call.

java.lang.String

getRTPAddressHostName()

Returns the IP host name for the inbound RTP stream of the associated call.

byte[]

getRTPByteAddress()

Returns the Internet address in byte format for the inbound RTP stream.

int

getRTPPort()

Returns the UDP port for the inbound RTP stream.

java.lang.String

toString()

Returns a String in the format "IP address/port number." Overrides toString in class java.lang.Object.

public

CiscoUnregistrationException ()(java.lang.Stringdescription)

None

public

CiscoWideBandMediaCapability(intpacketsize)

Constructs a CiscoWideBandMediaCapability object with the specified packet size. The default is ten–millisecond packet size.

Parameters

• packetsize—The RTP packet Framesize.

staticint

FRAMESIZE_TEN_MILLISECOND_PACKET

RTP Packet Framesize: Ten millisecond RTP packet

javax.telephony.Address

getAddress()

Returns the Address which is activated.

java.net.InetAddress

getCallingPartyIpAddr()

Returns the IP address of the calling party, or 0 (or null) if the IP Address is not available.

javax.telephony.Address

getAddress()

Returns the address that is marked unrestricted on the terminal.

javax.telephony.Terminal

getTerminal()

Returns the terminal on which the address got activated (i.e. marked unrestricted).

staticint

ID

javax.telephony.Address

getAddress()

Returns the address on which the new terminal is added.

javax.telephony.Terminal

getTerminal()

Returns the terminal that gets added to the Address.

static int

ID

int

getAutoAcceptStatus()

Returns the AutoAccept Status of the Address on the Terminal. Returns CiscoAddress.AUTOACCEPT_OFF or CiscoAddress.AUTOACCEPT_ON

CiscoTerminal

getTerminal()

Returns the Terminal at which the AutoAccept status for this address is changing.

ID

static final int ID

getAddress

javax.telephony.Address getAddress()

Returns the address which got added to the provider domain. Returns the address that is added to the provider domain.

Int

getTransactionID()

Returns the transaction ID for the session termination.

Address

getMonitorTargetAddress()

Returns the target address that was being monitored.

String

getMonitorTargetDevieName()

Returns the monitored device name.

Int

getMonitorTargetCalllegHandle()

Returns the call leg identifier for the monitored target.

String

getMonitorInitiatorDeviceName()

Returns the device name for the device that initiated the monitoring session.

Int

getCause()

Returns the reason that the monitoring session was terminated.

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

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.

public static final int

DEVICE_CONTROLLED_RECORDING

This value will be used to specify a new recording type. This type is used when the recording profile is configured on the device, and is thus "device controlled"

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

SELECTIVE_RECORDING

This constant is added to replace the deprecated constants APPLICTION_CONTROLLED_RECORDING and DEVICE_CONTROLLED_RECORDING

static int

UNKNOWN

This represents an address with an unknown name.

void

clearCallConnections ()

Use this interface to clear any phantom calls on the address.

Throws

javax. telephony. PrivilegeViolationException—Use this interface to clear any phantom calls on the address.

CiscoCall

createPersistentCall (Terminal terminal, String callerIDNumber, String callerIDName)

This interface creates a persistent call for this address and will return the call object for the newly created call. Note that CiscoProvider and the address must be in IN_SERVICE state, otherwise InvalidStateException will be thrown. This API cannot be invoked on external addresses. Doing so will result in MethodNotSupportedException to be thrown. If while trying to allocate a globalCallId for the persistent call and an error occurs, ResourceUnavailableException will be thrown. All other errors encountered will result in PlatformException to be thrown.

CiscoAddressCallInfo

getAddressCallInfo (javax. telephony. Terminal terminal)

Use this interface to get information about calls that are present at the Terminal.

String

getAsciiLabel (Terminal term)

This method returns the ASCII label configured for this address on Terminal term.

Throws InvalidStateException, MethodNotSupportedException, InValidParameterException.

int

getAutoAcceptStatus (javax. telephony. Terminal terminal)

Returns the AutoAccept status of the Address on the Terminal.

Throws

javax. telephony. PlatformException, javax. telephony. InvalidStateException, javax. telephony. MethodNotSupportedException

Returns the AutoAccept status of the Address on the Terminal. It may return one of the following constants:

• CiscoAddress. AUTOACCEPT_OFF
• CiscoAddress. AUTOACCEPT_ON

Pre-conditions

(this. getProvider ()). getState () = = Provider. IN_SERVICE

(getState () = = IN_SERVICE

Parameters

• terminal - The Terminal on which the AutoAccepts

int

getAutoAnswerStatus (javax. telephony. Terminal term)

This interface returns the AutoAnswer status of this Address on given Terminal.

Throws

javax. telephony. PlatformException, javax. telephony. InvalidStateException, javax. telephony. MethodNotSupportedException

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

(this. getProvider ()). getState () = = Provider. IN_SERVICE

(getState () = = IN_SERVICE

Parameters

• term - Terminal at which AutoAnswer is checked

Returns one of the following values:

• CiscoAddress. AUTOANSWER_OFF
• CiscoAddress. AUTOANSWER_WITHHEADSET
• CiscoAddress. AUTOANSWER_WITHSPEAKERSET
• CiscoAddress. AUTOANSWER_UNKNOWN

Throws

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

int

getBusyTrigger (Terminal term)

This method returns the busy trigger configured for this address on terminal term.

Throws InvalidStateException, InvalidArgumentException, MethodNotSupportedException.

int

getButtonPosition (Terminal term)

This method returns the button position of the address on terminal term.

Throws InvalidStateException, InvalidArgumentException, MethodNotSupportedException.

javax. telephony. Terminal[]

getInServiceAddrTerminals ()

Use this interface to find out which Shared Lines are in service. In Shared Lines, the same Address appears on different Terminals.

Returns: Terminal[]—An array of Terminals on which the Address is in service.

int

getMaxCalls (Terminal term)

This new method returns the maximum calls configured for an address on a terminal. This method throws InvalidStateException if the associated terminal is not registered to Cisco Unified Communication Manager. It throws InvalidArgumentException if terminal does not have this address. MethodNotSupportedException is be thrown if address is not in Provider

java. lang. String

getPartition ()

It returns the partition associated with an Address.

Connection

getPersistentConnection (Terminal terminal)

This interface will return the connection object that is associated with the persistent call. It returns null if there is no persistent call. This API cannot be invoked on external addresses. Doing so will result in MethodNotSupportedException to be thrown.

CiscoPickupGroup

getPickupGroup ()

This method returns a CiscoPickupGroup object that represents the Pickup Group DN and Partition that this Address belongs to.

int

getRecordingConfig (javax. telephony. Terminal term)

Returns the configured recording type on this Address.

Throws

javax. telephony. PlatformException, javax. telephony. InvalidStateException, javax. telephony. MethodNotSupportedException

Returns

• int—The configured recording type on this Address.
• CiscoAddess. NO_RECORDING —The call cannot be recorded.
• CiscoAddress. AUTO_RECORDING—Cisco Unified Communications Manager records all answered calls to/from this address.
• CiscoAddress. APPLICATION_CONTROLLED_RECORDING—Calls get recorded only when the application initiates recording.

Throws

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

int

getRegistrationState ()

Deprecated.

This method has been replaced by the getState () method. Returns the state of this address can be any of the following constants:

• CiscoAddress. OUT_OF_SERVICE
• CiscoAddress. IN_SERVICE

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.

Applications cannot see any call events for restricted Addresses. If a restricted Address is involved in a call with any other controlled Terminal, the system creates a Connection for the restricted Address, but there is not any TerminalConnection for the restricted Address.

Returns: Terminal[]—An array of Terminals on which this Address is restricted. If none is restricted, this method returns null.

int

getState ()

Returns the state of this address. The state may be any of the following constants:

• CiscoAddress. OUT_OF_SERVICE
• CiscoAddress. IN_SERVICE

int

getType ()

Returns the following address constants:

• CiscoAddress. INTERNAL
• CiscoAddress. EXTERNAL
• CiscoAddress. EXTERNAL_UNKNOWN
• CiscoAddress. UNKNOWN
• CiscoAddress. MONITORING_TARGET
• CiscoAddress. HUNT_PILOT, if address is in a CiscoHuntConnection.
• CiscoAddress. HUNT_PILOT, if address represents hunt pilot.

String

getUnicodeLabel (Terminal term)

This method returns the Unicode label configured for this address on Terminal term.

Throws InvalidStateException, MethodNotSupportedException, InValidParameterException.

int

getVoiceMailPilot ()

This method returns the voice mail pilot of the address.

Throws InvalidStateException, MethodNotSupportedException.

boolean

isRestricted (javax. telephony. Terminal terminal)

This method returns true if this Address on Terminal is restricted. ; false if not restricted.

void

setAutoAcceptStatus (int autoAcceptStatus, javax. telephony. Terminal terminal)

This method lets an application enable AutoAccept for this Address on CiscoMediaTerminal and/or CiscoRouteTerminal.

Addresses on CiscoTerminal other than CiscoMediaTerminal or CiscoRouteTerminal will always have AutoAccept on. If the Terminal passed in the parameter is not a CiscoMediaTerminal or CiscoRouteTerminal, this method throws an exception.

For a CiscoMediaTerminal that shares an Address with CiscoTerminal, Cisco recommends enabling AutoAccept on CiscoMediaTerminal.

Throws

javax. telephony. PlatformException, javax. telephony. InvalidStateException, javax. telephony. MethodNotSupportedException

Pre-conditions

(this. getProvider ()). getState () = = Provider. IN_SERVICE

(getState () = = IN_SERVICE

Post-conditions

Enables or Disables auto accept status

Parameters

• 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

Throws

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.

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. If enable is true, message-waiting gets activated if not already activated. If enable is false, message-waiting gets deactivated if not already deactivated.

Throws

javax. telephony. MethodNotSupportedException, javax. telephony. InvalidStateException, javax. telephony. PrivilegeViolationException

Pre-conditions

(this. getProvider ()). getState () = = Provider. IN_SERVICE

Post-conditions

Enables or disables the Message Waiting Indicator depending on the enable status.

CallCtlAddrMessageWaitingEv gets delivered for this Address.

Parameters

• destination - DN/Address message-waiting indicator is activated/deactivated
• enable - True to activate message-waiting, false to deactivate

Throws

• javax. telephony. MethodNotSupportedException—This method is not supported by the given implementation.

javax. telephony. InvalidStateException

javax. telephony. PrivilegeViolationException

void

setRingerStatus (int status)

Changes the ringer status on this address.

Throws

javax. telephony. MethodNotSupportedException, javax. telephony. InvalidStateException, javax. telephony. InvalidArgumentException

Accepts one of the following constants:

• CiscoAddress. RINGER_DEFAULT
• CiscoAddress. RINGER_DISABLE
• CiscoAddress. RINGER_ENABLE

void

setMessageSummary (boolean enable, boolean voiceCounts, int totalNewVoiceMsgs, int totalOldVoiceMsgs, boolean highPriorityVoiceCounts, int newHighPriorityVoiceMsgs, int oldHighPriorityVoiceMsgs, boolean faxCounts, int totalNewFaxMsgs, int totalOldFaxMsgs, boolean highPriorityFaxCounts, int newHighPriorityFaxMsgs, int oldHighPriorityFaxMsgs)

Use this interface to set the message-waiting indicator along with voice/fax message waiting counts 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

(this. getProvider ()). getState () = = Provider. IN_SERVICE

Post-conditions

Enables or disables the Message Waiting Indicator and sets message waiting counts.

Parameters

• enable - True to activate message-waiting, false to deactivate
• voiceCounts - indicates if voice message counts are provided
• totalNewVoiceMsgs - specifies the total number of new voice messages waiting
• totalOldVoiceMsgs - specifies the total number of old voice messages waiting
• highPriorityVoiceCounts - indicates if high priority voice message counts are provided
• newHighPriorityVoiceMsgs - specifies the number of new high priority voice messages waiting
• oldHighPriorityVoiceMsgs - specifies the number of old high priority voice messages waiting
• faxCounts - indicates if fax message counts are provided
• totalNewFaxMsgs - specifies the total number of new fax messages waiting
• totalOldFaxMsgs - specifies the total number of old fax messages waiting
• highPriorityFaxCounts - indicates if high priority fax message counts are provided
• newHighPriorityFaxMsgs - specifies the number of new high priority fax messages waiting
• oldHighPriorityFaxMsgs - specifies the number of old high priority fax messages waiting

Throws

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 set the message-waiting indicator or message counts for this destination.

void

setMessageSummary (java. lang. String destination, boolean enable, boolean voiceCounts, int totalNewVoiceMsgs, int totalOldVoiceMsgs, boolean highPriorityVoiceCounts, int newHighPriorityVoiceMsgs, int oldHighPriorityVoiceMsgs, boolean faxCounts, int totalNewFaxMsgs, int totalOldFaxMsgs, boolean highPriorityFaxCounts, int newHighPriorityFaxMsgs, int oldHighPriorityFaxMsgs)

Use this interface to set the message-waiting indicator along with voice/fax message waiting counts for the Address specified by the destination

Pre-conditions

(this. getProvider ()). getState () = = Provider. IN_SERVICE

Post-conditions

Enables or disables the Message Waiting Indicator and sets message waiting counts.

Parameters

• destination - DN/Address whose message-waiting indicator should be activated/deactivated
• enable - True to activate message-waiting, false to deactivate
• voiceCounts - indicates if voice message counts are provided
• totalNewVoiceMsgs - specifies the total number of new voice messages waiting
• totalOldVoiceMsgs - specifies the total number of old voice messages waiting
• highPriorityVoiceCounts - indicates if high priority voice message counts are provided
• newHighPriorityVoiceMsgs - specifies the number of new high priority voice messages waiting
• oldHighPriorityVoiceMsgs - specifies the number of old high priority voice messages waiting
• faxCounts - indicates if fax message counts are provided
• totalNewFaxMsgs - specifies the total number of new fax messages waiting
• totalOldFaxMsgs - specifies the total number of old fax messages waiting
• highPriorityFaxCounts - indicates if high priority fax message counts are provided
• newHighPriorityFaxMsgs - specifies the number of new high priority fax messages waiting
• oldHighPriorityFaxMsgs - specifies the number of old high priority fax messages waiting

boolean

getCiscoAddrParkStatusEvFilter ()

Application can invoke this API to know status of the filter for CiscoAddrParkStatusEv. Default value returned is false.

boolean

getCiscoAddrIntercomInfoChangedEvFilter ()

Application can invoke this API to know the stutus of the filter for CiscoAddrIntercomInfoChangedEv. Default value is true.

boolean

getCiscoAddrIntercomInfoRestorationFailedEvFilter ()

Application can invoke this API to know the status of the filter for CiscoAddrIntercomInfoRestorationFailedEv. Default value is true.

boolean

getCiscoAddrMonitorTerminatedEvFilter ()

Application can invoke this API to know the status of the filter for CiscoAddrMonitorTerminatedEv. Default value is true.

boolean

getCiscoAddrRecordingConfigChangedEvFilter ()

Application can invoke this API to get the status of the filter for the CiscoAddrRecordingConfigChangedEv. The default value is true.

boolean

getCiscoAddrVoiceMailPilotChangedEvFilter ()

This method returns true if voice mail pilot changed event filter is turned on else false.

void

setCiscoAddrIntercomInfoChangedEvFilter (boolean filter value)

Application can invoke this API to set the status of the filter for CiscoAddrIntercomInfoChangedEv.

void

setCiscoAddrIntercomInfoRestorationFailedEvFilter (boolean filter value)

Application can invoke this API to set the status of the filter for CiscoAddrIntercomInfoRestorationFailedEv.

void

setCiscoAddrMonitorTerminatedEvFilter (Boolean filterValue)

Parameter

Boolean

Void

setCiscoAddrParkStatusEvFilter (Boolean filterValue)

Application can invoke this API to set the status of the filter for CiscoAddrParkStatusEv.

void

setCiscoAddrRecordingConfigChangedEvFilter (boolean filter value)

Application can invoke this API to set the value of the filter for CiscoAddrRecordingConfigChangedEv.

void

setCiscoAddrVoiceMailPilotChangedEvFilter (boolean filterValue)

This method enables or disables the address voice mail changed event. When this filter is turned on CiscoAddrVoiceMailPilotChangedEv is delivered to address observer when voice mail configuration is changed.

Static int

ID

getTerminal

CiscoTerminal getTerminal()

Returns the Terminal at which this Address is going IN_SERVICE.

Static Int

ID

getIntercomAddress

getIntercomAddress()

Returns the intercom address for which the information changed.

Static int

ID

CiscoIntercomAddress

getIntercomAddress()

This interface returns the Cisco IntercomAddress for which intercom information restoration failed.

CiscoPickupGroup

getOldPickupGroup()

This method returns the old Pickup Group information for this event.

CiscoPickupGroup

getNewPickupGroup()

This method returns the new Pickup Group information for this event, what the pickup group has changed to.

Static int

ID

CiscoTerminal

getTerminal()

Returns the Terminal at which this Address is going OUT_OF_SERVICE.

static int

PARKED

Park status when the call is parked.

static int

REMINDER

Park status when the park monitoring reversion timer expires.

static int

RETRIEVED

Park status when the parked call is retrieved by the parker or a third party.

static int

FORWARDED

Park status when the parked call is forwarded when the park monitoring forward- no-retrieve timer expires.

static int

ABANDONED

Park status when the parked call is disconnected.

int

getParkState()

Returns the current park state of the parked call.

int

getTransactionID()

Returns an id which is unique for a particular parked call. Transaction ID would remain the same in the different park states for the same parked call.

CiscoCallID

getCiscoCallID()

Returns CiscoCallID.

String

getParkDN()

Returns the DN where call is parked.

String

getParkDNPartition()

Returns the partition of the Park DN.

String

getParkedParty()

Returns the DN of the parked party.

String

getParkedPartyPartition()

Returns the partition of the Parked party.

Terminal

getTerminal()

Returns the terminal on whose address this event is delivered.

static int

ID

Int

getRecordingConfig()

Returns the new recording configuration on this Address. The value is one of the following:

• CiscoAddress.NO_RECORDING
• CiscoAddress.AUTO_RECORDING
• CiscoAddress.APPLICATION_CONTROLLED_RECORDING

javax.telephony.Terminal

getTerminal()

Returns the Terminal on which the recording configuration changed.

static int

ID

javax.telephony.Address

getAddress()

Returns the Address that is removed from provider domain and the address which is removed from the user control list.

Static int

ID

javax.telephony.Address

getAddress()

Returns the Address from which the Terminal got removed.

javax.telephony.Terminal

getTerminal()

Returns the Terminal that got removed from the Address.

javax.telephony.Address

getAddress()

Returns the Address which is changed to Restricted on Cisco Unified Communications Manager.

Static int

ID

javax.telephony.Address

getAddress()

Returns the Address that is restricted.

javax.telephony.Terminal

getTerminal()

Returns the Terminal on which the Address is restricted.

String

getVoiceMailPilot()

This method returns the new voice mail pilot of the address.

Final static int

NO_MEDIA_REGISTRATION

Final static int

DYNAMIC_MEDIA_REGISTRATION

Final static int

DYNAMIC_MEDIA_REGISTRATION_FOR_GET_PORT_SUPPORT

Final static int

STATIC_MEDIA_REGISTRATION

Final static int

STATIC_MEDIA_REGISTRATION_FOR_GET_PORT SUPPORT

int

getRegistrationType()

void

register(java.net.InetAddress address, int port, CiscoMediaCapability[] capabilities, int registrationType), int[] algorithmIDs, java.net.InetAddress address_v6, int activeAddressingMode)

throws CiscoRegistrationException, PrivilegeViolationException;

static int

CALL_RECORDING_TYPE_APPLICATION_INITIATED_SILENT

This constant is used when silent is the recording invocation type. Silent recording is the default value in releases prior to Release 9.0.

static int

CALL_RECORDING_TYPE_AUTOMATIC

This constant is used when recording is invoked automatically by Unified CM, as a result of the line configuration.

static int

CALL_RECORDING_TYPE_NONE

This constant is used when a call is not recorded.

static int

CALL_RECORDING_TYPE_USER_INITIATED_FROM_APPLICATION

This constant is used when user is the recording invocation type, and the request was invoked by an application.

static int

CALL_RECORDING_TYPE_USER_INITIATED_FROM_DEVICE

This constant is used when recording was invoked on the Cisco IP device.

Static int

CALLSECURITY_AUTHENTICATED

Call security status is authenticated.

Static int

CALLSECURITY_ENCRYPTED

Call security status is encrypted.

Static int

CALLSECURITY_NOTAUTHENTICATED

Call security status is not authenticated.

Static int

CALLSECURITY_UNKNOWN

Call security status is unknown.

public static final int

CFWD_ALL_NONE

When call is not created due to CallFwdAll soft key press. Value is 0.

public static final int

CFWD_ALL_SET

When call is created due to CallFwdAll key press to set CFA. Value is 64.

public static final int

CFWD_ALL_CLEAR

When call is created to CallFwdAll key press to clear/cancel CFA. Value is 128.

Static int

FEATUREPRIORITY_EMERGENCY

Feature priority is emergency

Static int

FEATUREPRIORITY_NORMAL

Feature priority is normal

Static int

FEATUREPRIORITY_URGENT

Feature priority is urgent

int

getCFwdAllKeyPressIndicator()

This interface indicates if call is created due to callFWDAll Key press. It returns one of the following:

• CiscoCall.CFWD_ALL_NONE

• CiscoCall.CFWD_ALL_SET

• CiscoCall.CFWD_ALL_CLEAR

Static int