CookieBuilder Class

Definition

Namespace:
Microsoft.AspNetCore.Http
Assembly:
Microsoft.AspNetCore.Http.Abstractions.dll
Package:
Microsoft.AspNetCore.Http.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Http.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Http.Abstractions 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

Defines settings used to create a cookie.

public ref class CookieBuilder
public class CookieBuilder
type CookieBuilder = class
Public Class CookieBuilder
Inheritance
Object
CookieBuilder
Derived

Constructors

CookieBuilder()

Properties

Domain

The domain to associate the cookie with.
Expiration

Gets or sets the lifespan of a cookie.
HttpOnly

Indicates whether a cookie is accessible by client-side script.
IsEssential

Indicates if this cookie is essential for the application to function correctly. If true then consent policy checks may be bypassed. The default value is false.
MaxAge

Gets or sets the max-age for the cookie.
Name

The name of the cookie.
Path

The cookie path.
SameSite

The SameSite attribute of the cookie. The default value is Unspecified
SecurePolicy

The policy that will be used to determine Secure. This is determined from the HttpContext passed to Build(HttpContext, DateTimeOffset).

Methods

Build(HttpContext)

Creates the cookie options from the given context.
Build(HttpContext, DateTimeOffset)

Creates the cookie options from the given context with an expiration based on expiresFrom and Expiration.

Applies to