@blueriq/angular - 0.6.16
  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

channel

Type : string | undefined

flow

Specifies the flow to start. Required together with project, unless a shortcut is specified.

Type : string | undefined

languageCode

Type : string | undefined

parameters

Additional parameters to start the project with. Can be used in conjunction with AQ_GetRequestParameters service.

Type : QueryParameters | undefined

project

Specifies to 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!

Type : string | undefined

sessionId

Specifies a raw session id to resume as alternative to starting a shortcut or project

Type : string | undefined

sessionName

The name of the session to start.

Default value : 'Main'

shortcut

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.

Type : string | undefined

version

Type : string | undefined

Outputs

error

This event is emitted when an error of some sort occurred for the session.

$event Type: EventEmitter
expired

This event is emitted when the shown session has expired.

$event Type: EventEmitter
flowEnded

This event is emitted when the current session's flow has ended.

$event Type: EventEmitter
forbidden

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

$event Type: EventEmitter
loaded

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.

$event Type: EventEmitter
unauthorized

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

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

result-matching ""

    No results matching ""