ResponseCollection
ResponseCollection
The ResponseCollection class defines an enumerable, read-only collection of Response Sip Class objects.
This collection object is referenced by calls to Transaction.Responses (generated upon receipt of requests from a client transaction) or ClientTransaction.Responses (received from a server transaction).
This class implements the IEnumerable and ICollection interfaces.
The ResponseCollection class is derived from the System.Object class.
Public Methods
The ResponseCollection class has the following public methods.
Method |
Description |
|---|---|
Determines whether the specific Response object exists in the collection. |
|
Copies the entire ResponseCollection to a compatible one-dimensional array, starting at the specified index of the target array. |
|
Inherited from System.Object. Determines whether the specified System.Object is equal to the current System.Object. |
|
Obtains an enumerator for the ResponseCollection object. |
|
GetHashCode() |
Inherited from System.Object. Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
GetType() |
Inherited from System.Object. Gets the System.Type of the current instance. |
Returns the index of a specified Response object within the collection. |
|
ToString() |
Inherited from System.Object. Returns a System.String that represents the current System.Object. |
Public Properties
The ResponseCollection class has the following public properties.
Property |
Description |
|---|---|
Data type: Int32 Access type: Read-only Contains the total number of Response objects in the collection. |
|
Data type: Boolean Access type: Read-only Indicates whether the collection has a fixed size. |
|
Data type: Boolean Access type: Read-only Indicates whether the collection is read-only. |
|
Data type: Boolean Access type: Read-only Indicates whether access to the collection is synchronized. |
|
Data type: Response Access type: Read/write Contains the Response element at the specified index. In C#, this property is the indexer for the ResponseCollection class. |
|
Data type: Object Access type: Read-only Contains an object used to synchronize access to the collection. This implementation always returns the current instance of the ResponseCollection object. |
Remarks
Some transactions contain more than one response message if the response is of the Class 1 Provisional (1xx) status class. Note that this set includes only those responses that matched message processing rules in the SIP Application Manifests (Lync Server 2010 SDK) and were dispatched to the application. If the application was never notified of a response, this collection will not contain it. This implies that applications should not poll this collection to see if any new responses came in.
Requirements
Redistributable: Requires Microsoft Lync Server 2010
Namespace:Microsoft.Rtc.Sip
Assembly: ServerAgent (in ServerAgent.dll)