Class CookieHelper

Namespace

CMS.Helpers

Assembly

CMS.Helpers.dll

Provides the cookie management methods.

[Obsolete("Will be removed in a later version. Superseded by Kentico.Web.Mvc.ICookieAccessor for working with cookies.")]
[ObsoleteSince(27, 0)]
public class CookieHelper : AbstractHelper<CookieHelper>

Inheritance

object

CoreMethods

AbstractHelper

AbstractHelper<CookieHelper>

CookieHelper

Inherited Members

AbstractHelper<CookieHelper>.HelperObject

AbstractHelper<CookieHelper>.SetAsDefaultHelper()

CoreMethods.GetString(string, string)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

AllowCookies

If true, the cookies are allowed to be used.

public static bool AllowCookies { get; }

Property Value

bool

Methods

ConvertCookieLevelToIntegerValue(string, int)

Gets the cookie level from a string value

public static int ConvertCookieLevelToIntegerValue(string value, int defaultValue)

Parameters

value string

Level value, number or string representation

defaultValue int

Default value

Returns

int

GetCookieLevelInternal(string)

Gets the cookie level for the given cookie

protected virtual int GetCookieLevelInternal(string cookieName)

Parameters

cookieName string

Cookie name

Returns

int

GetExistingCookie(string)

Returns the existing cookie.

public static IHttpCookie GetExistingCookie(string cookieName)

Parameters

cookieName string

Cookie name

Returns

IHttpCookie

GetValue(string)

Returns the given cookie value.

public static string GetValue(string name)

Parameters

name string

Cookie name to retrieve

Returns

string

GetValue(string, bool)

Returns the given cookie value.

public static string GetValue(string name, bool allowSensitiveData)

Parameters

name string

Cookie name to retrieve

allowSensitiveData bool

Allows retrieving data from sensitive authentication cookies

Returns

string

GetValueInternal(string, bool)

Returns the given cookie value.

protected virtual string GetValueInternal(string name, bool allowSensitiveData)

Parameters

name string

Cookie name to retrieve

allowSensitiveData bool

Allows retrieving data from sensitive authentication cookies.

Returns

string

IsCookieAllowed(string)

Returns true if the cookie is allowed based on current cookie level

public static bool IsCookieAllowed(string name)

Parameters

name string

Cookie name

Returns

bool

IsCookieAllowedInternal(string)

Returns true if the cookie is allowed based on current cookie level

protected virtual bool IsCookieAllowedInternal(string name)

Parameters

name string

Cookie name

Returns

bool

RegisterCookie(string, int, bool)

Registers the given cookie within the system.

public static void RegisterCookie(string name, int level, bool isSensitive = false)

Parameters

name string

Cookie name

level int

Cookie level

isSensitive bool

Cookie sensitivity

Remove(string)

Removes the cookie from the client side.

public static void Remove(string name)

Parameters

name string

Cookie name to remove

RemoveAllCookies(int)

Removes all the user cookies above given level

public static void RemoveAllCookies(int aboveLevel)

Parameters

aboveLevel int

Level above which the cookies should be removed

RemoveAllCookiesInternal(int)

Removes all the user cookies

protected virtual void RemoveAllCookiesInternal(int aboveLevel)

Parameters

aboveLevel int

Level above which the cookies should be removed

RemoveInternal(string)

Removes the cookie from the client side.

protected virtual void RemoveInternal(string name)

Parameters

name string

Cookie name to remove

SetValue(string, string, DateTime, string, bool?, string, SameSiteMode, bool)

Sets the cookie.

public static void SetValue(string name, string value, DateTime expires, string path = null, bool? httpOnly = null, string domain = null, SameSiteMode sameSiteMode = SameSiteMode.Lax, bool secure = false)

Parameters

name string

Cookie name

value string

Cookie value

expires DateTime

Expiration time

path string

Cookie virtual path

httpOnly bool?

Defines httpOnly flag.

domain string

Domain to associate the cookie with.

sameSiteMode SameSiteMode

Value of the same site attribute.

secure bool

Indicates whether the cookie should contain the secure attribute.

SetValue(string, string, string, DateTime)

Sets the cookie.

public static void SetValue(string name, string value, string path, DateTime expires)

Parameters

name string

Cookie name

value string

Cookie value

path string

Cookie virtual path

expires DateTime

Expiration time

SetValue(string, string, string, DateTime, bool?)

Sets the cookie.

public static void SetValue(string name, string value, string path, DateTime expires, bool? httpOnly)

Parameters

name string

Cookie name

value string

Cookie value

path string

Cookie virtual path

expires DateTime

Expiration time

httpOnly bool?

Defines httpOnly flag.

SetValue(string, string, string, DateTime, bool?, string)

Sets the cookie.

public static void SetValue(string name, string value, string path, DateTime expires, bool? httpOnly, string domain)

Parameters

name string

Cookie name

value string

Cookie value

path string

Cookie virtual path

expires DateTime

Expiration time

httpOnly bool?

Defines httpOnly flag.

domain string

Domain to associate the cookie with.

SetValueInternal(string, string, ref string, DateTime, bool?, string, SameSiteMode, bool)

Sets the cookie.

protected virtual void SetValueInternal(string name, string value, ref string path, DateTime expires, bool? httpOnly, string domain, SameSiteMode sameSite, bool secure)

Parameters

name string

Cookie name

value string

Cookie value

path string

Cookie virtual path

expires DateTime

Expiration time

httpOnly bool?

Defines httpOnly flag.

domain string

Domain to associate the cookie with.

sameSite SameSiteMode

Same site mode of the cookie.

secure bool

Indicates whether secure attribute should be set for the cookie.