-
Notifications
You must be signed in to change notification settings - Fork 24
/
ConferenceCommandResponse.xml
248 lines (248 loc) · 14.9 KB
/
ConferenceCommandResponse.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<Type Name="ConferenceCommandResponse" FullName="Microsoft.Rtc.Collaboration.ConferenceCommandResponse">
<TypeSignature Language="C#" Value="public abstract class ConferenceCommandResponse" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ConferenceCommandResponse extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.ConferenceCommandResponse" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ConferenceCommandResponse" />
<TypeSignature Language="C++ CLI" Value="public ref class ConferenceCommandResponse abstract" />
<TypeSignature Language="F#" Value="type ConferenceCommandResponse = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains basic information about a completed command.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ConferenceCommandResponse ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ConferenceCommandResponse();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Constructs the object.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Diagnostics">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,string> Diagnostics { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, string> Diagnostics" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.Diagnostics" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Diagnostics As IDictionary(Of String, String)" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ Diagnostics { System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Diagnostics : System.Collections.Generic.IDictionary<string, string>" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandResponse.Diagnostics" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the diagnostics information from the response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayString">
<MemberSignature Language="C#" Value="public string DisplayString { get; protected set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayString" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.DisplayString" />
<MemberSignature Language="VB.NET" Value="Public Property DisplayString As String" />
<MemberSignature Language="C++ CLI" Value="public: property System::String ^ DisplayString { public:
System::String ^ get(); protected:
 void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.DisplayString : string with get, set" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandResponse.DisplayString" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the display string from the response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GeneralReason">
<MemberSignature Language="C#" Value="public string GeneralReason { get; protected set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string GeneralReason" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.GeneralReason" />
<MemberSignature Language="VB.NET" Value="Public Property GeneralReason As String" />
<MemberSignature Language="C++ CLI" Value="public: property System::String ^ GeneralReason { public:
System::String ^ get(); protected:
 void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.GeneralReason : string with get, set" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandResponse.GeneralReason" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the general reason for failure, if available.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageData">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Signaling.SipMessageData MessageData { get; protected set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Rtc.Signaling.SipMessageData MessageData" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.MessageData" />
<MemberSignature Language="VB.NET" Value="Public Property MessageData As SipMessageData" />
<MemberSignature Language="C++ CLI" Value="public: property Microsoft::Rtc::Signaling::SipMessageData ^ MessageData { public:
Microsoft::Rtc::Signaling::SipMessageData ^ get(); protected:
 void set(Microsoft::Rtc::Signaling::SipMessageData ^ value); };" />
<MemberSignature Language="F#" Value="member this.MessageData : Microsoft.Rtc.Signaling.SipMessageData with get, set" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandResponse.MessageData" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Signaling.SipMessageData</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the message that completed the response.
</summary>
<value>To be added.</value>
<remarks>
<para>
The message could either be an INFO request or a 200 OK response.
</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Reason">
<MemberSignature Language="C#" Value="public string Reason { get; protected set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Reason" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.Reason" />
<MemberSignature Language="VB.NET" Value="Public Property Reason As String" />
<MemberSignature Language="C++ CLI" Value="public: property System::String ^ Reason { public:
System::String ^ get(); protected:
 void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.Reason : string with get, set" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandResponse.Reason" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get the specific reason for failure, if available.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetDiagnostics">
<MemberSignature Language="C#" Value="protected void SetDiagnostics (System.Collections.Generic.IDictionary<string,string> diagnostics);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void SetDiagnostics(class System.Collections.Generic.IDictionary`2<string, string> diagnostics) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.SetDiagnostics(System.Collections.Generic.IDictionary{System.String,System.String})" />
<MemberSignature Language="VB.NET" Value="Protected Sub SetDiagnostics (diagnostics As IDictionary(Of String, String))" />
<MemberSignature Language="C++ CLI" Value="protected:
 void SetDiagnostics(System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ diagnostics);" />
<MemberSignature Language="F#" Value="member this.SetDiagnostics : System.Collections.Generic.IDictionary<string, string> -> unit" Usage="conferenceCommandResponse.SetDiagnostics diagnostics" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="diagnostics" Type="System.Collections.Generic.IDictionary<System.String,System.String>" />
</Parameters>
<Docs>
<param name="diagnostics">The diagnostic information key value pairs.</param>
<summary>
Sets the diagnostics information.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusCode">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.CommandStatusCode StatusCode { get; protected set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.CommandStatusCode StatusCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.StatusCode" />
<MemberSignature Language="VB.NET" Value="Public Property StatusCode As CommandStatusCode" />
<MemberSignature Language="C++ CLI" Value="public: property Microsoft::Rtc::Collaboration::CommandStatusCode StatusCode { public:
Microsoft::Rtc::Collaboration::CommandStatusCode get(); protected:
 void set(Microsoft::Rtc::Collaboration::CommandStatusCode value); };" />
<MemberSignature Language="F#" Value="member this.StatusCode : Microsoft.Rtc.Collaboration.CommandStatusCode with get, set" Usage="Microsoft.Rtc.Collaboration.ConferenceCommandResponse.StatusCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.CommandStatusCode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get the command status value from the response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryProcessResponseCore">
<MemberSignature Language="C#" Value="protected abstract bool TryProcessResponseCore (Microsoft.Rtc.Signaling.SipMessageData messageData, out Microsoft.Rtc.Signaling.RealTimeException exception);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool TryProcessResponseCore(class Microsoft.Rtc.Signaling.SipMessageData messageData, [out] class Microsoft.Rtc.Signaling.RealTimeException& exception) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.ConferenceCommandResponse.TryProcessResponseCore(Microsoft.Rtc.Signaling.SipMessageData,Microsoft.Rtc.Signaling.RealTimeException@)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function TryProcessResponseCore (messageData As SipMessageData, ByRef exception As RealTimeException) As Boolean" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract bool TryProcessResponseCore(Microsoft::Rtc::Signaling::SipMessageData ^ messageData, [Runtime::InteropServices::Out] Microsoft::Rtc::Signaling::RealTimeException ^ % exception);" />
<MemberSignature Language="F#" Value="abstract member TryProcessResponseCore : Microsoft.Rtc.Signaling.SipMessageData * -> bool" Usage="conferenceCommandResponse.TryProcessResponseCore (messageData, exception)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageData" Type="Microsoft.Rtc.Signaling.SipMessageData" />
<Parameter Name="exception" Type="Microsoft.Rtc.Signaling.RealTimeException" RefType="out" />
</Parameters>
<Docs>
<param name="messageData">The message that contains the result of the request.</param>
<param name="exception">Any exception encountered during processing</param>
<summary>
Process the response and populate the properties of the response object.
</summary>
<returns>True if processing was successful, otherwise false.</returns>
<remarks>
<para>
The message body contains the XML to process for the C3P response. The message itself may be
an INFO request with the final result ("success" or "pending") or may be a 200 OK response
to the INFO message making the initial request.
</para>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>