CookieHelper Class

Provides the cookie management methods.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<CookieHelper>
        CMS.Helpers.CookieHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131

Syntax

public class CookieHelper : AbstractHelper<CookieHelper>, 
	IDataContainer, ISimpleDataContainer

The CookieHelper type exposes the following members.

Constructors

	Name	Description
Public method	CookieHelper

Properties

	Name	Description
Public property Static member	AllowCookies	If true, the cookies are allowed to be used.
Public property	ColumnNames	Column names.
Public property Static member	Instance	Singleton Instance of the cookie helper.
Public property Static member	ReadOnly	Indicates if the cookies are read-only

Methods

	Name	Description
Public method Static member	ChangeCookieExpiration	Sets the specific cookie expiration time.
Protected method	ChangeCookieExpirationInternal	Sets the specific cookie expiration time.
Public method Static member	ClearResponseCookies	Clears all cookies from cookie collection.
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method Static member	ConvertCookieLevelToIntegerValue	Gets the cookie level from a string value
Public method Static member	EnsureResponseCookie	Ensure response cookie.
Protected method	GetCookieDefaultValueInternal	Gets the default value of a cookie
Protected method	GetCookieLevelInternal	Gets the cookie level for the given cookie
Public method Static member	GetDistinctCookieNames	Gets names of both request and response cookies without duplicates.
Public method Static member	GetExistingCookie	Returns the existing cookie.
Public method Static member	GetValue(String)	Returns the given cookie value.
Public method Static member	GetValue(String, Boolean, Boolean)	Returns the given cookie value.
Protected method	GetValueInternal	Returns the given cookie value.
Public method Static member	IsCookieAllowed	Returns true if the cookie is allowed based on current cookie level
Protected method	IsCookieAllowedInternal	Returns true if the cookie is allowed based on current cookie level
Public method Static member	RegisterCookie	Registers the given cookie within the system.
Public method Static member	Remove	Removes the cookie from the client side.
Public method Static member	RemoveAllCookies	Removes all the user cookies above given level
Protected method	RemoveAllCookiesInternal	Removes all the user cookies
Protected method	RemoveInternal	Removes the cookie from the client side.
Public method Static member	RemoveResponseCookie	Removes cookie from response.
Public method Static member	RequestCookieExists	Checks if request cookie exists.
Public method Static member	ResponseCookieExists	Checks if response cookie exists.
Public method Static member	RestoreResponseCookies	Restores response cookies.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member	SetValue(String, String, String, DateTime)	Sets the cookie.
Public method Static member	SetValue(String, String, String, DateTime, Nullable<Boolean>)	Sets the cookie.
Public method Static member	SetValue(String, String, String, DateTime, Nullable<Boolean>, String)	Sets the cookie.
Public method Static member	SetValue(String, String, DateTime, String, Nullable<Boolean>, String, SameSiteMode, Boolean)	Sets the cookie.
Protected method	SetValueInternal	Sets the cookie.
Public method	TryGetValue	Returns value of column.

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)