CSTAResponseInfo Class Reference

Properties
byte []	ResponseFromPBX [get, set]
List< byte[]>	ResponsesFromPBX [get, set]
List< byte[]>	ResponsesFromUA [get, set]
int	StatusCode [get, set]
string	StatusMessage [get, set]
string	XMLResponseFromPBX [get, set]
string	XMLResponseFromUA [get, set]
List< string >	XMLResponsesFromPBX [get, set]

Detailed Description

Contains information about a PBX operation that was attempted.

Property Documentation

ResponseFromPBX

byte [] ResponseFromPBX

getset

Contains the response from the PBX for messages that generate a single atomic response, or the immediate acknowledgement response for messages that generate multiple data responses (e.g., Get Switching Function Devices). If a message that normally generates multiple response segments encounters an error (e.g., the PBX rejects the message), then the single error message returned by the PBX will be in this property; the ResponsesFromPBX property will be null.

For CSTA operations this property is simply a reference to the ResponseFromPBX property of the thread's CSTAContext object. If the value of that property changes, then the value of this property changes.

ResponsesFromPBX

List<byte[]> ResponsesFromPBX

getset

Contains the responses from the PBX for messages that generate multiple response segments (e.g., Get Switching Function Devices). If such a message encounters an error (e.g., the PBX rejects the message), then the single error message returned by the PBX will be in the ResponseFromPBX property; this property will be null. In all cases the first response, which is the acknowledgement message from the PBX, will be in the ResponseFromPBX property.

This property is simply a reference to the ResponsesFromPBX property of the thread's CSTAContext object. If the value of that property changes, then the value of this property changes.

ResponsesFromUA

List<byte[]> ResponsesFromUA

getset

Contains the responses from the UA for messages that generate multiple response segments (e.g., Get Switching Function Devices). If such a message encounters an error (e.g., the UA rejects the message), then the single error message returned by the UA will be in the ResponseFromUA property; this property will be null. In all cases the first response, which is the acknowledgement message from the UA, will be in the ResponseFromUA property.

This property is simply a reference to the ResponsesFromPBX property of the thread's CSTAContext object. If the value of that property changes, then the value of this property changes.

StatusCode

int StatusCode

getset

A numeric status code. A value less than zero indicates that something went wrong during the attempted operation.

Referenced by GenericXMLed4.AcceptCall(), GenericXMLed4.AnswerCall(), GenericXMLed4.ClearConnection(), GenericXMLed4.ClearDoNotDisturb(), GenericXMLed4.ClearForwarding(), GenericXMLed4.ClearMessageWaiting(), GenericXMLed4.ConferenceCall(), GenericXMLed4.ConsultationCall(), GenericXMLed4.EncodeRequestSystemStatus(), GenericXMLed4.EncodeSetOrClearFwdRequest(), GenericXMLed4.EncodeStartSession(), GenericXMLed4.GetAgentState(), GenericXMLed4.GetDoNotDisturb(), GenericXMLed4.GetLogicalDevInfo(), GenericXMLed4.GetPhysicalDevInfo(), GenericXMLed4.GetSFDevices(), GenericXMLed4.HoldCall(), uaXMLed4.Invite(), GenericXMLed4.MakeCall(), GenericXMLed4.MonitorStart(), GenericXMLed4.MonitorStop(), GenericXMLed4.MonitorStopAtDevice(), GenericXMLed4.RequestSystemStatus(), GenericXMLed4.RetrieveCall(), GenericXMLed4.RingDevice(), GenericXMLed4.SendData(), GenericXMLed4.SendStoredCDR(), GenericXMLed4.SetAgentState(), GenericXMLed4.SetDisplay(), GenericXMLed4.SetDoNotDisturb(), GenericXMLed4.SetForwarding(), GenericXMLed4.SetMessageWaiting(), GenericXMLed4.SingleStepTransfer(), GenericXMLed4.SnapshotCall(), GenericXMLed4.SnapshotDevice(), GenericXMLed4.StartCDRTransmission(), GenericXMLed4.StartDataPath(), GenericXMLed4.StartSession(), GenericXMLed4.StopCDRTransmission(), GenericXMLed4.StopDataPath(), GenericXMLed4.StopRing(), GenericXMLed4.StopSession(), GenericXMLed4.TransferCall(), and UnifyOpenscapeVoice.UnifyOpenscapeVoice().

StatusMessage

string StatusMessage

getset

Text containing information about a PBX operation that has completed, either successfully or not.

Referenced by GenericXMLed4.AcceptCall(), GenericXMLed4.AnswerCall(), GenericXMLed4.ClearConnection(), GenericXMLed4.ClearDoNotDisturb(), GenericXMLed4.ClearForwarding(), GenericXMLed4.ClearMessageWaiting(), GenericXMLed4.ConferenceCall(), GenericXMLed4.ConsultationCall(), GenericXMLed4.EncodeAcceptCall(), GenericXMLed4.EncodeAnswerCall(), GenericXMLed4.EncodeClearConnection(), GenericXMLed4.EncodeConferenceCall(), GenericXMLed4.EncodeConsultationCall(), GenericXMLed4.EncodeGetAgentState(), GenericXMLed4.EncodeGetDND(), GenericXMLed4.EncodeGetLogicalDevInfo(), GenericXMLed4.EncodeGetPhysicalDevInfo(), GenericXMLed4.EncodeGetSFDevices(), GenericXMLed4.EncodeHoldCall(), GenericXMLed4.EncodeMakeCall(), GenericXMLed4.EncodeMonitorStart(), GenericXMLed4.EncodeMonitorStop(), GenericXMLed4.EncodeRequestSystemStatus(), GenericXMLed4.EncodeRetrieveCall(), GenericXMLed4.EncodeSendData(), GenericXMLed4.EncodeSendStoredCDR(), GenericXMLed4.EncodeSetAgentState(), GenericXMLed4.EncodeSetDisplay(), GenericXMLed4.EncodeSetDND(), GenericXMLed4.EncodeSetMsgWaiting(), GenericXMLed4.EncodeSetOrClearFwdRequest(), GenericXMLed4.EncodeSetRingerStatus(), GenericXMLed4.EncodeSingleStepTransfer(), GenericXMLed4.EncodeSnapshotCall(), GenericXMLed4.EncodeSnapshotDevice(), GenericXMLed4.EncodeStartCDRTrans(), GenericXMLed4.EncodeStartDataPath(), GenericXMLed4.EncodeStartSession(), GenericXMLed4.EncodeStopCDRTrans(), GenericXMLed4.EncodeStopDataPath(), GenericXMLed4.EncodeStopSession(), GenericXMLed4.EncodeTransferCall(), GenericXMLed4.GetAgentState(), GenericXMLed4.GetDoNotDisturb(), GenericXMLed4.GetLogicalDevInfo(), GenericXMLed4.GetPhysicalDevInfo(), GenericXMLed4.GetSFDevices(), GenericXMLed4.HoldCall(), uaXMLed4.Invite(), GenericXMLed4.MakeCall(), GenericXMLed4.MonitorStart(), GenericXMLed4.MonitorStop(), GenericXMLed4.MonitorStopAtDevice(), GenericXMLed4.RequestSystemStatus(), GenericXMLed4.RetrieveCall(), GenericXMLed4.RingDevice(), GenericXMLed4.SendData(), GenericXMLed4.SendStoredCDR(), GenericXMLed4.SetAgentState(), GenericXMLed4.SetDisplay(), GenericXMLed4.SetDoNotDisturb(), GenericXMLed4.SetForwarding(), GenericXMLed4.SetMessageWaiting(), GenericXMLed4.SingleStepTransfer(), GenericXMLed4.SnapshotCall(), GenericXMLed4.SnapshotDevice(), GenericXMLed4.StartCDRTransmission(), GenericXMLed4.StartDataPath(), GenericXMLed4.StartSession(), GenericXMLed4.StopCDRTransmission(), GenericXMLed4.StopDataPath(), GenericXMLed4.StopRing(), GenericXMLed4.StopSession(), GenericXMLed4.TransferCall(), and UnifyOpenscapeVoice.UnifyOpenscapeVoice().

XMLResponseFromPBX

string XMLResponseFromPBX

getset

Contains the response from the PBX for messages that generate a single atomic XML response, or the immediate XML acknowledgement response for messages that generate multiple XML data responses (e.g., GetSwitchingFunctionDevices). If a message that normally generates multiple response segments encounters an error (e.g., the PBX rejects the message), then the single error message returned by the PBX will be in this property; the ResponsesFromPBX property will be null.

For CSTA operations this property is simply a reference to the XMLResponseFromPBX property of the thread's CSTAContext object. If the value of that property changes, then the value of this property changes.

Referenced by GenericXMLed4.AcceptCall(), GenericXMLed4.AnswerCall(), GenericXMLed4.ClearConnection(), GenericXMLed4.ClearDoNotDisturb(), GenericXMLed4.ClearForwarding(), GenericXMLed4.ClearMessageWaiting(), GenericXMLed4.ConferenceCall(), GenericXMLed4.ConsultationCall(), GenericXMLed4.EncodeSetOrClearFwdRequest(), GenericXMLed4.GetAgentState(), GenericXMLed4.GetDoNotDisturb(), GenericXMLed4.GetLogicalDevInfo(), GenericXMLed4.GetPhysicalDevInfo(), GenericXMLed4.GetSFDevices(), GenericXMLed4.HoldCall(), uaXMLed4.Invite(), GenericXMLed4.MakeCall(), GenericXMLed4.MonitorStart(), GenericXMLed4.MonitorStop(), GenericXMLed4.RequestSystemStatus(), GenericXMLed4.RetrieveCall(), GenericXMLed4.RingDevice(), GenericXMLed4.SendData(), GenericXMLed4.SendStoredCDR(), GenericXMLed4.SetAgentState(), GenericXMLed4.SetDisplay(), GenericXMLed4.SetDoNotDisturb(), GenericXMLed4.SetForwarding(), GenericXMLed4.SetMessageWaiting(), GenericXMLed4.SingleStepTransfer(), GenericXMLed4.SnapshotCall(), GenericXMLed4.SnapshotDevice(), GenericXMLed4.StartCDRTransmission(), GenericXMLed4.StartDataPath(), GenericXMLed4.StartSession(), GenericXMLed4.StopCDRTransmission(), GenericXMLed4.StopDataPath(), GenericXMLed4.StopRing(), GenericXMLed4.StopSession(), GenericXMLed4.TransferCall(), and UnifyOpenscapeVoice.UnifyOpenscapeVoice().

XMLResponseFromUA

string XMLResponseFromUA

getset

Contains the response from the UA for messages that generate a single atomic XML response, or the immediate XML acknowledgement response for messages that generate multiple XML data responses (e.g., GetSwitchingFunctionDevices). If a message that normally generates multiple response segments encounters an error (e.g., the UA rejects the message), then the single error message returned by the UA will be in this property; the ResponsesFromUA property will be null.

For CSTA operations this property is simply a reference to the XMLResponseFromPBX property of the thread's CSTAContext object. If the value of that property changes, then the value of this property changes.

XMLResponsesFromPBX

List<string> XMLResponsesFromPBX

getset

Contains the responses from the PBX for messages that generate multiple XML response segments (e.g., GetSwitchingFunctionDevices). If such a message encounters an error (e.g., the PBX rejects the message), then the single error message returned by the PBX will be in the ResponseFromPBX property; this property will be null. In all cases the first response, which is the acknowledgement message from the PBX, will be in the ResponseFromPBX property.

This property is simply a reference to the XMLResponsesFromPBX property of the thread's CSTAContext object. If the value of that property changes, then the value of this property changes.

Referenced by GenericXMLed4.GetSFDevices(), GenericXMLed4.SnapshotCall(), and GenericXMLed4.SnapshotDevice().