SessionOptions Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.Session.dll
Package:
Microsoft.AspNetCore.Session v1.0.0
Package:
Microsoft.AspNetCore.Session v1.1.0
Package:
Microsoft.AspNetCore.Session v2.0.0
Package:
Microsoft.AspNetCore.Session v2.1.0
Package:
Microsoft.AspNetCore.Session 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
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Source:
SessionOptions.cs
Source:
SessionOptions.cs

Represents the session state options for the application.

public ref class SessionOptions
public class SessionOptions
type SessionOptions = class
Public Class SessionOptions
Inheritance
Object
SessionOptions

Constructors

SessionOptions()

Properties

Cookie

Determines the settings used to create the cookie.
CookieDomain
Obsolete.

This property is obsolete and will be removed in a future version. The recommended alternative is on Cookie.

Determines the domain used to create the cookie. Is not provided by default.

CookieHttpOnly
Obsolete.

This property is obsolete and will be removed in a future version. The recommended alternative is on Cookie.

Determines if the browser should allow the cookie to be accessed by client-side JavaScript. The default is true, which means the cookie will only be passed to HTTP requests and is not made available to script on the page.

CookieName
Obsolete.

This property is obsolete and will be removed in a future version. The recommended alternative is on Cookie.

Determines the cookie name used to persist the session ID.

CookiePath
Obsolete.

This property is obsolete and will be removed in a future version. The recommended alternative is on Cookie.

Determines the path used to create the cookie. Defaults to CookiePath.

CookieSecure
Obsolete.

This property is obsolete and will be removed in a future version. The recommended alternative is on Cookie.

Determines if the cookie should only be transmitted on HTTPS requests.

IdleTimeout

The IdleTimeout indicates how long the session can be idle before its contents are abandoned. Each session access resets the timeout. Note this only applies to the content of the session, not the cookie.
IOTimeout

The maximum amount of time allowed to load a session from the store or to commit it back to the store. Note this may only apply to asynchronous operations. This timeout can be disabled using InfiniteTimeSpan.

Applies to