ITicketStore.RetrieveAsync Method

Definition

Namespace:

Microsoft.AspNetCore.Authentication.Cookies

Assembly:

Microsoft.AspNetCore.Authentication.Cookies.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Overloads

RetrieveAsync(String)	Retrieves an identity from the store for the given key.
RetrieveAsync(String, CancellationToken)	Retrieves an identity from the store for the given key.
RetrieveAsync(String, HttpContext, CancellationToken)	Retrieves an identity from the store for the given key.

RetrieveAsync(String)

Retrieves an identity from the store for the given key.

public:
 System::Threading::Tasks::Task<Microsoft::AspNetCore::Authentication::AuthenticationTicket ^> ^ RetrieveAsync(System::String ^ key);

public System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket?> RetrieveAsync (string key);

abstract member RetrieveAsync : string -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket>

Public Function RetrieveAsync (key As String) As Task(Of AuthenticationTicket)

Parameters

key

String

The key associated with the identity.

Returns

Task<AuthenticationTicket>

The identity associated with the given key, or null if not found.

RetrieveAsync(String, CancellationToken)

Retrieves an identity from the store for the given key.

public virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket?> RetrieveAsync (string key, System.Threading.CancellationToken cancellationToken);

abstract member RetrieveAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket>
override this.RetrieveAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket>

Public Overridable Function RetrieveAsync (key As String, cancellationToken As CancellationToken) As Task(Of AuthenticationTicket)

Parameters

key

String

The key associated with the identity.

cancellationToken

CancellationToken

The CancellationToken used to propagate notifications that the operation should be canceled.

Returns

Task<AuthenticationTicket>

The identity associated with the given key, or null if not found.

RetrieveAsync(String, HttpContext, CancellationToken)

Retrieves an identity from the store for the given key.

public virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket?> RetrieveAsync (string key, Microsoft.AspNetCore.Http.HttpContext httpContext, System.Threading.CancellationToken cancellationToken);

abstract member RetrieveAsync : string * Microsoft.AspNetCore.Http.HttpContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket>
override this.RetrieveAsync : string * Microsoft.AspNetCore.Http.HttpContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Authentication.AuthenticationTicket>

Public Overridable Function RetrieveAsync (key As String, httpContext As HttpContext, cancellationToken As CancellationToken) As Task(Of AuthenticationTicket)

Parameters

key

String

The key associated with the identity.

httpContext

HttpContext

The HttpContext associated with the current request.

cancellationToken

CancellationToken

The CancellationToken used to propagate notifications that the operation should be canceled.

Returns

Task<AuthenticationTicket>

The identity associated with the given key, or null if not found.