Session class abstract

Available extensions

• SessionAdditionalFields
• SessionPatterns

Annotations

• @freezed

Constructors

Session({required String id, required String token, required DateTime expiresAt, DateTime? createdAt, DateTime? updatedAt, String? ipAddress, String? userAgent, required String userId, String? impersonatedBy, String? activeOrganizationId, String? activeTeamId, @JsonKey.new(readValue: _readSessionAdditionalFields, includeToJson: false) @Default.new(<String, dynamic>{}) Map<String, dynamic> additionalFields})

const

factory

Session.fromJson(Map<String, dynamic> json)

factory

Properties

activeOrganizationId → String?

no setter, inherited

activeTeamId → String?

Present when Better Auth organization is configured with teams.enabled.

no setter, inherited

additionalFields → Map<String, dynamic>

Server-defined custom fields (additionalFields) that aren't part of the static Session shape. Populated from unmapped JSON keys by Session.fromJson; never serialized back out. Read via the field extension, e.g. session.field<String>('theme').

no setter, inherited

copyWith → $SessionCopyWith<Session>

Create a copy of Session with the given fields replaced by the non-null parameter values.

no setter, inherited

createdAt → DateTime?

no setter, inherited

expiresAt → DateTime

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

no setter, inherited

impersonatedBy → String?

no setter, inherited

ipAddress → String?

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

token → String

no setter, inherited

updatedAt → DateTime?

no setter, inherited

userAgent → String?

no setter, inherited

userId → String

no setter, inherited

Methods

field<T>(String key, {T decode(Object? value)?}) → T?

Available on Session, provided by the SessionAdditionalFields extension

Reads key from Session.additionalFields, casting to T.

map<TResult extends Object?>(TResult $default(_Session value)) → TResult

Available on Session, provided by the SessionPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_Session value)?) → TResult?

Available on Session, provided by the SessionPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_Session value)?, {required TResult orElse()}) → TResult

Available on Session, provided by the SessionPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String id, String token, DateTime expiresAt, DateTime? createdAt, DateTime? updatedAt, String? ipAddress, String? userAgent, String userId, String? impersonatedBy, String? activeOrganizationId, String? activeTeamId, Map<String, dynamic> additionalFields)?, {required TResult orElse()}) → TResult

Available on Session, provided by the SessionPatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this Session to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String id, String token, DateTime expiresAt, DateTime? createdAt, DateTime? updatedAt, String? ipAddress, String? userAgent, String userId, String? impersonatedBy, String? activeOrganizationId, String? activeTeamId, Map<String, dynamic> additionalFields)) → TResult

Available on Session, provided by the SessionPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String id, String token, DateTime expiresAt, DateTime? createdAt, DateTime? updatedAt, String? ipAddress, String? userAgent, String userId, String? impersonatedBy, String? activeOrganizationId, String? activeTeamId, Map<String, dynamic> additionalFields)?) → TResult?

Available on Session, provided by the SessionPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited