CSTAResponseInfo Class Reference

List of all members.

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

byte [] ResponseFromPBX [get, set]

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.

List<byte[]> ResponsesFromPBX [get, set]

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.

List<byte[]> ResponsesFromUA [get, set]

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.

int StatusCode [get, set]

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

string StatusMessage [get, set]

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

string XMLResponseFromPBX [get, set]

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.

string XMLResponseFromUA [get, set]

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.

List<string> XMLResponsesFromPBX [get, set]

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.