/
RedirectingEventArgs.xml
198 lines (198 loc) · 12.1 KB
/
RedirectingEventArgs.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
<Type Name="RedirectingEventArgs" FullName="Microsoft.Rtc.Signaling.RedirectingEventArgs">
<TypeSignature Language="C#" Value="public abstract class RedirectingEventArgs : Microsoft.Rtc.Signaling.SipResponseReceivedEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit RedirectingEventArgs extends Microsoft.Rtc.Signaling.SipResponseReceivedEventArgs" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Signaling.RedirectingEventArgs" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class RedirectingEventArgs
Inherits SipResponseReceivedEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class RedirectingEventArgs abstract : Microsoft::Rtc::Signaling::SipResponseReceivedEventArgs" />
<TypeSignature Language="F#" Value="type RedirectingEventArgs = class
 inherit SipResponseReceivedEventArgs" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Rtc.Signaling.SipResponseReceivedEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Exposes the redirect target URI and lets the application try the URI
depending upon the State property.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Action">
<MemberSignature Language="C#" Value="public abstract Microsoft.Rtc.Signaling.RedirectAction Action { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Signaling.RedirectAction Action" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Signaling.RedirectingEventArgs.Action" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Property Action As RedirectAction" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property Microsoft::Rtc::Signaling::RedirectAction Action { Microsoft::Rtc::Signaling::RedirectAction get(); void set(Microsoft::Rtc::Signaling::RedirectAction value); };" />
<MemberSignature Language="F#" Value="member this.Action : Microsoft.Rtc.Signaling.RedirectAction with get, set" Usage="Microsoft.Rtc.Signaling.RedirectingEventArgs.Action" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Signaling.RedirectAction</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Action associated with the current redirect.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentTarget">
<MemberSignature Language="C#" Value="public abstract Microsoft.Rtc.Signaling.RealTimeAddress CurrentTarget { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Rtc.Signaling.RealTimeAddress CurrentTarget" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Signaling.RedirectingEventArgs.CurrentTarget" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property CurrentTarget As RealTimeAddress" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property Microsoft::Rtc::Signaling::RealTimeAddress ^ CurrentTarget { Microsoft::Rtc::Signaling::RealTimeAddress ^ get(); };" />
<MemberSignature Language="F#" Value="member this.CurrentTarget : Microsoft.Rtc.Signaling.RealTimeAddress" Usage="Microsoft.Rtc.Signaling.RedirectingEventArgs.CurrentTarget" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Signaling.RealTimeAddress</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the address of the current redirect. Can be null if there is no current target.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableAutomaticRedirection">
<MemberSignature Language="C#" Value="public bool DisableAutomaticRedirection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DisableAutomaticRedirection" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Signaling.RedirectingEventArgs.DisableAutomaticRedirection" />
<MemberSignature Language="VB.NET" Value="Public Property DisableAutomaticRedirection As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool DisableAutomaticRedirection { bool get(); void set(bool value); };" />
<MemberSignature Language="F#" Value="member this.DisableAutomaticRedirection : bool with get, set" Usage="Microsoft.Rtc.Signaling.RedirectingEventArgs.DisableAutomaticRedirection" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the value indicating whether the application wants the disable
automatic redirection based on the redirect action set in this event arg
after returning from the redirect callback handler of the application.
If disabled, the application takes the responsibility to store this
event arg, set the redirect action later, and call ResumeRedirection.
Failure to do so will result in the pending Particpate method hanging.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Headers">
<MemberSignature Language="C#" Value="public abstract System.Collections.ObjectModel.Collection<Microsoft.Rtc.Signaling.SignalingHeader> Headers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class Microsoft.Rtc.Signaling.SignalingHeader> Headers" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Signaling.RedirectingEventArgs.Headers" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Headers As Collection(Of SignalingHeader)" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property System::Collections::ObjectModel::Collection<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ Headers { System::Collections::ObjectModel::Collection<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Headers : System.Collections.ObjectModel.Collection<Microsoft.Rtc.Signaling.SignalingHeader>" Usage="Microsoft.Rtc.Signaling.RedirectingEventArgs.Headers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<Microsoft.Rtc.Signaling.SignalingHeader></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the list of headers to add to the next set of targets.
</summary>
<value>To be added.</value>
<remarks>
<para>
The list of headers can be modified for the next targets that will be tried.
The headers will be applied to the INVITE request.
</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="PreviousException">
<MemberSignature Language="C#" Value="public Exception PreviousException { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Exception PreviousException" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Signaling.RedirectingEventArgs.PreviousException" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PreviousException As Exception" />
<MemberSignature Language="C++ CLI" Value="public:
 property Exception ^ PreviousException { Exception ^ get(); };" />
<MemberSignature Language="F#" Value="member this.PreviousException : Exception" Usage="Microsoft.Rtc.Signaling.RedirectingEventArgs.PreviousException" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Exception</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the previous exception, if any.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResumeRedirection">
<MemberSignature Language="C#" Value="public void ResumeRedirection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResumeRedirection() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Signaling.RedirectingEventArgs.ResumeRedirection" />
<MemberSignature Language="VB.NET" Value="Public Sub ResumeRedirection ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void ResumeRedirection();" />
<MemberSignature Language="F#" Value="member this.ResumeRedirection : unit -> unit" Usage="redirectingEventArgs.ResumeRedirection " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Resumes redirection work if it was delayed originally. This method can be called only once
per redirect event raised.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Targets">
<MemberSignature Language="C#" Value="public abstract System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Rtc.Signaling.RealTimeAddress> Targets { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class Microsoft.Rtc.Signaling.RealTimeAddress> Targets" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Signaling.RedirectingEventArgs.Targets" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Targets As ReadOnlyCollection(Of RealTimeAddress)" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract property System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::Rtc::Signaling::RealTimeAddress ^> ^ Targets { System::Collections::ObjectModel::ReadOnlyCollection<Microsoft::Rtc::Signaling::RealTimeAddress ^> ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Targets : System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Rtc.Signaling.RealTimeAddress>" Usage="Microsoft.Rtc.Signaling.RedirectingEventArgs.Targets" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Rtc.Signaling.RealTimeAddress></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the address of the all the redirects.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>