Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver
Interface TServerEvent

All Known Implementing Classes:
CommonProperties, EventAbandoned, EventACK, EventAddressInfo, EventAgentLogin, EventAgentLogout, EventAgentNotReady, EventAgentReady, EventAgentReserved, EventAnswerAccessNumber, EventAttachedDataChanged, EventBridged, EventCallCreated, EventCallDataChanged, EventCallDeleted, EventCallInfoChanged, EventCallPartyAdded, EventCallPartyDeleted, EventCallPartyMoved, EventCallPartyState, EventDestinationBusy, EventDialing, EventDigitsCollected, EventDiverted, EventDNBackInService, EventDNDOff, EventDNDOn, EventDNOutOfService, EventDtmfSent, EventError, EventEstablished, EventForwardCancel, EventForwardSet, EventHardwareError, EventHeld, EventLinkConnected, EventLinkDisconnected, EventListenDisconnected, EventListenReconnected, EventLocationInfo, EventMailBoxLogin, EventMailBoxLogout, EventMessageWaitingOff, EventMessageWaitingOn, EventMonitoringCancelled, EventMonitoringNextCall, EventMuteOff, EventMuteOn, EventNetworkCallStatus, EventNetworkPrivateInfo, EventNetworkReached, EventOffHook, EventOnHook, EventPartyAdded, EventPartyChanged, EventPartyDeleted, EventPartyInfo, EventPrimaryChanged, EventPrivateInfo, EventQueued, EventQueueLogout, EventRegistered, EventRegisteredAll, EventReleased, EventRemoteConnectionFailed, EventRemoteConnectionSuccess, EventReqGetAccessNumberCanceled, EventReserved_2, EventResourceInfo, EventRestoreConnection, EventRetrieved, EventRinging, EventRouteRequest, EventRouteUsed, EventServerInfo, EventSwitchInfo, EventTransactionStatus, EventTreatmentApplied, EventTreatmentEnd, EventTreatmentNotApplied, EventTreatmentRequired, EventUnregistered, EventUnregisteredAll, EventUserEvent, EventVoiceFileClosed, EventVoiceFileEndPlay, EventVoiceFileOpened

public interface TServerEvent


Method Summary
 java.lang.String getAccessNumber()
          A pointer to a number by dialing which a client application from the specified switch can reach a specific external routing point (This DN).
 java.lang.Integer getAddressInfoStatus()
          Information about the status of the telephony object in question.
 AddressInfoType getAddressInfoType()
          Information about the telephony object in question.
 AddressType getAddressType()
          Address type specifying the telephony object in question.
 java.lang.String getAgentID()
          The agent identifier specified by PBX or ACD.
 AgentWorkMode getAgentWorkMode()
          The Agent workmode.
 java.lang.String getANI()
          Automatic Number Identification.
 java.lang.String getApplicationName()
          The application name.
 CallHistoryInfo getCallHistory()
           
 java.lang.Integer getCallID()
          The call identifier provided by the switch (as opposed to connection identifier, or ConnID, which is assigned by T-Server).
 CallInfoType getCallInfoType()
          Type of the requested information.
 java.lang.Integer getCallState()
          Status of the current call.
 CallType getCallType()
          The type of call in question.
 java.lang.String getCallUuid()
          Call UUID.
 EventMask getCapabilities()
          Switch-specific mask specifying the set of requests and events that this T-Server can handle.
 Cause getCause()
          Cause of the transition to certain states, which clarifies the details of delivery failure.
 java.lang.Integer getClientID()
          Client identified for receipt of the data structure, including the reference ID, being sent.
 java.lang.String getCollectedDigits()
          The digits that have been collected from the caller.
 ConnectionId getConnID()
          Connection identifier of the current call handled by the DN.
 java.lang.String getCustomerID()
          The string containing the customer identifier through which processing of the call was initiated.
 java.lang.String getDNIS()
          The Directory Number Information Service.
 java.lang.Integer getErrorCode()
          The switch-specific numeric error code.
 java.lang.String getErrorMessage()
          ASCII text containing additional information about an error.
 java.lang.Long getEventSequenceNumber()
          int64 sequence number of event produced by t-server.
 KeyValueCollection getExtensions()
          An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
 java.lang.Integer getFileHandle()
          The handle of the voice file which is involved in this request or event.
 ConnectionId getFirstTransferConnID()
           
 ForwardMode getForwardMode()
          Mode of forwarding.
 java.lang.String getHomeLocation()
          A pointer to the name of the host where T-Server is running.
 java.lang.Integer getLastCollectedDigit()
          The last digit collected from the caller.
 ConnectionId getLastTransferConnID()
           
 CallType getLocalCallType()
           
 java.lang.String getLocation()
          Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
 LocationInfoType getLocationInfoType()
          Allows a client to receive information about one or more remote locations
 MakeCallType getMakeCallType()
          Refer to the type TMakeCallType.
 MediaType getMediaType()
          The Media Type
 MonitorNextCallType getMonitorNextCallType()
          Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..
 java.lang.Long getNetworkCallID()
          In case of network routing, the call identifier assigned by the switch where the call initially arrived
 NetworkCallState getNetworkCallState()
          The network state of the call controller.
 java.lang.String getNetworkDestDN()
          The intended destination of the NAT/C operation.
 NetworkDestState getNetworkDestState()
          The state of the destination party of the network call.
 java.lang.Integer getNetworkNodeID()
          In case of network routing, the identifier of the switch where the call initially arrived.
 java.lang.String getNetworkOrigDN()
          DN of the internal origination party in form of `location::DN`, only available for first-party operations (made on behalf of Agent 1), requested through Premise TServer
 NetworkPartyRole getNetworkPartyRole()
          On Premise TServer 1 (Site A): RoleNtwkOrigParty, On Premise TServer 2 (Site B): RoleNtwkDestParty, On Network TServer: not present.
 java.lang.String getNewCallUuid()
          New call UUUID.
 java.lang.String getOriginalCallUuid()
          Original call UUID.
 java.lang.String getOtherDN()
          The other main Directory Number (which your application did not register) involved in this request or event.
 DNRole getOtherDNRole()
          The role of the other DN involved in this request or event.
 java.lang.String getOtherQueue()
          The queue of the other DN involved in this request or event.
 java.lang.Integer getOtherTrunk()
          The otherDN's number of the line coming into the switch from the telephone provider.
 java.lang.String getPartyUuid()
          Party UUID.
 java.lang.String getPlace()
          The agent's place.
 ConnectionId getPreviousConnID()
          The previous connection identifier of the call this event relates to.
 java.lang.Integer getPrivateMsgID()
          Service identifier for the information being passed.
 CallType getPropagatedCallType()
           
 KeyValueCollection getReasons()
          Additional data intended to specify reasons for and results of actions taken by the user.
 java.lang.String getRefCallUuid()
          Ref call UUID.
 java.lang.Integer getReferenceID()
          Reference ID of the related request.
 ServerRole getRegistrationCode()
          The registration code
 Reliability getReliability()
           
 java.lang.String getRemoteDN()
          The remote DN.
 RouteType getRouteType()
          The type of routing applied to this call.
 ServerRole getServerRole()
          The role of T-Server.
 java.lang.Long getServerStartTime()
          int64 timestamp as defined in call monitoring events.
 java.lang.String getServerVersion()
          The release number of T-Server.
 java.lang.String getServerXCapabilities()
          T-Server eXtended capabilities.
 java.lang.Integer getSessionID()
          A unique session identifier generated by T-Server.
 java.lang.String getSubscriptionID()
           
 java.lang.String getThirdPartyDN()
          The third party's DN, involved in the call.
 DNRole getThirdPartyDNRole()
          The role of the third party DN involved in this request or event.
 java.lang.String getThirdPartyQueue()
          The queue related to the DN ThirdPartyDN.
 java.lang.Integer getThirdPartyTrunk()
          The ThirdParty's number of the line coming into the switch from the telephone provider.
 java.lang.String getThisDN()
          The Directory Number (which your application registered) involved in this request or event.
 DNRole getThisDNRole()
          Role of the DN ThisDN.
 java.lang.String getThisQueue()
          The queue related to ThisDN
 java.lang.Integer getThisTrunk()
          Number of the line coming into the switch from the telephone provider.
 TimeStamp getTime()
           
 java.lang.Integer getTimeout()
          Time interval, in seconds.
 ConnectionId getTransferConnID()
          Connection identifier of the transfer's consultation call.
 java.lang.Integer getTransferredNetworkCallID()
          Transferred Network CallID.
 java.lang.Integer getTransferredNetworkNodeID()
          Transferred Network NodeID.
 KeyValueCollection getTreatmentParameters()
          The additional parameters associated with the treatment type.
 TreatmentType getTreatmentType()
          The type of the treatment applied to the telephony object in question.
 KeyValueCollection getUserData()
          Call-related user data.
 java.lang.Integer getUserEvent()
          The user's event.
 java.lang.Integer getXReferenceID()
          The reference number of a TGetAccessNumber function that is called by an application.
 void setAccessNumber(java.lang.String accessNumber)
          A pointer to a number by dialing which a client application from the specified switch can reach a specific external routing point (This DN).
 void setAddressInfoStatus(int addressInfoStatus)
          Information about the status of the telephony object in question.
 void setAddressInfoStatus(java.lang.Integer addressInfoStatus)
          Information about the status of the telephony object in question.
 void setAddressInfoType(AddressInfoType addressInfoType)
          Information about the telephony object in question.
 void setAddressType(AddressType addressType)
          Address type specifying the telephony object in question.
 void setAgentID(java.lang.String agentID)
          The agent identifier specified by PBX or ACD.
 void setAgentWorkMode(AgentWorkMode agentWorkMode)
          The Agent workmode.
 void setANI(java.lang.String aNI)
          Automatic Number Identification.
 void setApplicationName(java.lang.String applicationName)
          The application name.
 void setCallHistory(CallHistoryInfo callHistory)
           
 void setCallID(int callID)
          The call identifier provided by the switch (as opposed to connection identifier, or ConnID, which is assigned by T-Server).
 void setCallID(java.lang.Integer callID)
          The call identifier provided by the switch (as opposed to connection identifier, or ConnID, which is assigned by T-Server).
 void setCallInfoType(CallInfoType callInfoType)
          Type of the requested information.
 void setCallState(int callState)
          Status of the current call.
 void setCallState(java.lang.Integer callState)
          Status of the current call.
 void setCallType(CallType callType)
          The type of call in question.
 void setCallUuid(java.lang.String callUuid)
          Call UUID.
 void setCapabilities(EventMask capabilities)
          Switch-specific mask specifying the set of requests and events that this T-Server can handle.
 void setCause(Cause cause)
          Cause of the transition to certain states, which clarifies the details of delivery failure.
 void setClientID(int clientID)
          Client identified for receipt of the data structure, including the reference ID, being sent.
 void setClientID(java.lang.Integer clientID)
          Client identified for receipt of the data structure, including the reference ID, being sent.
 void setCollectedDigits(java.lang.String collectedDigits)
          The digits that have been collected from the caller.
 void setConnID(ConnectionId connID)
          Connection identifier of the current call handled by the DN.
 void setCustomerID(java.lang.String customerID)
          The string containing the customer identifier through which processing of the call was initiated.
 void setDNIS(java.lang.String dNIS)
          The Directory Number Information Service.
 void setErrorCode(int errorCode)
          The switch-specific numeric error code.
 void setErrorCode(java.lang.Integer errorCode)
          The switch-specific numeric error code.
 void setErrorMessage(java.lang.String errorMessage)
          ASCII text containing additional information about an error.
 void setEventSequenceNumber(long eventSequenceNumber)
          int64 sequence number of event produced by t-server.
 void setEventSequenceNumber(java.lang.Long eventSequenceNumber)
          int64 sequence number of event produced by t-server.
 void setExtensions(KeyValueCollection extensions)
          An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
 void setFileHandle(int fileHandle)
          The handle of the voice file which is involved in this request or event.
 void setFileHandle(java.lang.Integer fileHandle)
          The handle of the voice file which is involved in this request or event.
 void setFirstTransferConnID(ConnectionId firstTransferConnID)
           
 void setForwardMode(ForwardMode forwardMode)
          Mode of forwarding.
 void setHomeLocation(java.lang.String homeLocation)
          A pointer to the name of the host where T-Server is running.
 void setLastCollectedDigit(int lastCollectedDigit)
          The last digit collected from the caller.
 void setLastCollectedDigit(java.lang.Integer lastCollectedDigit)
          The last digit collected from the caller.
 void setLastTransferConnID(ConnectionId lastTransferConnID)
           
 void setLocalCallType(CallType localCallType)
           
 void setLocation(java.lang.String location)
          Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.
 void setLocationInfoType(LocationInfoType locationInfoType)
          Allows a client to receive information about one or more remote locations
 void setMakeCallType(MakeCallType makeCallType)
          Refer to the type TMakeCallType.
 void setMediaType(MediaType mediaType)
          The Media Type
 void setMonitorNextCallType(MonitorNextCallType monitorNextCallType)
          Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..
 void setNetworkCallID(long networkCallID)
          In case of network routing, the call identifier assigned by the switch where the call initially arrived
 void setNetworkCallID(java.lang.Long networkCallID)
          In case of network routing, the call identifier assigned by the switch where the call initially arrived
 void setNetworkCallState(NetworkCallState networkCallState)
          The network state of the call controller.
 void setNetworkDestDN(java.lang.String networkDestDN)
          The intended destination of the NAT/C operation.
 void setNetworkDestState(NetworkDestState networkDestState)
          The state of the destination party of the network call.
 void setNetworkNodeID(int networkNodeID)
          In case of network routing, the identifier of the switch where the call initially arrived.
 void setNetworkNodeID(java.lang.Integer networkNodeID)
          In case of network routing, the identifier of the switch where the call initially arrived.
 void setNetworkOrigDN(java.lang.String networkOrigDN)
          DN of the internal origination party in form of `location::DN`, only available for first-party operations (made on behalf of Agent 1), requested through Premise TServer
 void setNetworkPartyRole(NetworkPartyRole networkPartyRole)
          On Premise TServer 1 (Site A): RoleNtwkOrigParty, On Premise TServer 2 (Site B): RoleNtwkDestParty, On Network TServer: not present.
 void setNewCallUuid(java.lang.String newCallUuid)
          New call UUUID.
 void setOriginalCallUuid(java.lang.String originalCallUuid)
          Original call UUID.
 void setOtherDN(java.lang.String otherDN)
          The other main Directory Number (which your application did not register) involved in this request or event.
 void setOtherDNRole(DNRole otherDNRole)
          The role of the other DN involved in this request or event.
 void setOtherQueue(java.lang.String otherQueue)
          The queue of the other DN involved in this request or event.
 void setOtherTrunk(int otherTrunk)
          The otherDN's number of the line coming into the switch from the telephone provider.
 void setOtherTrunk(java.lang.Integer otherTrunk)
          The otherDN's number of the line coming into the switch from the telephone provider.
 void setPartyUuid(java.lang.String partyUuid)
          Party UUID.
 void setPlace(java.lang.String place)
          The agent's place.
 void setPreviousConnID(ConnectionId previousConnID)
          The previous connection identifier of the call this event relates to.
 void setPrivateMsgID(int privateMsgID)
          Service identifier for the information being passed.
 void setPrivateMsgID(java.lang.Integer privateMsgID)
          Service identifier for the information being passed.
 void setPropagatedCallType(CallType propagatedCallType)
           
 void setReasons(KeyValueCollection reasons)
          Additional data intended to specify reasons for and results of actions taken by the user.
 void setRefCallUuid(java.lang.String refCallUuid)
          Ref call UUID.
 void setReferenceID(int referenceID)
          Reference ID of the related request.
 void setReferenceID(java.lang.Integer referenceID)
          Reference ID of the related request.
 void setRegistrationCode(ServerRole registrationCode)
          The registration code
 void setReliability(Reliability reliability)
           
 void setRemoteDN(java.lang.String remoteDN)
          The remote DN.
 void setRouteType(RouteType routeType)
          The type of routing applied to this call.
 void setServerRole(ServerRole serverRole)
          The role of T-Server.
 void setServerStartTime(long serverStartTime)
          int64 timestamp as defined in call monitoring events.
 void setServerStartTime(java.lang.Long serverStartTime)
          int64 timestamp as defined in call monitoring events.
 void setServerVersion(java.lang.String serverVersion)
          The release number of T-Server.
 void setServerXCapabilities(java.lang.String serverXCapabilities)
          T-Server eXtended capabilities.
 void setSessionID(int sessionID)
          A unique session identifier generated by T-Server.
 void setSessionID(java.lang.Integer sessionID)
          A unique session identifier generated by T-Server.
 void setSubscriptionID(java.lang.String subscriptionID)
           
 void setThirdPartyDN(java.lang.String thirdPartyDN)
          The third party's DN, involved in the call.
 void setThirdPartyDNRole(DNRole thirdPartyDNRole)
          The role of the third party DN involved in this request or event.
 void setThirdPartyQueue(java.lang.String thirdPartyQueue)
          The queue related to the DN ThirdPartyDN.
 void setThirdPartyTrunk(int thirdPartyTrunk)
          The ThirdParty's number of the line coming into the switch from the telephone provider.
 void setThirdPartyTrunk(java.lang.Integer thirdPartyTrunk)
          The ThirdParty's number of the line coming into the switch from the telephone provider.
 void setThisDN(java.lang.String thisDN)
          The Directory Number (which your application registered) involved in this request or event.
 void setThisDNRole(DNRole thisDNRole)
          Role of the DN ThisDN.
 void setThisQueue(java.lang.String thisQueue)
          The queue related to ThisDN
 void setThisTrunk(int thisTrunk)
          Number of the line coming into the switch from the telephone provider.
 void setThisTrunk(java.lang.Integer thisTrunk)
          Number of the line coming into the switch from the telephone provider.
 void setTime(TimeStamp time)
           
 void setTimeout(int timeout)
          Time interval, in seconds.
 void setTimeout(java.lang.Integer timeout)
          Time interval, in seconds.
 void setTransferConnID(ConnectionId transferConnID)
          Connection identifier of the transfer's consultation call.
 void setTransferredNetworkCallID(int transferredNetworkCallID)
          Transferred Network CallID.
 void setTransferredNetworkCallID(java.lang.Integer transferredNetworkCallID)
          Transferred Network CallID.
 void setTransferredNetworkNodeID(int transferredNetworkNodeID)
          Transferred Network NodeID.
 void setTransferredNetworkNodeID(java.lang.Integer transferredNetworkNodeID)
          Transferred Network NodeID.
 void setTreatmentParameters(KeyValueCollection treatmentParameters)
          The additional parameters associated with the treatment type.
 void setTreatmentType(TreatmentType treatmentType)
          The type of the treatment applied to the telephony object in question.
 void setUserData(KeyValueCollection userData)
          Call-related user data.
 void setUserEvent(int userEvent)
          The user's event.
 void setUserEvent(java.lang.Integer userEvent)
          The user's event.
 void setXReferenceID(int xReferenceID)
          The reference number of a TGetAccessNumber function that is called by an application.
 void setXReferenceID(java.lang.Integer xReferenceID)
          The reference number of a TGetAccessNumber function that is called by an application.
 

Method Detail

getAccessNumber

java.lang.String getAccessNumber()
A pointer to a number by dialing which a client application from the specified switch can reach a specific external routing point (This DN).

Returns:
property value

setAccessNumber

void setAccessNumber(java.lang.String accessNumber)
A pointer to a number by dialing which a client application from the specified switch can reach a specific external routing point (This DN).

Parameters:
accessNumber - new value of the property

getAddressInfoStatus

java.lang.Integer getAddressInfoStatus()
Information about the status of the telephony object in question. Actually this value can be cast to AddressStatusInfoType enum.

Returns:
property value

setAddressInfoStatus

void setAddressInfoStatus(java.lang.Integer addressInfoStatus)
Information about the status of the telephony object in question. Actually this value can be cast to AddressStatusInfoType enum.

Parameters:
addressInfoStatus - new value of the property

setAddressInfoStatus

void setAddressInfoStatus(int addressInfoStatus)
Information about the status of the telephony object in question. Actually this value can be cast to AddressStatusInfoType enum.

Parameters:
addressInfoStatus - new value of the property

getAddressInfoType

AddressInfoType getAddressInfoType()
Information about the telephony object in question.

Returns:
property value

setAddressInfoType

void setAddressInfoType(AddressInfoType addressInfoType)
Information about the telephony object in question.

Parameters:
addressInfoType - new value of the property

getAddressType

AddressType getAddressType()
Address type specifying the telephony object in question.

Returns:
property value

setAddressType

void setAddressType(AddressType addressType)
Address type specifying the telephony object in question.

Parameters:
addressType - new value of the property

getAgentID

java.lang.String getAgentID()
The agent identifier specified by PBX or ACD.

Returns:
property value

setAgentID

void setAgentID(java.lang.String agentID)
The agent identifier specified by PBX or ACD.

Parameters:
agentID - new value of the property

getAgentWorkMode

AgentWorkMode getAgentWorkMode()
The Agent workmode. See Genesyslab.Platform.Voice.Protocols.TServer.CallState.AgentWorkMode.


setAgentWorkMode

void setAgentWorkMode(AgentWorkMode agentWorkMode)
The Agent workmode. See Genesyslab.Platform.Voice.Protocols.TServer.CallState.AgentWorkMode.


getANI

java.lang.String getANI()
Automatic Number Identification. Specifies from which number the current inbound call originates.


setANI

void setANI(java.lang.String aNI)
Automatic Number Identification. Specifies from which number the current inbound call originates.


getApplicationName

java.lang.String getApplicationName()
The application name.

Returns:
property value

setApplicationName

void setApplicationName(java.lang.String applicationName)
The application name.

Parameters:
applicationName - new value of the property

getCallID

java.lang.Integer getCallID()
The call identifier provided by the switch (as opposed to connection identifier, or ConnID, which is assigned by T-Server).

Returns:
property value

setCallID

void setCallID(java.lang.Integer callID)
The call identifier provided by the switch (as opposed to connection identifier, or ConnID, which is assigned by T-Server).

Parameters:
callID - new value of the property

setCallID

void setCallID(int callID)
The call identifier provided by the switch (as opposed to connection identifier, or ConnID, which is assigned by T-Server).

Parameters:
callID - new value of the property

getCallInfoType

CallInfoType getCallInfoType()
Type of the requested information.

Returns:
property value

setCallInfoType

void setCallInfoType(CallInfoType callInfoType)
Type of the requested information.

Parameters:
callInfoType - new value of the property

getCallState

java.lang.Integer getCallState()
Status of the current call. See the Genesyslab.Platform.Voice.Protocols.TServer.CallState enumeration.


setCallState

void setCallState(java.lang.Integer callState)
Status of the current call. See the Genesyslab.Platform.Voice.Protocols.TServer.CallState enumeration.


setCallState

void setCallState(int callState)
Status of the current call. See the Genesyslab.Platform.Voice.Protocols.TServer.CallState enumeration.


getCallType

CallType getCallType()
The type of call in question.

Returns:
property value

setCallType

void setCallType(CallType callType)
The type of call in question.

Parameters:
callType - new value of the property

getCapabilities

EventMask getCapabilities()
Switch-specific mask specifying the set of requests and events that this T-Server can handle.

Returns:
property value

setCapabilities

void setCapabilities(EventMask capabilities)
Switch-specific mask specifying the set of requests and events that this T-Server can handle.

Parameters:
capabilities - new value of the property

getCause

Cause getCause()
Cause of the transition to certain states, which clarifies the details of delivery failure.

Returns:
property value

setCause

void setCause(Cause cause)
Cause of the transition to certain states, which clarifies the details of delivery failure.

Parameters:
cause - new value of the property

getClientID

java.lang.Integer getClientID()
Client identified for receipt of the data structure, including the reference ID, being sent.

Returns:
property value

setClientID

void setClientID(java.lang.Integer clientID)
Client identified for receipt of the data structure, including the reference ID, being sent.

Parameters:
clientID - new value of the property

setClientID

void setClientID(int clientID)
Client identified for receipt of the data structure, including the reference ID, being sent.

Parameters:
clientID - new value of the property

getCollectedDigits

java.lang.String getCollectedDigits()
The digits that have been collected from the caller.

Returns:
property value

setCollectedDigits

void setCollectedDigits(java.lang.String collectedDigits)
The digits that have been collected from the caller.

Parameters:
collectedDigits - new value of the property

getConnID

ConnectionId getConnID()
Connection identifier of the current call handled by the DN.


setConnID

void setConnID(ConnectionId connID)
Connection identifier of the current call handled by the DN.


getCustomerID

java.lang.String getCustomerID()
The string containing the customer identifier through which processing of the call was initiated.

Returns:
property value

setCustomerID

void setCustomerID(java.lang.String customerID)
The string containing the customer identifier through which processing of the call was initiated.

Parameters:
customerID - new value of the property

getDNIS

java.lang.String getDNIS()
The Directory Number Information Service. Specifies to which DN the current inbound call was made.


setDNIS

void setDNIS(java.lang.String dNIS)
The Directory Number Information Service. Specifies to which DN the current inbound call was made.


getErrorCode

java.lang.Integer getErrorCode()
The switch-specific numeric error code.

Returns:
property value

setErrorCode

void setErrorCode(java.lang.Integer errorCode)
The switch-specific numeric error code.

Parameters:
errorCode - new value of the property

setErrorCode

void setErrorCode(int errorCode)
The switch-specific numeric error code.

Parameters:
errorCode - new value of the property

getErrorMessage

java.lang.String getErrorMessage()
ASCII text containing additional information about an error.

Returns:
property value

setErrorMessage

void setErrorMessage(java.lang.String errorMessage)
ASCII text containing additional information about an error.

Parameters:
errorMessage - new value of the property

getExtensions

KeyValueCollection getExtensions()
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.

Returns:
property value

setExtensions

void setExtensions(KeyValueCollection extensions)
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.

Parameters:
extensions - new value of the property

getFileHandle

java.lang.Integer getFileHandle()
The handle of the voice file which is involved in this request or event.


setFileHandle

void setFileHandle(java.lang.Integer fileHandle)
The handle of the voice file which is involved in this request or event.


setFileHandle

void setFileHandle(int fileHandle)
The handle of the voice file which is involved in this request or event.


getFirstTransferConnID

ConnectionId getFirstTransferConnID()

setFirstTransferConnID

void setFirstTransferConnID(ConnectionId firstTransferConnID)

getForwardMode

ForwardMode getForwardMode()
Mode of forwarding.

Returns:
property value

setForwardMode

void setForwardMode(ForwardMode forwardMode)
Mode of forwarding.

Parameters:
forwardMode - new value of the property

getHomeLocation

java.lang.String getHomeLocation()
A pointer to the name of the host where T-Server is running.

Returns:
property value

setHomeLocation

void setHomeLocation(java.lang.String homeLocation)
A pointer to the name of the host where T-Server is running.

Parameters:
homeLocation - new value of the property

getLastCollectedDigit

java.lang.Integer getLastCollectedDigit()
The last digit collected from the caller.

Returns:
property value

setLastCollectedDigit

void setLastCollectedDigit(java.lang.Integer lastCollectedDigit)
The last digit collected from the caller.

Parameters:
lastCollectedDigit - new value of the property

setLastCollectedDigit

void setLastCollectedDigit(int lastCollectedDigit)
The last digit collected from the caller.

Parameters:
lastCollectedDigit - new value of the property

getLastTransferConnID

ConnectionId getLastTransferConnID()

setLastTransferConnID

void setLastTransferConnID(ConnectionId lastTransferConnID)

getLocation

java.lang.String getLocation()
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Returns:
property value

setLocation

void setLocation(java.lang.String location)
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.

Parameters:
location - new value of the property

getLocationInfoType

LocationInfoType getLocationInfoType()
Allows a client to receive information about one or more remote locations

Returns:
property value

setLocationInfoType

void setLocationInfoType(LocationInfoType locationInfoType)
Allows a client to receive information about one or more remote locations

Parameters:
locationInfoType - new value of the property

getMakeCallType

MakeCallType getMakeCallType()
Refer to the type TMakeCallType.

Returns:
property value

setMakeCallType

void setMakeCallType(MakeCallType makeCallType)
Refer to the type TMakeCallType.

Parameters:
makeCallType - new value of the property

getMonitorNextCallType

MonitorNextCallType getMonitorNextCallType()
Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..

Returns:
property value

setMonitorNextCallType

void setMonitorNextCallType(MonitorNextCallType monitorNextCallType)
Supervisor will monitor one call to the agent or Supervisor will monitor all subsequent calls to the agent until monitoring is canceled..

Parameters:
monitorNextCallType - new value of the property

getNetworkCallID

java.lang.Long getNetworkCallID()
In case of network routing, the call identifier assigned by the switch where the call initially arrived

Returns:
property value

setNetworkCallID

void setNetworkCallID(java.lang.Long networkCallID)
In case of network routing, the call identifier assigned by the switch where the call initially arrived

Parameters:
networkCallID - new value of the property

setNetworkCallID

void setNetworkCallID(long networkCallID)
In case of network routing, the call identifier assigned by the switch where the call initially arrived

Parameters:
networkCallID - new value of the property

getNetworkCallState

NetworkCallState getNetworkCallState()
The network state of the call controller.

Returns:
property value

setNetworkCallState

void setNetworkCallState(NetworkCallState networkCallState)
The network state of the call controller.

Parameters:
networkCallState - new value of the property

getNetworkDestDN

java.lang.String getNetworkDestDN()
The intended destination of the NAT/C operation.

Returns:
property value

setNetworkDestDN

void setNetworkDestDN(java.lang.String networkDestDN)
The intended destination of the NAT/C operation.

Parameters:
networkDestDN - new value of the property

getNetworkDestState

NetworkDestState getNetworkDestState()
The state of the destination party of the network call.

Returns:
property value

setNetworkDestState

void setNetworkDestState(NetworkDestState networkDestState)
The state of the destination party of the network call.

Parameters:
networkDestState - new value of the property

getNetworkNodeID

java.lang.Integer getNetworkNodeID()
In case of network routing, the identifier of the switch where the call initially arrived.

Returns:
property value

setNetworkNodeID

void setNetworkNodeID(java.lang.Integer networkNodeID)
In case of network routing, the identifier of the switch where the call initially arrived.

Parameters:
networkNodeID - new value of the property

setNetworkNodeID

void setNetworkNodeID(int networkNodeID)
In case of network routing, the identifier of the switch where the call initially arrived.

Parameters:
networkNodeID - new value of the property

getNetworkOrigDN

java.lang.String getNetworkOrigDN()
DN of the internal origination party in form of `location::DN`, only available for first-party operations (made on behalf of Agent 1), requested through Premise TServer

Returns:
property value

setNetworkOrigDN

void setNetworkOrigDN(java.lang.String networkOrigDN)
DN of the internal origination party in form of `location::DN`, only available for first-party operations (made on behalf of Agent 1), requested through Premise TServer

Parameters:
networkOrigDN - new value of the property

getNetworkPartyRole

NetworkPartyRole getNetworkPartyRole()
On Premise TServer 1 (Site A): RoleNtwkOrigParty, On Premise TServer 2 (Site B): RoleNtwkDestParty, On Network TServer: not present.

Returns:
property value

setNetworkPartyRole

void setNetworkPartyRole(NetworkPartyRole networkPartyRole)
On Premise TServer 1 (Site A): RoleNtwkOrigParty, On Premise TServer 2 (Site B): RoleNtwkDestParty, On Network TServer: not present.

Parameters:
networkPartyRole - new value of the property

getOtherDN

java.lang.String getOtherDN()
The other main Directory Number (which your application did not register) involved in this request or event. For instance, the DN of the main party of the call.


setOtherDN

void setOtherDN(java.lang.String otherDN)
The other main Directory Number (which your application did not register) involved in this request or event. For instance, the DN of the main party of the call.


getOtherDNRole

DNRole getOtherDNRole()
The role of the other DN involved in this request or event. (See the property otherDN).


setOtherDNRole

void setOtherDNRole(DNRole otherDNRole)
The role of the other DN involved in this request or event. (See the property otherDN).


getOtherQueue

java.lang.String getOtherQueue()
The queue of the other DN involved in this request or event. (See the property otherDN).


setOtherQueue

void setOtherQueue(java.lang.String otherQueue)
The queue of the other DN involved in this request or event. (See the property otherDN).


getOtherTrunk

java.lang.Integer getOtherTrunk()
The otherDN's number of the line coming into the switch from the telephone provider.


setOtherTrunk

void setOtherTrunk(java.lang.Integer otherTrunk)
The otherDN's number of the line coming into the switch from the telephone provider.


setOtherTrunk

void setOtherTrunk(int otherTrunk)
The otherDN's number of the line coming into the switch from the telephone provider.


getPlace

java.lang.String getPlace()
The agent's place.

Returns:
property value

setPlace

void setPlace(java.lang.String place)
The agent's place.

Parameters:
place - new value of the property

getPreviousConnID

ConnectionId getPreviousConnID()
The previous connection identifier of the call this event relates to.

Returns:
property value

setPreviousConnID

void setPreviousConnID(ConnectionId previousConnID)
The previous connection identifier of the call this event relates to.

Parameters:
previousConnID - new value of the property

getPrivateMsgID

java.lang.Integer getPrivateMsgID()
Service identifier for the information being passed.

Returns:
property value

setPrivateMsgID

void setPrivateMsgID(java.lang.Integer privateMsgID)
Service identifier for the information being passed.

Parameters:
privateMsgID - new value of the property

setPrivateMsgID

void setPrivateMsgID(int privateMsgID)
Service identifier for the information being passed.

Parameters:
privateMsgID - new value of the property

getReasons

KeyValueCollection getReasons()
Additional data intended to specify reasons for and results of actions taken by the user.

Returns:
property value

setReasons

void setReasons(KeyValueCollection reasons)
Additional data intended to specify reasons for and results of actions taken by the user.

Parameters:
reasons - new value of the property

getRemoteDN

java.lang.String getRemoteDN()
The remote DN.

Returns:
property value

setRemoteDN

void setRemoteDN(java.lang.String remoteDN)
The remote DN.

Parameters:
remoteDN - new value of the property

getReferenceID

java.lang.Integer getReferenceID()
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

void setReferenceID(java.lang.Integer referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

void setReferenceID(int referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


getRegistrationCode

ServerRole getRegistrationCode()
The registration code

Returns:
property value

setRegistrationCode

void setRegistrationCode(ServerRole registrationCode)
The registration code

Parameters:
registrationCode - new value of the property

getRouteType

RouteType getRouteType()
The type of routing applied to this call.

Returns:
property value

setRouteType

void setRouteType(RouteType routeType)
The type of routing applied to this call.

Parameters:
routeType - new value of the property

getServerRole

ServerRole getServerRole()
The role of T-Server.

Returns:
property value

setServerRole

void setServerRole(ServerRole serverRole)
The role of T-Server.

Parameters:
serverRole - new value of the property

getServerVersion

java.lang.String getServerVersion()
The release number of T-Server.

Returns:
property value

setServerVersion

void setServerVersion(java.lang.String serverVersion)
The release number of T-Server.

Parameters:
serverVersion - new value of the property

getServerXCapabilities

java.lang.String getServerXCapabilities()
T-Server eXtended capabilities.

Returns:
property value

setServerXCapabilities

void setServerXCapabilities(java.lang.String serverXCapabilities)
T-Server eXtended capabilities.

Parameters:
serverXCapabilities - new value of the property

getSessionID

java.lang.Integer getSessionID()
A unique session identifier generated by T-Server.

Returns:
property value

setSessionID

void setSessionID(java.lang.Integer sessionID)
A unique session identifier generated by T-Server.

Parameters:
sessionID - new value of the property

setSessionID

void setSessionID(int sessionID)
A unique session identifier generated by T-Server.

Parameters:
sessionID - new value of the property

getThirdPartyDN

java.lang.String getThirdPartyDN()
The third party's DN, involved in the call.


setThirdPartyDN

void setThirdPartyDN(java.lang.String thirdPartyDN)
The third party's DN, involved in the call.


getThirdPartyDNRole

DNRole getThirdPartyDNRole()
The role of the third party DN involved in this request or event. (See the property ThirdParty).


setThirdPartyDNRole

void setThirdPartyDNRole(DNRole thirdPartyDNRole)
The role of the third party DN involved in this request or event. (See the property ThirdParty).


getThirdPartyQueue

java.lang.String getThirdPartyQueue()
The queue related to the DN ThirdPartyDN.


setThirdPartyQueue

void setThirdPartyQueue(java.lang.String thirdPartyQueue)
The queue related to the DN ThirdPartyDN.


getThirdPartyTrunk

java.lang.Integer getThirdPartyTrunk()
The ThirdParty's number of the line coming into the switch from the telephone provider.


setThirdPartyTrunk

void setThirdPartyTrunk(java.lang.Integer thirdPartyTrunk)
The ThirdParty's number of the line coming into the switch from the telephone provider.


setThirdPartyTrunk

void setThirdPartyTrunk(int thirdPartyTrunk)
The ThirdParty's number of the line coming into the switch from the telephone provider.


getThisDN

java.lang.String getThisDN()
The Directory Number (which your application registered) involved in this request or event.


setThisDN

void setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event.


getThisDNRole

DNRole getThisDNRole()
Role of the DN ThisDN.


setThisDNRole

void setThisDNRole(DNRole thisDNRole)
Role of the DN ThisDN.


getThisQueue

java.lang.String getThisQueue()
The queue related to ThisDN

Returns:
property value

setThisQueue

void setThisQueue(java.lang.String thisQueue)
The queue related to ThisDN

Parameters:
thisQueue - new value of the property

getThisTrunk

java.lang.Integer getThisTrunk()
Number of the line coming into the switch from the telephone provider.


setThisTrunk

void setThisTrunk(java.lang.Integer thisTrunk)
Number of the line coming into the switch from the telephone provider.


setThisTrunk

void setThisTrunk(int thisTrunk)
Number of the line coming into the switch from the telephone provider.


getTimeout

java.lang.Integer getTimeout()
Time interval, in seconds.

Returns:
property value

setTimeout

void setTimeout(java.lang.Integer timeout)
Time interval, in seconds.

Parameters:
timeout - new value of the property

setTimeout

void setTimeout(int timeout)
Time interval, in seconds.

Parameters:
timeout - new value of the property

getTransferConnID

ConnectionId getTransferConnID()
Connection identifier of the transfer's consultation call.


setTransferConnID

void setTransferConnID(ConnectionId transferConnID)
Connection identifier of the transfer's consultation call.


getTransferredNetworkCallID

java.lang.Integer getTransferredNetworkCallID()
Transferred Network CallID.

Returns:
property value

setTransferredNetworkCallID

void setTransferredNetworkCallID(java.lang.Integer transferredNetworkCallID)
Transferred Network CallID.

Parameters:
transferredNetworkCallID - new value of the property

setTransferredNetworkCallID

void setTransferredNetworkCallID(int transferredNetworkCallID)
Transferred Network CallID.

Parameters:
transferredNetworkCallID - new value of the property

getTransferredNetworkNodeID

java.lang.Integer getTransferredNetworkNodeID()
Transferred Network NodeID.

Returns:
property value

setTransferredNetworkNodeID

void setTransferredNetworkNodeID(java.lang.Integer transferredNetworkNodeID)
Transferred Network NodeID.

Parameters:
transferredNetworkNodeID - new value of the property

setTransferredNetworkNodeID

void setTransferredNetworkNodeID(int transferredNetworkNodeID)
Transferred Network NodeID.

Parameters:
transferredNetworkNodeID - new value of the property

getTreatmentParameters

KeyValueCollection getTreatmentParameters()
The additional parameters associated with the treatment type.

Returns:
property value

setTreatmentParameters

void setTreatmentParameters(KeyValueCollection treatmentParameters)
The additional parameters associated with the treatment type.

Parameters:
treatmentParameters - new value of the property

getTreatmentType

TreatmentType getTreatmentType()
The type of the treatment applied to the telephony object in question.

Returns:
property value

setTreatmentType

void setTreatmentType(TreatmentType treatmentType)
The type of the treatment applied to the telephony object in question.

Parameters:
treatmentType - new value of the property

getUserData

KeyValueCollection getUserData()
Call-related user data.

Returns:
property value

setUserData

void setUserData(KeyValueCollection userData)
Call-related user data.

Parameters:
userData - new value of the property

getUserEvent

java.lang.Integer getUserEvent()
The user's event.

Returns:
property value

setUserEvent

void setUserEvent(java.lang.Integer userEvent)
The user's event.

Parameters:
userEvent - new value of the property

setUserEvent

void setUserEvent(int userEvent)
The user's event.

Parameters:
userEvent - new value of the property

getXReferenceID

java.lang.Integer getXReferenceID()
The reference number of a TGetAccessNumber function that is called by an application.

Returns:
property value

setXReferenceID

void setXReferenceID(java.lang.Integer xReferenceID)
The reference number of a TGetAccessNumber function that is called by an application.

Parameters:
xReferenceID - new value of the property

setXReferenceID

void setXReferenceID(int xReferenceID)
The reference number of a TGetAccessNumber function that is called by an application.

Parameters:
xReferenceID - new value of the property

getCallUuid

java.lang.String getCallUuid()
Call UUID.

Returns:
property value

setCallUuid

void setCallUuid(java.lang.String callUuid)
Call UUID.

Parameters:
callUuid - new value of the property

getNewCallUuid

java.lang.String getNewCallUuid()
New call UUUID.

Returns:
property value

setNewCallUuid

void setNewCallUuid(java.lang.String newCallUuid)
New call UUUID.

Parameters:
newCallUuid - new value of the property

getOriginalCallUuid

java.lang.String getOriginalCallUuid()
Original call UUID.

Returns:
property value

setOriginalCallUuid

void setOriginalCallUuid(java.lang.String originalCallUuid)
Original call UUID.

Parameters:
originalCallUuid - new value of the property

getPartyUuid

java.lang.String getPartyUuid()
Party UUID.

Returns:
property value

setPartyUuid

void setPartyUuid(java.lang.String partyUuid)
Party UUID.

Parameters:
partyUuid - new value of the property

getRefCallUuid

java.lang.String getRefCallUuid()
Ref call UUID.

Returns:
property value

setRefCallUuid

void setRefCallUuid(java.lang.String refCallUuid)
Ref call UUID.

Parameters:
refCallUuid - new value of the property

getReliability

Reliability getReliability()

setReliability

void setReliability(Reliability reliability)

getServerStartTime

java.lang.Long getServerStartTime()
int64 timestamp as defined in call monitoring events.

Returns:
property value

setServerStartTime

void setServerStartTime(java.lang.Long serverStartTime)
int64 timestamp as defined in call monitoring events.

Parameters:
serverStartTime - new value of the property

setServerStartTime

void setServerStartTime(long serverStartTime)
int64 timestamp as defined in call monitoring events.

Parameters:
serverStartTime - new value of the property

getEventSequenceNumber

java.lang.Long getEventSequenceNumber()
int64 sequence number of event produced by t-server.

Returns:
property value

setEventSequenceNumber

void setEventSequenceNumber(java.lang.Long eventSequenceNumber)
int64 sequence number of event produced by t-server.

Parameters:
eventSequenceNumber - new value of the property

setEventSequenceNumber

void setEventSequenceNumber(long eventSequenceNumber)
int64 sequence number of event produced by t-server.

Parameters:
eventSequenceNumber - new value of the property

getMediaType

MediaType getMediaType()
The Media Type

Returns:
property value

setMediaType

void setMediaType(MediaType mediaType)
The Media Type

Parameters:
mediaType - new value of the property

getLocalCallType

CallType getLocalCallType()
Returns:
property value

setLocalCallType

void setLocalCallType(CallType localCallType)
Parameters:
localCallType - new value of the property

getPropagatedCallType

CallType getPropagatedCallType()
Returns:
property value

setPropagatedCallType

void setPropagatedCallType(CallType propagatedCallType)
Parameters:
propagatedCallType - new value of the property

getSubscriptionID

java.lang.String getSubscriptionID()
Returns:
property value

setSubscriptionID

void setSubscriptionID(java.lang.String subscriptionID)
Parameters:
subscriptionID - new value of the property

getCallHistory

CallHistoryInfo getCallHistory()

setCallHistory

void setCallHistory(CallHistoryInfo callHistory)

getTime

TimeStamp getTime()

setTime

void setTime(TimeStamp time)

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.