Skip to main content

Class: Session

Defined in: Data/Models/User/Session.ts:130

Session entity from the user database Represents a saved study session with all UI state

Constructors​

Constructor​

new Session(data): Session

Defined in: Data/Models/User/Session.ts:142

Parameters​

data​
createdDate?​

string

description?​

string

isAutosave?​

boolean

isDefault?​

boolean

lastOpened?​

string

metadata?​

Metadata

modifiedDate?​

string

name​

string

sessionData​

SessionData

sessionId?​

number

Returns​

Session

Properties​

createdDate?​

optional createdDate?: string

Defined in: Data/Models/User/Session.ts:134

description?​

optional description?: string

Defined in: Data/Models/User/Session.ts:133

isAutosave​

isAutosave: boolean

Defined in: Data/Models/User/Session.ts:137

isDefault​

isDefault: boolean

Defined in: Data/Models/User/Session.ts:138

lastOpened?​

optional lastOpened?: string

Defined in: Data/Models/User/Session.ts:136

metadata?​

optional metadata?: Metadata

Defined in: Data/Models/User/Session.ts:140

modifiedDate?​

optional modifiedDate?: string

Defined in: Data/Models/User/Session.ts:135

name​

name: string

Defined in: Data/Models/User/Session.ts:132

sessionData​

sessionData: SessionData

Defined in: Data/Models/User/Session.ts:139

sessionId?​

optional sessionId?: number

Defined in: Data/Models/User/Session.ts:131

Methods​

getSessionData()​

getSessionData(): SessionData

Defined in: Data/Models/User/Session.ts:197

Get a copy of the session data

Returns​

SessionData

isAutosaveSession()​

isAutosaveSession(): boolean

Defined in: Data/Models/User/Session.ts:169

Check if this is the autosave session

Returns​

boolean

isDefaultSession()​

isDefaultSession(): boolean

Defined in: Data/Models/User/Session.ts:176

Check if this is the default session

Returns​

boolean

markOpened()​

markOpened(): void

Defined in: Data/Models/User/Session.ts:190

Update the last opened time to now

Returns​

void

mergeSessionData()​

mergeSessionData(partialData): void

Defined in: Data/Models/User/Session.ts:212

Merge partial session data updates

Parameters​

partialData​

Partial<SessionData>

Returns​

void

touch()​

touch(): void

Defined in: Data/Models/User/Session.ts:183

Update the modified date to now

Returns​

void

updateSessionData()​

updateSessionData(data): void

Defined in: Data/Models/User/Session.ts:204

Update the session data

Parameters​

data​

SessionData

Returns​

void