GenericXML Class Reference

Inheritance diagram for GenericXML:
UnifyOpenscapeVoice VodiaSNOMOne

List of all members.

Public Member Functions

virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer, string deviceToLift)
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer)
virtual CSTAResponseInfo ClearConnection (ConnectionID connectionToClear)
virtual CSTAResponseInfo ClearDoNotDisturb (string targetDevice)
virtual CSTAResponseInfo ClearMessageWaiting (string targetDevice)
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice)
virtual string EncodeInvokeID (string initialMessage)
 GenericXML (PBXSession sessionObject)
 GenericXML (string pbxSystem, int port)
virtual CSTAResponseInfo GetAgentState (string agentDevice)
virtual CSTAResponseInfo GetDoNotDisturb (string targetDevice)
virtual CSTAResponseInfo GetSFDevices ()
virtual CSTAResponseInfo GetSFDevices (ReqDeviceCategory deviceCategory)
virtual CSTAResponseInfo HoldCall (ConnectionID callToHold)
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice)
virtual CSTAResponseInfo MonitorStart (ConnectionID callToMonitor)
virtual CSTAResponseInfo MonitorStart (string deviceToMonitor)
virtual CSTAResponseInfo MonitorStop (string crossRefID)
virtual CSTAResponseInfo MonitorStopAtDevice (string monitoredDevice)
virtual CSTAResponseInfo RetrieveCall (ConnectionID callToRetrieve)
virtual CSTAResponseInfo RingDevice (string targetDevice, string targetRinger, long ringPattern)
virtual CSTAResponseInfo SendData (IOCrossRefID xref, string text)
virtual CSTAResponseInfo SetAgentState (string agentDevice, ReqAgentState agentState)
virtual CSTAResponseInfo SetAgentState (string agentDevice, ReqAgentState agentState, string agentID)
virtual CSTAResponseInfo SetDisplay (string targetDevice, string text)
virtual CSTAResponseInfo SetDoNotDisturb (string targetDevice)
virtual CSTAResponseInfo SetMessageWaiting (string targetDevice)
virtual CSTAResponseInfo SingleStepTransfer (ConnectionID callToTransfer, string transferToDevice)
virtual CSTAResponseInfo SnapshotCall (ConnectionID callToSnapshot)
virtual CSTAResponseInfo SnapshotDevice (string deviceToSnapshot)
virtual CSTAResponseInfo StartDataPath (string targetDevice)
virtual CSTAResponseInfo StartSession (string applicationID)
virtual CSTAResponseInfo StartSession ()
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 EncodeAnswerCall (CSTAResponseInfo response, ConnectionID callToAnswer, string deviceToLift)
virtual string EncodeAnswerCall (CSTAResponseInfo response, ConnectionID callToAnswer)
virtual string EncodeClearConnection (CSTAResponseInfo response, ConnectionID connectionToClear)
virtual string EncodeConsultationCall (CSTAResponseInfo response, ConnectionID existingCall, string targetDevice)
virtual string EncodeGetAgentState (CSTAResponseInfo response, string targetDevice)
virtual string EncodeGetDND (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)
virtual string EncodeMonitorStart (CSTAResponseInfo response, ConnectionID targetCall)
virtual string EncodeMonitorStart (CSTAResponseInfo response, string targetDevice)
virtual string EncodeMonitorStop (CSTAResponseInfo response, string xref)
virtual string EncodeRetrieveCall (CSTAResponseInfo response, ConnectionID callToRetrieve)
virtual string EncodeSendData (CSTAResponseInfo response, IOCrossRefID xref, string strText)
virtual string EncodeSetAgentState (CSTAResponseInfo response, string agentDevice, ReqAgentState agentState)
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 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 EncodeStartDataPath (CSTAResponseInfo response, string targetDevice)
virtual string EncodeStartSession (CSTAResponseInfo response, string applicationID)
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. 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

GenericXML ( string  pbxSystem,
int  port 
)

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

Parameters:
pbxSystem Well-known name or IP address of the PBX.
port Port on which the PBX listens for CSTA messages.
GenericXML ( PBXSession  sessionObject  ) 

Constructs an instance associated with the given PBXSession object.

Parameters:
sessionObject A PBXSession object.

Member Function Documentation

virtual CSTAResponseInfo AnswerCall ( ConnectionID  callToAnswer,
string  deviceToLift 
) [virtual]

Answers a call.

Parameters:
callToAnswer ConnectionID of an existing call (such as initiated through MakeCall()).
deviceToLift The device (e.g., "800") that is to answer the call.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo AnswerCall ( ConnectionID  callToAnswer  )  [virtual]

Answers a call.

Parameters:
callToAnswer The ConnectionID of the call to answer.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo ClearConnection ( ConnectionID  connectionToClear  )  [virtual]

Clears a connection.

Parameters:
connectionToClear The ConnectionID of the connection to clear.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo ClearDoNotDisturb ( string  targetDevice  )  [virtual]

Turns off the Do Not Disturb functionality for a phone.

Parameters:
targetDevice The device for which the Do Not Disturb functionality is to be turned off.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo ClearMessageWaiting ( string  targetDevice  )  [virtual]

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

Parameters:
targetDevice The device for which the indicator is to be turned off.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo ConsultationCall ( ConnectionID  existingCall,
string  targetDevice 
) [virtual]

Instruct the PBX to do a consultation call.

Parameters:
existingCall The connection id of the call for which the consultation call will be made.
targetDevice Identifier (e.g., phone number) of the device that is the target of the consultation call.
Returns:
A CSTAResponseInfo object.
virtual string EncodeAnswerCall ( CSTAResponseInfo  response,
ConnectionID  callToAnswer,
string  deviceToLift 
) [protected, virtual]

Encodes an AnswerCall message.

Parameters:
response A CSTAResponseInfo object.
callToAnswer The ConnectionID of the call to answer.
deviceToLift The device (e.g., "800") that is to answer the call.
Returns:
The encoded message.
virtual string EncodeAnswerCall ( CSTAResponseInfo  response,
ConnectionID  callToAnswer 
) [protected, virtual]

Encodes an AnswerCall message.

Parameters:
response A CSTAResponseInfo object.
callToAnswer The ConnectionID of the call to answer.
Returns:
The encoded message.
virtual string EncodeClearConnection ( CSTAResponseInfo  response,
ConnectionID  connectionToClear 
) [protected, virtual]

Encodes a ClearConnection message.

Parameters:
response A CSTAResponseInfo object.
connectionToClear The ConnectionID of the connection to clear.
Returns:
The encoded message.
virtual string EncodeConsultationCall ( CSTAResponseInfo  response,
ConnectionID  existingCall,
string  targetDevice 
) [protected, virtual]

Encodes a ConsultationCall message.

Parameters:
response A CSTAResponseInfo object.
existingCall The connection id of the call for which the consultation call will be made.
targetDevice Identifier (e.g., phone number) of the device that is the target of the consultation call.
Returns:
The encoded message.
virtual string EncodeGetAgentState ( CSTAResponseInfo  response,
string  targetDevice 
) [protected, virtual]

Encodes a GetAgentState message.

Parameters:
response A CSTAResponseInfo object.
targetDevice The device whose agent state is desired.
Returns:
The encoded message.
virtual string EncodeGetDND ( CSTAResponseInfo  response,
string  targetDevice 
) [protected, virtual]

Encodes a GetDoNotDisturb message.

Parameters:
response A CSTAResponseInfo object.
targetDevice The phone for which the Do Not Disturb setting is desired.
Returns:
The encoded message.
virtual string EncodeGetSFDevices ( CSTAResponseInfo  response,
ReqDeviceCategory  category 
) [protected, virtual]

Encodes a GetSwitchingFunctionDevices message.

Parameters:
response A CSTAResponseInfo object.
category The category of device for which the list is desired.
Returns:
The encoded message.
virtual string EncodeHoldCall ( CSTAResponseInfo  response,
ConnectionID  callToHold 
) [protected, virtual]

Encodes a HoldCall message.

Parameters:
response A CSTAResponseInfo object.
callToHold The ConnectionID object for the call to put on hold.
Returns:
The encoded message.
virtual string EncodeInvokeID ( string  initialMessage  )  [virtual]

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

Parameters:
initialMessage The XML CSTA message without the invoke ID.
Returns:
The message with the invoke ID prepended.
virtual string EncodeMakeCall ( CSTAResponseInfo  response,
string  callingDevice,
string  calledDevice 
) [protected, virtual]

Encodes a MakeCall message.

Parameters:
response A CSTAResponseInfo object.
callingDevice The device that is making the call.
calledDevice The device that is being called.
Returns:
The encoded message.
virtual string EncodeMonitorStart ( CSTAResponseInfo  response,
ConnectionID  targetCall 
) [protected, virtual]

Encodes a MonitorStart message to monitor a call.

Parameters:
response A CSTAResponseInfo object.
targetCall The call to monitor.
Returns:
The encoded message.
virtual string EncodeMonitorStart ( CSTAResponseInfo  response,
string  targetDevice 
) [protected, virtual]

Encodes a MonitorStart message to monitor a device.

Parameters:
response A CSTAResponseInfo object.
targetDevice Identifier (e.g., telephone number) of the device to monitor.
Returns:
The encoded message.
virtual string EncodeMonitorStop ( CSTAResponseInfo  response,
string  xref 
) [protected, virtual]

Encodes a MonitorStop message.

Parameters:
response A CSTAResponseInfo object.
xref The cross reference id of the monitor request as a MonitorCrossRefID object.
Returns:
The encoded message.
virtual string EncodeRetrieveCall ( CSTAResponseInfo  response,
ConnectionID  callToRetrieve 
) [protected, virtual]

Encodes a RetrieveCall message.

Parameters:
response A CSTAResponseInfo object.
callToRetrieve The ConnectionID of the call to retrieve.
Returns:
The encoded message.
virtual string EncodeSendData ( CSTAResponseInfo  response,
IOCrossRefID  xref,
string  strText 
) [protected, virtual]

Encodes a SendData message.

Parameters:
response A CSTAResponseInfo object.
xref An IOCrossRefID object, most likely obtained by a previous call to StartDataPath.
strText The text to send to the telephony device.
Returns:
The encoded message.
virtual string EncodeSetAgentState ( CSTAResponseInfo  response,
string  agentDevice,
ReqAgentState  agentState 
) [protected, virtual]

Encodes a SetAgentState message.

Parameters:
response A CSTAResponseInfo object.
agentDevice The device associated with the agent.
agentState An ReqAgentState object indicating the desired state of the agent.
Returns:
The encoded message.
virtual string EncodeSetAgentState ( CSTAResponseInfo  response,
string  agentDevice,
ReqAgentState  agentState,
string  agentID 
) [protected, virtual]

Encodes a SetAgentState message.

Parameters:
response A CSTAResponseInfo object.
agentDevice The device associated with the agent.
agentState An ReqAgentState object indicating the desired state of the agent.
agentID The agent id.
Returns:
The encoded message.
virtual string EncodeSetDisplay ( CSTAResponseInfo  response,
string  targetDevice,
string  text 
) [protected, virtual]

Encodes a Set Display message.

Parameters:
response A CSTAResponseInfo object.
targetDevice The device to which the text is to be sent.
text The text to be sent.
Returns:
The encoded message.
virtual string EncodeSetDND ( CSTAResponseInfo  response,
string  targetDevice,
bool  dndOn 
) [protected, virtual]

Encodes a SetDoNotDisturb message.

Parameters:
response A CSTAResponseInfo object.
targetDevice The device for which Do Not Disturb is to be set or cleared.
dndOn If 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.
virtual string EncodeSetMsgWaiting ( CSTAResponseInfo  response,
string  targetDevice,
bool  indicatorOn 
) [protected, virtual]

Encodes a SetMessageWaiting message.

Parameters:
response A CSTAResponseInfo object.
targetDevice The device for which the message waiting indicator is to be turned on or off.
indicatorOn If 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.
virtual string EncodeSetRingerStatus ( CSTAResponseInfo  response,
string  targetDevice,
string  targetRinger,
RingMode  rm,
long  ringPattern 
) [protected, virtual]

Encodes a SetRingerStatus message.

Parameters:
response A CSTAResponseInfo object.
targetDevice The device to ring.
targetRinger The 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").
rm A RingMode instance that indicates either ringing or notRinging.
ringPattern The indicator of the ring pattern to use.
Returns:
The encoded message.
virtual string EncodeSingleStepTransfer ( CSTAResponseInfo  response,
ConnectionID  callToTransfer,
string  transferToDevice 
) [protected, virtual]

Encodes a SingleStepTransfer message.

Parameters:
response A CSTAResponseInfo object.
callToTransfer A ConnectionID object that identifies the call to be transferred.
transferToDevice The device (e.g., "101") to which the call is to be transferred.
Returns:
The encoded message.
virtual string EncodeSnapshotCall ( CSTAResponseInfo  response,
ConnectionID  callToSnapshot 
) [protected, virtual]

Encodes a SnapshotCall message.

Parameters:
response A CSTAResponseInfo object.
callToSnapshot The ConnectionID of the call for which the snapshot is desired.
Returns:
The encoded message.
virtual string EncodeSnapshotDevice ( CSTAResponseInfo  response,
string  targetDevice 
) [protected, virtual]

Encodes a SnapshotDevice message.

Parameters:
response A CSTAResponseInfo object.
targetDevice Identifier (e.g., phone number) of the device for which the snapshot is desired.
Returns:
The encoded message.
virtual string EncodeStartDataPath ( CSTAResponseInfo  response,
string  targetDevice 
) [protected, virtual]

Encodes a StartDataPath message.

Parameters:
response A CSTAResponseInfo object.
targetDevice The device against which a data path is to be started.
Returns:
The encoded message.
virtual string EncodeStartSession ( CSTAResponseInfo  response,
string  applicationID 
) [protected, virtual]

Encodes a StartApplicationSession message.

Parameters:
response A CSTAResponseInfo object.
applicationID The application id to be encoded into the message.
Returns:
The encoded message.
virtual string EncodeStopDataPath ( CSTAResponseInfo  response,
IOCrossRefID  xref 
) [protected, virtual]

Encodes a StopDataPath message.

Parameters:
response A CSTAResponseInfo object.
xref An IOCrossRefID object, most likely obtained from a previous call to StartDataPath.
Returns:
The encoded message.
virtual string EncodeStopSession ( CSTAResponseInfo  response  )  [protected, virtual]

Encodes a StopApplicationSession message.

Parameters:
response A CSTAResponseInfo object.
Returns:
The encoded message.
virtual string EncodeTransferCall ( CSTAResponseInfo  response,
ConnectionID  initiatedCall,
ConnectionID  originalCall 
) [protected, virtual]

Encodes a TransferCall message.

Parameters:
response A CSTAResponseInfo object.
initiatedCall ConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResponse_ELEM class, for example, contains this ConnectionID.
originalCall ConnectionID 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.
virtual CSTAResponseInfo GetAgentState ( string  agentDevice  )  [virtual]

Gets the state of the agent associated with a device.

Parameters:
agentDevice The device associated with the agent.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo GetDoNotDisturb ( string  targetDevice  )  [virtual]

Gets the Do Not Disturb setting for a phone.

Parameters:
targetDevice The phone for which the Do Not Disturb setting is desired.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo GetSFDevices (  )  [virtual]

Sends a Get Switching Function Devices request to the PBX.

Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo GetSFDevices ( ReqDeviceCategory  deviceCategory  )  [virtual]

Sends a Get Switching Function Devices request to the PBX.

Parameters:
deviceCategory The category of device for which the list is desired.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo HoldCall ( ConnectionID  callToHold  )  [virtual]

Instruct the PBX to hold a call.

Parameters:
callToHold The ConnectionID of the call to be held.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo MakeCall ( string  callingDevice,
string  calledDevice 
) [virtual]

Instruct the PBX to place a call.

Parameters:
callingDevice Identifier (e.g., phone number) of the device making the call.
calledDevice Identifier (e.g., phone number) of the device being called.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo MonitorStart ( ConnectionID  callToMonitor  )  [virtual]

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

Parameters:
callToMonitor The call to monitor.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo MonitorStart ( string  deviceToMonitor  )  [virtual]

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

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

Reimplemented in VodiaSNOMOne.

virtual CSTAResponseInfo MonitorStop ( string  crossRefID  )  [virtual]

Stop a previously started PBX monitor request.

Parameters:
crossRefID The cross reference id of the monitor request as a MonitorCrossRefID object.
Returns:
A CSTAResponseInfo object.
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:
monitoredDevice The monitored device (e.g., extension).
Returns:
If no problems are encountered, the method returns a CSTAResponseInfo object containing the response from the PBX 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.
virtual CSTAResponseInfo RetrieveCall ( ConnectionID  callToRetrieve  )  [virtual]

Retrieves a held call.

Parameters:
callToRetrieve The ConnectionID of the call to retrieve.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo RingDevice ( string  targetDevice,
string  targetRinger,
long  ringPattern 
) [virtual]

Causes a telephony device to ring.

Parameters:
targetDevice The device to ring.
targetRinger The 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").
ringPattern The indicator of the ring pattern to use.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SendData ( IOCrossRefID  xref,
string  text 
) [virtual]

Sends a text message to a telephony device.

Parameters:
xref An IOCrossRefID object, most likely obtained by a previous call to StartDataPath.
text The text to send to the telephony device.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SetAgentState ( string  agentDevice,
ReqAgentState  agentState 
) [virtual]

Sets the state of an agent associated with a device.

Parameters:
agentDevice The device associated with the agent.
agentState The desired state for the agent.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SetAgentState ( string  agentDevice,
ReqAgentState  agentState,
string  agentID 
) [virtual]

Sets the state of an agent associated with a device.

Parameters:
agentDevice The device associated with the agent.
agentState The desired state for the agent.
agentID The agent id.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SetDisplay ( string  targetDevice,
string  text 
) [virtual]

Sends text to a telephony device's display

Parameters:
targetDevice The device to which the text is to be sent.
text The text to be sent.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SetDoNotDisturb ( string  targetDevice  )  [virtual]

Sets the Do Not Disturb feature for a phone.

Parameters:
targetDevice The device for which Do Not Disturb is to be set.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SetMessageWaiting ( string  targetDevice  )  [virtual]

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

Parameters:
targetDevice The device for which the indicator is to be turned on.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SingleStepTransfer ( ConnectionID  callToTransfer,
string  transferToDevice 
) [virtual]

Perform a single step transfer.

Parameters:
callToTransfer A ConnectionID object that identifies the call to be transferred.
transferToDevice The device (e.g., "101") to which the call is to be transferred.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SnapshotCall ( ConnectionID  callToSnapshot  )  [virtual]

Instruct the PBX to take a snapshot of a call.

Parameters:
callToSnapshot The ConnectionID of the call for which the snapshot is desired.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo SnapshotDevice ( string  deviceToSnapshot  )  [virtual]

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

Parameters:
deviceToSnapshot Identifier (e.g., phone number) of the device for which the snapshot is desired.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo StartDataPath ( string  targetDevice  )  [virtual]

Opens up a data path to a specified device.

Parameters:
targetDevice Specifies the device to which a data path is to be opened.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo StartSession ( string  applicationID  )  [virtual]

Establish a session with the PBX.

Parameters:
applicationID A free text string to identify the application.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo StartSession (  )  [virtual]

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

Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo StopDataPath ( IOCrossRefID  xref  )  [virtual]

Stops a previously established data path

Parameters:
xref An IOCrossRefID object, most likely obtained from a previous call to StartDataPath.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo StopRing ( string  targetDevice,
string  targetRinger,
long  ringPattern 
) [virtual]

Stops a ringer on a telephony device.

Parameters:
targetDevice The device for which the ringer is to stop.
targetRinger The 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").
ringPattern The indicator of the ring pattern to stop.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo StopSession (  )  [virtual]

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

Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo TransferCall ( ConnectionID  initiatedCall,
ConnectionID  originalCall 
) [virtual]

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

Parameters:
initiatedCall ConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResponse_ELEM class, for example, contains this ConnectionID.
originalCall ConnectionID 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.

Property Documentation

PBXSession SessionObject [get]

The PBXSession object associated with this instance.

CSTAContext ThreadContext [get]

The CSTAContext structure for this thread.