@blueriq/angular - 0.15.14
  1. Classes
  2. Session

File

src/session/session.ts

Description

Data object containing session information.

Index

Properties
Accessors

Constructor

constructor(sessionId: SessionId, sessionName: string, parent: Session | undefined, _baseUrl: string | undefined, sessionTimeoutInSeconds: number, csrfToken: string, requestWard: string | undefined, localization: Localization, pageModel: PageModel, externalSessionInfo: ExternalSessionInfo | undefined)
Parameters :
Name Type Optional
sessionId SessionId No
sessionName string No
parent Session | undefined No
_baseUrl string | undefined No
sessionTimeoutInSeconds number No
csrfToken string No
requestWard string | undefined No
localization Localization No
pageModel PageModel No
externalSessionInfo ExternalSessionInfo | undefined No

Properties

Public Readonly csrfToken
Type : string
Readonly 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.
Public Readonly externalSessionInfo
Type : ExternalSessionInfo | undefined
Readonly form
Default value : new BlueriqForm(this)

Each session has access to a BlueriqForm instance that provides access to form data.
Public Readonly localization
Type : Localization
Public Readonly pageModel
Type : PageModel
Public Readonly parent
Type : Session | undefined
Public Readonly requestWard
Type : string | undefined
Public Readonly sessionId
Type : SessionId
Public Readonly sessionName
Type : string
Public Readonly sessionTimeoutInSeconds
Type : number

Accessors

baseUrl
getbaseUrl()

Returns the base URL of the Runtime that hosts this session.

Returns : string | undefined
root
getroot()

Obtains the root session of this session, which may be the session itself.

Returns : Session

results matching ""

    No results matching ""