@blueriq/angular - 0.15.14
  1. Components
  2. BqProjectComponent

File

src/session/bq-project/bq-project.component.ts

Implements

OnChanges OnInit OnDestroy

Metadata

selector bq-project
templateUrl ./bq-project.component.html

Index

Inputs
Outputs

Constructor

constructor(dispatcher: Dispatcher, actions$: Actions, resumer: ResumeSessionStrategy)
Parameters :
Name Type Optional
dispatcher Dispatcher No
actions$ Actions No
resumer ResumeSessionStrategy No

Inputs

baseUrl
Type : string | null

Specifies a baseUrl to use when communication with the backend. Can be used to override the environment baseUrl for specific projects.
channel
Type : string | null
flow
Type : string | null

Specifies the flow to start. Required together with project, unless a shortcut is specified.
languageCode
Type : string | null
parameters
Type : QueryParameters | null

Additional parameters to start the project with. Can be used in conjunction with AQ_GetRequestParameters service.
project
Type : string | null

Specifies the project to start instead of using a shortcut. If this property is provided, flow must be provided as well. Starting a flow without using a shortcut may be disabled in production environments!
sessionId
Type : string | null

Specifies a raw session id to resume as alternative to starting a shortcut or project
sessionName
Type : string
Default value : 'Main'

The name of the session to start.
shortcut
Type : string | null

Shortcut to start. If no explicit project reference is specified (using project and flow attributes) and if this property is empty or not specified, the default shortcut will be started.
version
Type : string | null

Outputs

error
Type : EventEmitter

This event is emitted when an error of some sort occurred for the session.
expired
Type : EventEmitter

This event is emitted when the shown session has expired.
flowEnded
Type : EventEmitter

This event is emitted when the current session's flow has ended.
forbidden
Type : EventEmitter

This event is emitted when the project could not be started because the current user is unauthorized.
loaded
Type : EventEmitter

This event is emitted when the project has been loaded. This event may emit multiple times, for instance when AQ_StartProject is used to start a new project, a new Blueriq session is loaded.
unauthorized
Type : EventEmitter

This event is emitted when the project could not be started because the current user is not logged in.

 
<bq-session [sessionName]="sessionName"
            (loaded)="loaded.emit($event)"
            (expired)="expired.emit($event)"
            (flowEnded)="flowEnded.emit($event)"
            (error)="error.emit($event)"
></bq-session>

results matching ""

    No results matching ""