CookieRequestCultureProvider Class

Determines the culture information for a request via the value of a cookie.

Namespace
Microsoft.AspNetCore.Localization
Assemblies
  • Microsoft.AspNetCore.Localization

Syntax

public class CookieRequestCultureProvider : RequestCultureProvider, IRequestCultureProvider
class Microsoft.AspNetCore.Localization.CookieRequestCultureProvider

Methods

DetermineProviderCultureResult(Microsoft.AspNetCore.Http.HttpContext)
Return type:System.Threading.Tasks.Task<Microsoft.AspNetCore.Localization.ProviderCultureResult> 
public override Task<ProviderCultureResult> DetermineProviderCultureResult(HttpContext httpContext)
MakeCookieValue(Microsoft.AspNetCore.Localization.RequestCulture)

Creates a string representation of a Microsoft.AspNetCore.Localization.RequestCulture for placement in a cookie.

Arguments:requestCulture (Microsoft.AspNetCore.Localization.RequestCulture) – The Microsoft.AspNetCore.Localization.RequestCulture.
Return type:System.String
Returns:The cookie value. 
public static string MakeCookieValue(RequestCulture requestCulture)
ParseCookieValue(System.String)

Parses a Microsoft.AspNetCore.Localization.RequestCulture from the specified cookie value. Returns <code>null</code> if parsing fails.

Arguments:value (System.String) – The cookie value to parse.
Return type:Microsoft.AspNetCore.Localization.ProviderCultureResult
Returns:The Microsoft.AspNetCore.Localization.RequestCulture or <code>null</code> if parsing fails. 
public static ProviderCultureResult ParseCookieValue(string value)

Properties

Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.CookieName

The name of the cookie that contains the user’s preferred culture information. Defaults to Microsoft.AspNetCore.Localization.CookieRequestCultureProvider.DefaultCookieName.

Return type:System.String 
public string CookieName { get; set; }

Fields

DefaultCookieName()

Represent the default cookie name used to track the user’s preferred culture information, which is ”.AspNetCore.Culture”.

Return type:System.String 
public static readonly string DefaultCookieName