CSTADLL  2.4.0
Public Member Functions | Protected Member Functions | Properties | List of all members
GenericXMLed4 Class Reference
Inheritance diagram for GenericXMLed4:
UnifyOpenscapeVoice uaXMLed4

Public Member Functions

virtual CSTAResponseInfo AcceptCall (ConnectionID callToAccept)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer, string deviceToLift)
 
virtual CSTAResponseInfo ClearConnection (ConnectionID connectionToClear)
 
virtual CSTAResponseInfo ClearDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo ClearForwarding (string fromDevice, ForwardingType fwdType)
 
virtual CSTAResponseInfo ClearMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo ConferenceCall (ConnectionID heldCall, ConnectionID activeCall)
 
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice)
 
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice, ConsultOptions options)
 
virtual string EncodeInvokeID (string initialMessage)
 
 GenericXMLed4 (string pbxSystem, int port)
 
 GenericXMLed4 (PBXSession sessionObject)
 
virtual CSTAResponseInfo GetAgentState (string agentDevice)
 
virtual CSTAResponseInfo GetDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo GetLogicalDevInfo (string targetDevice)
 
virtual CSTAResponseInfo GetPhysicalDevInfo (string targetDevice)
 
virtual CSTAResponseInfo GetSFDevices (ReqDeviceCategory deviceCategory)
 
virtual CSTAResponseInfo GetSFDevices ()
 
virtual CSTAResponseInfo HoldCall (ConnectionID callToHold)
 
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice)
 
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice, bool autoOriginate)
 
virtual CSTAResponseInfo MonitorStart (string deviceToMonitor)
 
virtual CSTAResponseInfo MonitorStart (ConnectionID callToMonitor)
 
virtual CSTAResponseInfo MonitorStop (string crossRefID)
 
virtual CSTAResponseInfo MonitorStopAtDevice (string monitoredDevice)
 
virtual CSTAResponseInfo RequestSystemStatus ()
 
virtual CSTAResponseInfo RetrieveCall (ConnectionID callToRetrieve)
 
virtual CSTAResponseInfo RingDevice (string targetDevice, string targetRinger, long ringPattern)
 
virtual CSTAResponseInfo SendData (IOCrossRefID xref, string text)
 
virtual CSTAResponseInfo SendStoredCDR (string cdrCrossRefID)
 
virtual CSTAResponseInfo SetAgentState (string agentDevice, ReqAgentState agentState, string agentID)
 
virtual CSTAResponseInfo SetAgentState (string agentDevice, ReqAgentState agentState)
 
virtual CSTAResponseInfo SetDisplay (string targetDevice, string text)
 
virtual CSTAResponseInfo SetDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo SetForwarding (string fromDevice, ForwardingType fwdType, string toDevice)
 
virtual CSTAResponseInfo SetMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo SingleStepTransfer (ConnectionID callToTransfer, string transferToDevice)
 
virtual CSTAResponseInfo SnapshotCall (ConnectionID callToSnapshot)
 
virtual CSTAResponseInfo SnapshotDevice (string deviceToSnapshot)
 
virtual CSTAResponseInfo StartCDRTransmission (CDRTransferMode transferMode)
 
virtual CSTAResponseInfo StartDataPath (string targetDevice)
 
virtual CSTAResponseInfo StartSession ()
 
virtual CSTAResponseInfo StartSession (string applicationID)
 
virtual CSTAResponseInfo StopCDRTransmission (string cdrCrossRefID)
 
virtual CSTAResponseInfo StopDataPath (IOCrossRefID xref)
 
virtual CSTAResponseInfo StopRing (string targetDevice, string targetRinger, long ringPattern)
 
virtual CSTAResponseInfo StopSession ()
 
virtual CSTAResponseInfo TransferCall (ConnectionID initiatedCall, ConnectionID originalCall)
 

Protected Member Functions

virtual string EncodeAcceptCall (CSTAResponseInfo response, ConnectionID callToAccept)
 
virtual string EncodeAnswerCall (CSTAResponseInfo response, ConnectionID callToAnswer)
 
virtual string EncodeAnswerCall (CSTAResponseInfo response, ConnectionID callToAnswer, string deviceToLift)
 
virtual string EncodeClearConnection (CSTAResponseInfo response, ConnectionID connectionToClear)
 
virtual string EncodeConferenceCall (CSTAResponseInfo response, ConnectionID heldCall, ConnectionID activeCall)
 
virtual string EncodeConsultationCall (CSTAResponseInfo response, ConnectionID existingCall, string targetDevice)
 
virtual string EncodeConsultationCall (CSTAResponseInfo response, ConnectionID existingCall, string targetDevice, ConsultOptions options)
 
virtual string EncodeGetAgentState (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetDND (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetLogicalDevInfo (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetPhysicalDevInfo (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeGetSFDevices (CSTAResponseInfo response, ReqDeviceCategory category)
 
virtual string EncodeHoldCall (CSTAResponseInfo response, ConnectionID callToHold)
 
virtual string EncodeMakeCall (CSTAResponseInfo response, string callingDevice, string calledDevice, bool autoOriginate)
 
virtual string EncodeMonitorStart (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeMonitorStart (CSTAResponseInfo response, ConnectionID targetCall)
 
virtual string EncodeMonitorStop (CSTAResponseInfo response, string xref)
 
virtual string EncodeRequestSystemStatus (CSTAResponseInfo response)
 
virtual string EncodeRetrieveCall (CSTAResponseInfo response, ConnectionID callToRetrieve)
 
virtual string EncodeSendData (CSTAResponseInfo response, IOCrossRefID xref, string strText)
 
virtual string EncodeSendStoredCDR (CSTAResponseInfo response, string cdrCrossRefID)
 
virtual string EncodeSetAgentState (CSTAResponseInfo response, string agentDevice, ReqAgentState agentState, string agentID)
 
virtual string EncodeSetDisplay (CSTAResponseInfo response, string targetDevice, string text)
 
virtual string EncodeSetDND (CSTAResponseInfo response, string targetDevice, bool dndOn)
 
virtual string EncodeSetMsgWaiting (CSTAResponseInfo response, string targetDevice, bool indicatorOn)
 
virtual string EncodeSetOrClearFwdRequest (CSTAResponseInfo response, string fromDevice, bool fwdOn, ForwardingType fwdType, string toDevice)
 
virtual string EncodeSetRingerStatus (CSTAResponseInfo response, string targetDevice, string targetRinger, RingMode rm, long ringPattern)
 
virtual string EncodeSingleStepTransfer (CSTAResponseInfo response, ConnectionID callToTransfer, string transferToDevice)
 
virtual string EncodeSnapshotCall (CSTAResponseInfo response, ConnectionID callToSnapshot)
 
virtual string EncodeSnapshotDevice (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeStartCDRTrans (CSTAResponseInfo response, CDRTransferMode transferMode)
 
virtual string EncodeStartDataPath (CSTAResponseInfo response, string targetDevice)
 
virtual string EncodeStartSession (CSTAResponseInfo response, string applicationID)
 
virtual string EncodeStopCDRTrans (CSTAResponseInfo response, string cdrCrossRefID)
 
virtual string EncodeStopDataPath (CSTAResponseInfo response, IOCrossRefID xref)
 
virtual string EncodeStopSession (CSTAResponseInfo response)
 
virtual string EncodeTransferCall (CSTAResponseInfo response, ConnectionID initiatedCall, ConnectionID originalCall)
 

Properties

PBXSession SessionObject [get]
 
CSTAContext ThreadContext [get]
 

Detailed Description

Implements CSTA phase 3 operations using XML edition 4. Note that most PBXes don't support all CSTA messages, so some methods in this class may result in an error status being returned by your PBX.

Constructor & Destructor Documentation

◆ GenericXMLed4() [1/2]

GenericXMLed4 ( string  pbxSystem,
int  port 
)

Constructs an instance associated with the given PBX identifier and port.

Parameters
pbxSystemWell-known name or IP address of the PBX.
portPort on which the PBX listens for CSTA messages.

◆ GenericXMLed4() [2/2]

GenericXMLed4 ( PBXSession  sessionObject)

Constructs an instance associated with the given PBXSession object.

Parameters
sessionObjectA PBXSession object.

References PBXSession.MessageEncoding.

Member Function Documentation

◆ AcceptCall()

virtual CSTAResponseInfo AcceptCall ( ConnectionID  callToAccept)
virtual

◆ AnswerCall() [1/2]

virtual CSTAResponseInfo AnswerCall ( ConnectionID  callToAnswer)
virtual

◆ AnswerCall() [2/2]

virtual CSTAResponseInfo AnswerCall ( ConnectionID  callToAnswer,
string  deviceToLift 
)
virtual

Answers a call.

Parameters
callToAnswerConnectionID of an existing call (such as initiated through MakeCall()).
deviceToLiftThe device (e.g., "800") that is to answer the call.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ ClearConnection()

virtual CSTAResponseInfo ClearConnection ( ConnectionID  connectionToClear)
virtual

Clears a connection.

Parameters
connectionToClearThe ConnectionID of the connection to clear.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ ClearDoNotDisturb()

virtual CSTAResponseInfo ClearDoNotDisturb ( string  targetDevice)
virtual

Turns off the Do Not Disturb functionality for a phone.

Parameters
targetDeviceThe device for which the Do Not Disturb functionality is to be turned off.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ ClearForwarding()

virtual CSTAResponseInfo ClearForwarding ( string  fromDevice,
ForwardingType  fwdType 
)
virtual

Clears the forwarding feature for a phone.

Parameters
fromDeviceThe device for which forwarding is to be cleared. This is the device from which calls are being forwarded to a different device.
fwdTypeThe type of forwarding to clear.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ ClearMessageWaiting()

virtual CSTAResponseInfo ClearMessageWaiting ( string  targetDevice)
virtual

Turns off the message waiting indicator on a device's display.

Parameters
targetDeviceThe device for which the indicator is to be turned off.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ ConferenceCall()

virtual CSTAResponseInfo ConferenceCall ( ConnectionID  heldCall,
ConnectionID  activeCall 
)
virtual

Brings a held call into conference with an active call.

Parameters
heldCallThe held call to be brought into conference.
activeCallThe active call.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ ConsultationCall() [1/2]

virtual CSTAResponseInfo ConsultationCall ( ConnectionID  existingCall,
string  targetDevice 
)
virtual

Instruct the PBX to do a consultation call.

Parameters
existingCallThe connection id of the call for which the consultation call will be made.
targetDeviceIdentifier (e.g., phone number) of the device that is the target of the consultation call.
Returns
A CSTAResponseInfo object.

◆ ConsultationCall() [2/2]

virtual CSTAResponseInfo ConsultationCall ( ConnectionID  existingCall,
string  targetDevice,
ConsultOptions  options 
)
virtual

Instruct the PBX or UA to do a consultation call.

Parameters
existingCallThe connection id of the call for which the consultation call will be made.
targetDeviceIdentifier (e.g., phone number) of the device that is the target of the consultation call.
optionsA ConsultOptions object.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ EncodeAcceptCall()

virtual string EncodeAcceptCall ( CSTAResponseInfo  response,
ConnectionID  callToAccept 
)
protectedvirtual

Encodes an AcceptCall message.

Parameters
responseA CSTAResponseInfo object.
callToAcceptThe ConnectionID of the call to accept.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeAnswerCall() [1/2]

virtual string EncodeAnswerCall ( CSTAResponseInfo  response,
ConnectionID  callToAnswer 
)
protectedvirtual

Encodes an AnswerCall message.

Parameters
responseA CSTAResponseInfo object.
callToAnswerThe ConnectionID of the call to answer.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeAnswerCall() [2/2]

virtual string EncodeAnswerCall ( CSTAResponseInfo  response,
ConnectionID  callToAnswer,
string  deviceToLift 
)
protectedvirtual

Encodes an AnswerCall message.

Parameters
responseA CSTAResponseInfo object.
callToAnswerThe ConnectionID of the call to answer.
deviceToLiftThe device (e.g., "800") that is to answer the call.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeClearConnection()

virtual string EncodeClearConnection ( CSTAResponseInfo  response,
ConnectionID  connectionToClear 
)
protectedvirtual

Encodes a ClearConnection message.

Parameters
responseA CSTAResponseInfo object.
connectionToClearThe ConnectionID of the connection to clear.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeConferenceCall()

virtual string EncodeConferenceCall ( CSTAResponseInfo  response,
ConnectionID  heldCall,
ConnectionID  activeCall 
)
protectedvirtual

Encodes a ConferenceCall message.

Parameters
responseA CSTA ResponseInfo object.
heldCallConnectionID of the held call to be retrieved.
activeCallConnectionID of the active call.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeConsultationCall() [1/2]

virtual string EncodeConsultationCall ( CSTAResponseInfo  response,
ConnectionID  existingCall,
string  targetDevice 
)
protectedvirtual

Encodes a ConsultationCall message.

Parameters
responseA CSTAResponseInfo object.
existingCallThe connection id of the call for which the consultation call will be made.
targetDeviceIdentifier (e.g., phone number) of the device that is the target of the consultation call.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeConsultationCall() [2/2]

virtual string EncodeConsultationCall ( CSTAResponseInfo  response,
ConnectionID  existingCall,
string  targetDevice,
ConsultOptions  options 
)
protectedvirtual

Encodes a ConsultationCall message.

Parameters
responseA CSTAResponseInfo object.
existingCallThe connection id of the call for which the consultation call will be made.
targetDeviceIdentifier (e.g., phone number) of the device that is the target of the consultation call.
optionsA ConsultOptions object.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetAgentState()

virtual string EncodeGetAgentState ( CSTAResponseInfo  response,
string  targetDevice 
)
protectedvirtual

Encodes a GetAgentState message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device whose agent state is desired.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetDND()

virtual string EncodeGetDND ( CSTAResponseInfo  response,
string  targetDevice 
)
protectedvirtual

Encodes a GetDoNotDisturb message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe phone for which the Do Not Disturb setting is desired.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetLogicalDevInfo()

virtual string EncodeGetLogicalDevInfo ( CSTAResponseInfo  response,
string  targetDevice 
)
protectedvirtual

Encodes a GetLogicalDeviceInformation message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device for which the information is needed.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetPhysicalDevInfo()

virtual string EncodeGetPhysicalDevInfo ( CSTAResponseInfo  response,
string  targetDevice 
)
protectedvirtual

Encodes a GetPhysicalDeviceInformation message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device for which the information is needed.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetSFDevices()

virtual string EncodeGetSFDevices ( CSTAResponseInfo  response,
ReqDeviceCategory  category 
)
protectedvirtual

Encodes a GetSwitchingFunctionDevices message.

Parameters
responseA CSTAResponseInfo object.
categoryThe category of device for which the list is desired.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeHoldCall()

virtual string EncodeHoldCall ( CSTAResponseInfo  response,
ConnectionID  callToHold 
)
protectedvirtual

Encodes a HoldCall message.

Parameters
responseA CSTAResponseInfo object.
callToHoldThe ConnectionID object for the call to put on hold.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeInvokeID()

virtual string EncodeInvokeID ( string  initialMessage)
virtual

This method prepends an invoke ID to an already encoded XML CSTA message.

Parameters
initialMessageThe XML CSTA message without the invoke ID.
Returns
The message with the invoke ID prepended.

◆ EncodeMakeCall()

virtual string EncodeMakeCall ( CSTAResponseInfo  response,
string  callingDevice,
string  calledDevice,
bool  autoOriginate 
)
protectedvirtual

Encodes a MakeCall message.

Parameters
responseA CSTAResponseInfo object.
callingDeviceThe device that is making the call.
calledDeviceThe device that is being called.
autoOriginateIf true, the call will be answered automatically (if the PBX supports this feature). If false, the called device will alert.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStart() [1/2]

virtual string EncodeMonitorStart ( CSTAResponseInfo  response,
string  targetDevice 
)
protectedvirtual

Encodes a MonitorStart message to monitor a device.

Parameters
responseA CSTAResponseInfo object.
targetDeviceIdentifier (e.g., telephone number) of the device to monitor.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStart() [2/2]

virtual string EncodeMonitorStart ( CSTAResponseInfo  response,
ConnectionID  targetCall 
)
protectedvirtual

Encodes a MonitorStart message to monitor a call.

Parameters
responseA CSTAResponseInfo object.
targetCallThe call to monitor.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStop()

virtual string EncodeMonitorStop ( CSTAResponseInfo  response,
string  xref 
)
protectedvirtual

Encodes a MonitorStop message.

Parameters
responseA CSTAResponseInfo object.
xrefThe cross reference id of the monitor request as a MonitorCrossRefID object.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeRequestSystemStatus()

virtual string EncodeRequestSystemStatus ( CSTAResponseInfo  response)
protectedvirtual

Encodes a RequestSystemStatus message.

Parameters
responseA CSTAResponseInfo object.
Returns
The encoded message.

References CSTAResponseInfo.StatusCode, and CSTAResponseInfo.StatusMessage.

◆ EncodeRetrieveCall()

virtual string EncodeRetrieveCall ( CSTAResponseInfo  response,
ConnectionID  callToRetrieve 
)
protectedvirtual

Encodes a RetrieveCall message.

Parameters
responseA CSTAResponseInfo object.
callToRetrieveThe ConnectionID of the call to retrieve.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSendData()

virtual string EncodeSendData ( CSTAResponseInfo  response,
IOCrossRefID  xref,
string  strText 
)
protectedvirtual

Encodes a SendData message.

Parameters
responseA CSTAResponseInfo object.
xrefAn IOCrossRefID object, most likely obtained by a previous call to StartDataPath.
strTextThe text to send to the telephony device.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSendStoredCDR()

virtual string EncodeSendStoredCDR ( CSTAResponseInfo  response,
string  cdrCrossRefID 
)
protectedvirtual

Encodes a SendStoredCallDetailRecords message.

Parameters
responseA CSTAResponseInfo object.
cdrCrossRefIDThe CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetAgentState()

virtual string EncodeSetAgentState ( CSTAResponseInfo  response,
string  agentDevice,
ReqAgentState  agentState,
string  agentID 
)
protectedvirtual

Encodes a SetAgentState message.

Parameters
responseA CSTAResponseInfo object.
agentDeviceThe device associated with the agent.
agentStateAn ReqAgentState object indicating the desired state of the agent.
agentIDThe agent id.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetDisplay()

virtual string EncodeSetDisplay ( CSTAResponseInfo  response,
string  targetDevice,
string  text 
)
protectedvirtual

Encodes a Set Display message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device to which the text is to be sent.
textThe text to be sent.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetDND()

virtual string EncodeSetDND ( CSTAResponseInfo  response,
string  targetDevice,
bool  dndOn 
)
protectedvirtual

Encodes a SetDoNotDisturb message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device for which Do Not Disturb is to be set or cleared.
dndOnIf true, indicates that Do Not Disturb is to be turned on. If false, indicates that Do Not Disturb is to be turned off.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetMsgWaiting()

virtual string EncodeSetMsgWaiting ( CSTAResponseInfo  response,
string  targetDevice,
bool  indicatorOn 
)
protectedvirtual

Encodes a SetMessageWaiting message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device for which the message waiting indicator is to be turned on or off.
indicatorOnIf true, indicates that the message waiting indicator is to be turned on. If false, indicates that the message waiting indicator is to be turned off.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetOrClearFwdRequest()

virtual string EncodeSetOrClearFwdRequest ( CSTAResponseInfo  response,
string  fromDevice,
bool  fwdOn,
ForwardingType  fwdType,
string  toDevice 
)
protectedvirtual

Encodes a SetForwarding message to set or clear forwarding.

Parameters
responseA CSTAResponseInfo object.
fromDeviceThe device for which forwarding is to be set or cleared. In the case of setting forwarding, this is the device from which calls are to be forwarded to a different device. In the case of clearing forwarding, this is the device from which calls are currently being forwarded to a different device.
fwdOnIf true, forwarding will be turned on. If false, forwarding will be turned off.
fwdTypeThe type of forwarding to set or clear.
toDeviceThe device to which calls are to be forwarded from the device indicated by the fromDevice parameter. If forwarding is being cleared, this parameter is ignored and can be set to null.
Returns
The encoded message.

References PBXSession.SendXMLSession(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, GenericXMLed4.ThreadContext, CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ EncodeSetRingerStatus()

virtual string EncodeSetRingerStatus ( CSTAResponseInfo  response,
string  targetDevice,
string  targetRinger,
RingMode  rm,
long  ringPattern 
)
protectedvirtual

Encodes a SetRingerStatus message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device to ring.
targetRingerThe id of the ringer to use for the ring. This argument can be specified as a character string (e.g, "abc"), a hex string (e.g, "'010A05'H"), or a binary string (e.g, "'000000010000101000000101'B").
rmA RingMode instance that indicates either ringing or notRinging.
ringPatternThe indicator of the ring pattern to use.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSingleStepTransfer()

virtual string EncodeSingleStepTransfer ( CSTAResponseInfo  response,
ConnectionID  callToTransfer,
string  transferToDevice 
)
protectedvirtual

Encodes a SingleStepTransfer message.

Parameters
responseA CSTAResponseInfo object.
callToTransferA ConnectionID object that identifies the call to be transferred.
transferToDeviceThe device (e.g., "101") to which the call is to be transferred.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSnapshotCall()

virtual string EncodeSnapshotCall ( CSTAResponseInfo  response,
ConnectionID  callToSnapshot 
)
protectedvirtual

Encodes a SnapshotCall message.

Parameters
responseA CSTAResponseInfo object.
callToSnapshotThe ConnectionID of the call for which the snapshot is desired.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSnapshotDevice()

virtual string EncodeSnapshotDevice ( CSTAResponseInfo  response,
string  targetDevice 
)
protectedvirtual

Encodes a SnapshotDevice message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceIdentifier (e.g., phone number) of the device for which the snapshot is desired.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStartCDRTrans()

virtual string EncodeStartCDRTrans ( CSTAResponseInfo  response,
CDRTransferMode  transferMode 
)
protectedvirtual

Encodes a StartCallDetailRecordsTransmission message.

Parameters
responseA CSTAResponseInfo object.
transferModeThe mode the PBX or UA is to use to transfer call detail records.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStartDataPath()

virtual string EncodeStartDataPath ( CSTAResponseInfo  response,
string  targetDevice 
)
protectedvirtual

Encodes a StartDataPath message.

Parameters
responseA CSTAResponseInfo object.
targetDeviceThe device against which a data path is to be started.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStartSession()

virtual string EncodeStartSession ( CSTAResponseInfo  response,
string  applicationID 
)
protectedvirtual

Encodes a StartApplicationSession message.

Parameters
responseA CSTAResponseInfo object.
applicationIDThe application id to be encoded into the message.
Returns
The encoded message.

References CSTAResponseInfo.StatusCode, and CSTAResponseInfo.StatusMessage.

◆ EncodeStopCDRTrans()

virtual string EncodeStopCDRTrans ( CSTAResponseInfo  response,
string  cdrCrossRefID 
)
protectedvirtual

Encodes a StopCallDetailRecordsTransmission message.

Parameters
responseA CSTAResponseInfo object.
cdrCrossRefIDThe CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStopDataPath()

virtual string EncodeStopDataPath ( CSTAResponseInfo  response,
IOCrossRefID  xref 
)
protectedvirtual

Encodes a StopDataPath message.

Parameters
responseA CSTAResponseInfo object.
xrefAn IOCrossRefID object, most likely obtained from a previous call to StartDataPath.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStopSession()

virtual string EncodeStopSession ( CSTAResponseInfo  response)
protectedvirtual

Encodes a StopApplicationSession message.

Parameters
responseA CSTAResponseInfo object.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ EncodeTransferCall()

virtual string EncodeTransferCall ( CSTAResponseInfo  response,
ConnectionID  initiatedCall,
ConnectionID  originalCall 
)
protectedvirtual

Encodes a TransferCall message.

Parameters
responseA CSTAResponseInfo object.
initiatedCallConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResponse_ELEM class, for example, contains this ConnectionID.
originalCallConnectionID of the original call. The somewhat confusingly named callingDevice member of the MakeCallResponse_ELEM class contains this ConnectionID, as does the establishedConnection member of the EstablishedEvent_ELEM class.
Returns
The encoded message.

References CSTAResponseInfo.StatusMessage.

◆ GetAgentState()

virtual CSTAResponseInfo GetAgentState ( string  agentDevice)
virtual

Gets the state of the agent associated with a device.

Parameters
agentDeviceThe device associated with the agent.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ GetDoNotDisturb()

virtual CSTAResponseInfo GetDoNotDisturb ( string  targetDevice)
virtual

Gets the Do Not Disturb setting for a phone.

Parameters
targetDeviceThe phone for which the Do Not Disturb setting is desired.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ GetLogicalDevInfo()

virtual CSTAResponseInfo GetLogicalDevInfo ( string  targetDevice)
virtual

Gets information about the logical element of a device.

Parameters
targetDeviceThe device for which the information is desired.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ GetPhysicalDevInfo()

virtual CSTAResponseInfo GetPhysicalDevInfo ( string  targetDevice)
virtual

Gets information about the physical element of a device.

Parameters
targetDeviceThe device for which the information is desired.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ GetSFDevices() [1/2]

virtual CSTAResponseInfo GetSFDevices ( ReqDeviceCategory  deviceCategory)
virtual

Sends a Get Switching Function Devices request to the PBX or UA.

Parameters
deviceCategoryThe category of device for which the list is desired.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, CSTAContext.XMLResponseFromPBX, CSTAResponseInfo.XMLResponsesFromPBX, and CSTAContext.XMLResponsesFromPBX.

◆ GetSFDevices() [2/2]

virtual CSTAResponseInfo GetSFDevices ( )
virtual

Sends a Get Switching Function Devices request to the PBX or UA.

Returns
A CSTAResponseInfo object.

◆ HoldCall()

virtual CSTAResponseInfo HoldCall ( ConnectionID  callToHold)
virtual

Instruct the PBX or UA to hold a call.

Parameters
callToHoldThe ConnectionID of the call to be held.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ MakeCall() [1/2]

virtual CSTAResponseInfo MakeCall ( string  callingDevice,
string  calledDevice 
)
virtual

Instruct the PBX or UA to place a call.

Parameters
callingDeviceIdentifier (e.g., phone number) of the device making the call.
calledDeviceIdentifier (e.g., phone number) of the device being called.
Returns
A CSTAResponseInfo object.

◆ MakeCall() [2/2]

virtual CSTAResponseInfo MakeCall ( string  callingDevice,
string  calledDevice,
bool  autoOriginate 
)
virtual

Instruct the PBX or UA to place a call.

Parameters
callingDeviceIdentifier (e.g., phone number) of the device making the call.
calledDeviceIdentifier (e.g., phone number) of the device being called.
autoOriginateIf true, the call will be answered automatically (if the PBX supports this feature). If false, the called device will alert.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ MonitorStart() [1/2]

virtual CSTAResponseInfo MonitorStart ( string  deviceToMonitor)
virtual

Issues a MonitorStart request to the PBX or UA to monitor a device.

Parameters
deviceToMonitorIdentifier (e.g., telephone number) of the device to monitor.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ MonitorStart() [2/2]

virtual CSTAResponseInfo MonitorStart ( ConnectionID  callToMonitor)
virtual

Issues a MonitorStart request to the PBX or UA to monitor a call.

Parameters
callToMonitorThe call to monitor.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ MonitorStop()

virtual CSTAResponseInfo MonitorStop ( string  crossRefID)
virtual

Stop a previously started PBX or UA monitor request.

Parameters
crossRefIDThe cross reference id of the monitor request as a MonitorCrossRefID object.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ MonitorStopAtDevice()

virtual CSTAResponseInfo MonitorStopAtDevice ( string  monitoredDevice)
virtual

This method stops all monitors active against the indicated device, regardless of what thread started the monitor. The method will only stop monitors started through the MonitorStart() method.

Parameters
monitoredDeviceThe monitored device (e.g., extension).
Returns
If no problems are encountered, the method returns a CSTAResponseInfo object containing the response from the PBX or UA for the LAST MonitorStop message.
If any problems are encountered, the method returns a CSTAResponseInfo object containing information about the error, including any response from the PBX for the problematic MonitorStop message.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), and CSTAContext.XMLResponseFromPBX.

◆ RequestSystemStatus()

virtual CSTAResponseInfo RequestSystemStatus ( )
virtual

◆ RetrieveCall()

virtual CSTAResponseInfo RetrieveCall ( ConnectionID  callToRetrieve)
virtual

Retrieves a held call.

Parameters
callToRetrieveThe ConnectionID of the call to retrieve.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ RingDevice()

virtual CSTAResponseInfo RingDevice ( string  targetDevice,
string  targetRinger,
long  ringPattern 
)
virtual

Causes a telephony device to ring.

Parameters
targetDeviceThe device to ring.
targetRingerThe id of the ringer to use for the ring. This argument can be specified as a character string (e.g, "abc"), a hex string (e.g, "'010A05'H"), or a binary string (e.g, "'000000010000101000000101'B").
ringPatternThe indicator of the ring pattern to use.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SendData()

virtual CSTAResponseInfo SendData ( IOCrossRefID  xref,
string  text 
)
virtual

Sends a text message to a telephony device.

Parameters
xrefAn IOCrossRefID object, most likely obtained by a previous call to StartDataPath.
textThe text to send to the telephony device.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SendStoredCDR()

virtual CSTAResponseInfo SendStoredCDR ( string  cdrCrossRefID)
virtual

Issues a SendStoredCallDetailRecords request to the PBX or UA. A CDR callback method (see PBXSession.XMLCDRCallback) must be defined in order to receive CDR messages.

Parameters
cdrCrossRefIDThe CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SetAgentState() [1/2]

virtual CSTAResponseInfo SetAgentState ( string  agentDevice,
ReqAgentState  agentState,
string  agentID 
)
virtual

Sets the state of an agent associated with a device.

Parameters
agentDeviceThe device associated with the agent.
agentStateThe desired state for the agent.
agentIDThe agent id.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SetAgentState() [2/2]

virtual CSTAResponseInfo SetAgentState ( string  agentDevice,
ReqAgentState  agentState 
)
virtual

Sets the state of an agent associated with a device.

Parameters
agentDeviceThe device associated with the agent.
agentStateThe desired state for the agent.
Returns
A CSTAResponseInfo object.

◆ SetDisplay()

virtual CSTAResponseInfo SetDisplay ( string  targetDevice,
string  text 
)
virtual

Sends text to a telephony device's display

Parameters
targetDeviceThe device to which the text is to be sent.
textThe text to be sent.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SetDoNotDisturb()

virtual CSTAResponseInfo SetDoNotDisturb ( string  targetDevice)
virtual

Sets the Do Not Disturb feature for a phone.

Parameters
targetDeviceThe device for which Do Not Disturb is to be set.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SetForwarding()

virtual CSTAResponseInfo SetForwarding ( string  fromDevice,
ForwardingType  fwdType,
string  toDevice 
)
virtual

Sets the forwarding feature for a phone.

Parameters
fromDeviceThe device for which forwarding is to be set. This is the device from which calls are to be forwarded to a different device.
fwdTypeThe type of forwarding to set.
toDeviceThe device to which calls are to be forwarded from the device indicated by the fromDevice parameter.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SetMessageWaiting()

virtual CSTAResponseInfo SetMessageWaiting ( string  targetDevice)
virtual

Turns on the message waiting indicator on a device's display.

Parameters
targetDeviceThe device for which the indicator is to be turned on.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SingleStepTransfer()

virtual CSTAResponseInfo SingleStepTransfer ( ConnectionID  callToTransfer,
string  transferToDevice 
)
virtual

Perform a single step transfer.

Parameters
callToTransferA ConnectionID object that identifies the call to be transferred.
transferToDeviceThe device (e.g., "101") to which the call is to be transferred.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ SnapshotCall()

virtual CSTAResponseInfo SnapshotCall ( ConnectionID  callToSnapshot)
virtual

Instruct the PBX or UA to take a snapshot of a call.

Parameters
callToSnapshotThe ConnectionID of the call for which the snapshot is desired.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, CSTAContext.XMLResponseFromPBX, CSTAResponseInfo.XMLResponsesFromPBX, and CSTAContext.XMLResponsesFromPBX.

◆ SnapshotDevice()

virtual CSTAResponseInfo SnapshotDevice ( string  deviceToSnapshot)
virtual

Instruct the PBX to take a snapshot of calls active at a device.

Parameters
deviceToSnapshotIdentifier (e.g., phone number) of the device for which the snapshot is desired.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, CSTAContext.XMLResponseFromPBX, CSTAResponseInfo.XMLResponsesFromPBX, and CSTAContext.XMLResponsesFromPBX.

◆ StartCDRTransmission()

virtual CSTAResponseInfo StartCDRTransmission ( CDRTransferMode  transferMode)
virtual

Issues a StartCallDetailRecordsTransmission request to the PBX or UA. A CDR callback method (see PBXSession.XMLCDRCallback) must be defined in order to receive CDR messages.

Parameters
transferModeIndicates how the PBX is to transfer the CDR information.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ StartDataPath()

virtual CSTAResponseInfo StartDataPath ( string  targetDevice)
virtual

Opens up a data path to a specified device.

Parameters
targetDeviceSpecifies the device to which a data path is to be opened.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ StartSession() [1/2]

virtual CSTAResponseInfo StartSession ( )
virtual

Establish a session with the PBX, using "CSTADLL" as the application identifier.

Returns
A CSTAResponseInfo object.

Reimplemented in uaXMLed4.

◆ StartSession() [2/2]

virtual CSTAResponseInfo StartSession ( string  applicationID)
virtual

Establish a session with the PBX.

Parameters
applicationIDA free text string to identify the application.
Returns
A CSTAResponseInfo object.

Reimplemented in uaXMLed4.

References PBXSession.Close(), SocketState.ReadBuffer, PBXSession.SendXMLSession(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, SocketState.TotalLength, and CSTAResponseInfo.XMLResponseFromPBX.

◆ StopCDRTransmission()

virtual CSTAResponseInfo StopCDRTransmission ( string  cdrCrossRefID)
virtual

Issues a StopCallDetailRecordsTransmission request to the PBX or UA.

Parameters
cdrCrossRefIDThe CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ StopDataPath()

virtual CSTAResponseInfo StopDataPath ( IOCrossRefID  xref)
virtual

Stops a previously established data path

Parameters
xrefAn IOCrossRefID object, most likely obtained from a previous call to StartDataPath.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ StopRing()

virtual CSTAResponseInfo StopRing ( string  targetDevice,
string  targetRinger,
long  ringPattern 
)
virtual

Stops a ringer on a telephony device.

Parameters
targetDeviceThe device for which the ringer is to stop.
targetRingerThe id of the ringer to stop. This argument can be specified as a character string (e.g, "abc"), a hex string (e.g, "'010A05'H"), or a binary string (e.g, "'000000010000101000000101'B").
ringPatternThe indicator of the ring pattern to stop.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ StopSession()

virtual CSTAResponseInfo StopSession ( )
virtual

Stops a session with a PBX. The TCP/IP connection to the PBX will be terminated.

Returns
A CSTAResponseInfo object.

Reimplemented in uaXMLed4.

References PBXSession.Close(), PBXSession.SendXMLSession(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

◆ TransferCall()

virtual CSTAResponseInfo TransferCall ( ConnectionID  initiatedCall,
ConnectionID  originalCall 
)
virtual

Transfers a call. A consultation call must be done before calling this method.

Parameters
initiatedCallConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResponse_ELEM class, for example, contains this ConnectionID.
originalCallConnectionID of the original call. The somewhat confusingly named callingDevice member of the MakeCallResponse_ELEM class contains this ConnectionID, as does the establishedConnection member of the EstablishedEvent_ELEM class.
Returns
A CSTAResponseInfo object.

References PBXSession.SendXMLMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, PBXSession.WaitForXMLResponse(), CSTAResponseInfo.XMLResponseFromPBX, and CSTAContext.XMLResponseFromPBX.

Property Documentation

◆ SessionObject

PBXSession SessionObject
get

The PBXSession object associated with this instance.

◆ ThreadContext

CSTAContext ThreadContext
get

The CSTAContext structure for this thread.

Referenced by GenericXMLed4.EncodeSetOrClearFwdRequest().