DistributedSession 类

定义

命名空间:

Microsoft.AspNetCore.Session

程序集:

Microsoft.AspNetCore.Session.dll

程序包:

Microsoft.AspNetCore.App.Ref v9.0.2

由 ISession 提供支持的 IDistributedCache。

public ref class DistributedSession : Microsoft::AspNetCore::Http::ISession

public class DistributedSession : Microsoft.AspNetCore.Http.ISession

type DistributedSession = class
    interface ISession

Public Class DistributedSession
Implements ISession

继承

Object

DistributedSession

实现

ISession

构造函数

名称	说明
DistributedSession(IDistributedCache, String, TimeSpan, TimeSpan, Func<Boolean>, ILoggerFactory, Boolean)	初始化 DistributedSession 的新实例。

属性

名称	说明
Id	当前会话的唯一标识符。 这与会话 Cookie 不同，因为 Cookie 生存期可能与数据存储中的会话条目生存期不同。
IsAvailable	指示当前会话是否已成功加载。 在加载会话之前访问此属性将导致它内联加载。
Keys	枚举所有键（如果有）。

方法

名称	说明
Clear()	从当前会话中删除所有条目（如果有）。 不会删除会话 Cookie。
CommitAsync(CancellationToken)	将会话存储在数据存储中。 如果数据存储不可用，可能会引发此错误。
LoadAsync(CancellationToken)	从数据存储区加载会话。 如果数据存储不可用，可能会引发此错误。
Remove(String)	从会话中删除给定的密钥（如果存在）。
Set(String, Byte[])	在当前会话中设置给定的键和值。 如果在发送响应之前未建立会话，则会引发此事件。
TryGetValue(String, Byte[])	检索给定键的值（如果存在）。

扩展方法

名称	说明
Get(ISession, String)	从 ISession获取字节数组值。
GetInt32(ISession, String)	从 ISession获取 int 值。
GetString(ISession, String)	从 ISession获取字符串值。
SetInt32(ISession, String, Int32)	在 中 ISession设置 int 值。
SetString(ISession, String, String)	在 中ISession设置值String。