-
Notifications
You must be signed in to change notification settings - Fork 112
/
IAuthenticationHandler.xml
196 lines (196 loc) · 13.5 KB
/
IAuthenticationHandler.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
<Type Name="IAuthenticationHandler" FullName="Microsoft.AspNetCore.Authentication.IAuthenticationHandler">
<TypeSignature Language="C++ CLI" Value="public interface class IAuthenticationHandler" />
<TypeSignature Language="C#" Value="public interface IAuthenticationHandler" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IAuthenticationHandler" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Authentication.IAuthenticationHandler" />
<TypeSignature Language="VB.NET" Value="Public Interface IAuthenticationHandler" />
<TypeSignature Language="F#" Value="type IAuthenticationHandler = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IAuthenticationHandler" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Created per request to handle authentication for a particular scheme.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AuthenticateAsync">
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<Microsoft::AspNetCore::Authentication::AuthenticateResult ^> ^ AuthenticateAsync();" />
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticateResult> AuthenticateAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.AspNetCore.Authentication.AuthenticateResult> AuthenticateAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.AuthenticateAsync" />
<MemberSignature Language="VB.NET" Value="Public Function AuthenticateAsync () As Task(Of AuthenticateResult)" />
<MemberSignature Language="F#" Value="abstract member AuthenticateAsync : unit -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticateResult>" Usage="iAuthenticationHandler.AuthenticateAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticateResult></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Authenticate the current request.
</summary>
<returns>The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticateResult" /> result.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ChallengeAsync">
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task ^ ChallengeAsync(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);" />
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ChallengeAsync (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task ChallengeAsync(class Microsoft.AspNetCore.Authentication.AuthenticationProperties properties) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)" />
<MemberSignature Language="VB.NET" Value="Public Function ChallengeAsync (properties As AuthenticationProperties) As Task" />
<MemberSignature Language="F#" Value="abstract member ChallengeAsync : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task" Usage="iAuthenticationHandler.ChallengeAsync properties" />
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ChallengeAsync (Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties);" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="properties" Type="Microsoft.AspNetCore.Authentication.AuthenticationProperties">
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties" /> that contains the extra meta-data arriving with the authentication.</param>
<summary>
Challenge the current request.
</summary>
<returns>A task.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ForbidAsync">
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task ^ ForbidAsync(Microsoft::AspNetCore::Authentication::AuthenticationProperties ^ properties);" />
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ForbidAsync (Microsoft.AspNetCore.Authentication.AuthenticationProperties properties);" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task ForbidAsync(class Microsoft.AspNetCore.Authentication.AuthenticationProperties properties) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.ForbidAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)" />
<MemberSignature Language="VB.NET" Value="Public Function ForbidAsync (properties As AuthenticationProperties) As Task" />
<MemberSignature Language="F#" Value="abstract member ForbidAsync : Microsoft.AspNetCore.Authentication.AuthenticationProperties -> System.Threading.Tasks.Task" Usage="iAuthenticationHandler.ForbidAsync properties" />
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ForbidAsync (Microsoft.AspNetCore.Authentication.AuthenticationProperties? properties);" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="properties" Type="Microsoft.AspNetCore.Authentication.AuthenticationProperties">
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="properties">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties" /> that contains the extra meta-data arriving with the authentication.</param>
<summary>
Forbid the current request.
</summary>
<returns>A task.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InitializeAsync">
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task ^ InitializeAsync(Microsoft::AspNetCore::Authentication::AuthenticationScheme ^ scheme, Microsoft::AspNetCore::Http::HttpContext ^ context);" />
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task InitializeAsync (Microsoft.AspNetCore.Authentication.AuthenticationScheme scheme, Microsoft.AspNetCore.Http.HttpContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task InitializeAsync(class Microsoft.AspNetCore.Authentication.AuthenticationScheme scheme, class Microsoft.AspNetCore.Http.HttpContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Authentication.IAuthenticationHandler.InitializeAsync(Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Http.HttpContext)" />
<MemberSignature Language="VB.NET" Value="Public Function InitializeAsync (scheme As AuthenticationScheme, context As HttpContext) As Task" />
<MemberSignature Language="F#" Value="abstract member InitializeAsync : Microsoft.AspNetCore.Authentication.AuthenticationScheme * Microsoft.AspNetCore.Http.HttpContext -> System.Threading.Tasks.Task" Usage="iAuthenticationHandler.InitializeAsync (scheme, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.Abstractions</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scheme" Type="Microsoft.AspNetCore.Authentication.AuthenticationScheme" />
<Parameter Name="context" Type="Microsoft.AspNetCore.Http.HttpContext" />
</Parameters>
<Docs>
<param name="scheme">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationScheme" /> scheme.</param>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.HttpContext" /> context for the current request.</param>
<summary>
Initialize the authentication handler. The handler should initialize anything it needs from the request and scheme as part of this method.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>