src/session/blueriq_session.ts
Each BqSessionComponent provides its own instance of this service such that an Angular component or directive nested within a session can get access to its current session by injecting the BlueriqSession service. This service acts as a facade to the currently shown Session instance. During its lifecycle this service may actually represent multiple different Session instances, as BqSessionComponent listens for newly registered sessions under a certain name in the global SessionRegistry.
Properties |
|
Methods |
Accessors |
constructor(dispatcher: Dispatcher, updateState: UpdateState, heartbeat: SessionHeartbeat, injector: Injector, actions: Actions, parent: BlueriqSession | null)
|
|||||||||||||||||||||
|
Parameters :
|
| changed | ||||||
changed(field: Field)
|
||||||
|
Dispatches an action that signals that the value of a field was changed. If the field is a refresh field, this causes a refresh request to be sent to Blueriq.
Parameters :
Returns :
void
|
| ngOnDestroy |
ngOnDestroy()
|
|
Returns :
void
|
| pressed | |||||||||
pressed(button: Button, parameters?: EventParameters)
|
|||||||||
|
Dispatches an action that signals that a button was clicked.
Parameters :
Returns :
void
|
| recompose |
recompose()
|
|
Dispatches an action to recompose the page.
Returns :
void
|
| Readonly actions$ |
actions$:
|
Type : Observable<SessionAction>
|
|
Emits all actions that occur on this specific session. If you're only interested in receiving a specific type of
action, use the |
| current |
getcurrent()
|
|
Accesses the underlying session data that is currently being shown by this component.
Returns :
Session
|
| root |
getroot()
|
|
Accesses the root session.
Returns :
BlueriqSession
|
| isWidget |
getisWidget()
|
|
Returns whether or not this session is a widget session.
Returns :
boolean
|
| isRoot |
getisRoot()
|
|
Returns whether or not this session is the root session.
Returns :
boolean
|
| sessionName |
getsessionName()
|
|
Returns the name of the session that is currently being shown.
Returns :
string
|
| sessionId |
getsessionId()
|
|
Returns the session id of the session that is currently being shown.
Returns :
SessionId
|
| localization |
getlocalization()
|
|
Returns the localization settings of the session that is currently being shown.
Returns :
Localization
|
| form |
getform()
|
|
Returns the form of the session that is currently being shown.
Returns :
BlueriqForm
|