File

src/session/session.ts

Description

Data object containing session information.

Index

Properties

Constructor

constructor(subscriptionId: SubscriptionId, sessionId: SessionId, sessionName: string, sessionTimeoutInSeconds: number, csrfToken: string, requestWard: string | undefined, localization: Localization, pageModel: PageModel, hostSessionName?: string)
Parameters :
Name Type Optional
subscriptionId SubscriptionId No
sessionId SessionId No
sessionName string No
sessionTimeoutInSeconds number No
csrfToken string No
requestWard string | undefined No
localization Localization No
pageModel PageModel No
hostSessionName string Yes

Properties

Public Readonly csrfToken
csrfToken: string
Type : string
Readonly expired
expired:
Default value : false

This property reflects whether or not the session has expired. If {@code true}, the session may still have expired since the most recent event or heartbeat but we just haven't noticed yet. If {@code false}, the session is guaranteed to no longer be available.

Readonly form
form:
Default value : new BlueriqForm(this)

Each session has access to a BlueriqForm instance that provides access to form data.

Public Readonly Optional hostSessionName
hostSessionName: string
Type : string
Public Readonly localization
localization: Localization
Type : Localization
Public Readonly pageModel
pageModel: PageModel
Type : PageModel
Public Readonly requestWard
requestWard: string | undefined
Type : string | undefined
Public Readonly sessionId
sessionId: SessionId
Type : SessionId
Public Readonly sessionName
sessionName: string
Type : string
Public Readonly sessionTimeoutInSeconds
sessionTimeoutInSeconds: number
Type : number
Public Readonly subscriptionId
subscriptionId: SubscriptionId
Type : SubscriptionId

result-matching ""

    No results matching ""