AuthenticationHandler<TOptions>.InitializeAsync Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.dll
Package:
Microsoft.AspNetCore.Authentication v2.0.0
Package:
Microsoft.AspNetCore.Authentication v2.1.0
Package:
Microsoft.AspNetCore.Authentication v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.Authentication v1.0.0
Package:
Microsoft.AspNetCore.Authentication v1.1.0

Overloads

InitializeAsync(AuthenticationScheme, HttpContext)

Initialize the handler, resolve the options and validate them.
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

Initialize is called once per request to contextualize this instance with appropriate state.

InitializeAsync(AuthenticationScheme, HttpContext)

Source:
AuthenticationHandler.cs
Source:
AuthenticationHandler.cs

Initialize the handler, resolve the options and validate them.

public:
 virtual System::Threading::Tasks::Task ^ InitializeAsync(Microsoft::AspNetCore::Authentication::AuthenticationScheme ^ scheme, Microsoft::AspNetCore::Http::HttpContext ^ context);
public System.Threading.Tasks.Task InitializeAsync (Microsoft.AspNetCore.Authentication.AuthenticationScheme scheme, Microsoft.AspNetCore.Http.HttpContext context);
abstract member InitializeAsync : Microsoft.AspNetCore.Authentication.AuthenticationScheme * Microsoft.AspNetCore.Http.HttpContext -> System.Threading.Tasks.Task
override this.InitializeAsync : Microsoft.AspNetCore.Authentication.AuthenticationScheme * Microsoft.AspNetCore.Http.HttpContext -> System.Threading.Tasks.Task
Public Function InitializeAsync (scheme As AuthenticationScheme, context As HttpContext) As Task

Parameters

scheme
AuthenticationScheme
context
HttpContext

Returns

Task

Implements

InitializeAsync(AuthenticationScheme, HttpContext)

Applies to

InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)

Initialize is called once per request to contextualize this instance with appropriate state.

public:
 System::Threading::Tasks::Task ^ InitializeAsync(TOptions options, Microsoft::AspNetCore::Http::HttpContext ^ context, Microsoft::Extensions::Logging::ILogger ^ logger, System::Text::Encodings::Web::UrlEncoder ^ encoder);
public System.Threading.Tasks.Task InitializeAsync (TOptions options, Microsoft.AspNetCore.Http.HttpContext context, Microsoft.Extensions.Logging.ILogger logger, System.Text.Encodings.Web.UrlEncoder encoder);
member this.InitializeAsync : 'Options * Microsoft.AspNetCore.Http.HttpContext * Microsoft.Extensions.Logging.ILogger * System.Text.Encodings.Web.UrlEncoder -> System.Threading.Tasks.Task
Public Function InitializeAsync (options As TOptions, context As HttpContext, logger As ILogger, encoder As UrlEncoder) As Task

Parameters

options
TOptions

The original options passed by the application control behavior

context
HttpContext

The utility object to observe the current request and response

logger
ILogger

The logging factory used to create loggers

encoder
UrlEncoder

The UrlEncoder.

Returns

Task

async completion

Applies to