Interface Tour

Hierarchy

Index

Properties

Properties

channel

channel: string

Optional contentMetaData

contentMetaData: ContentMetadata[]

conversationId

conversationId: string

eventMetaData

eventMetaData: any

eventName

eventName: string

eventSequence

eventSequence: number

id

id: string

key

key: string

name

name: string

Name for the tour that will appear in the Learn tab.

Optional outcomes

outcomes: OutcomeKey[]

skillId

skillId: string

skillName

skillName: string

skillVersion

skillVersion: string

source

source: EngagementSources

Optional startImmediately

startImmediately: boolean

Starts the tour immediately upon receiving the engagement.

Optional startIndex

startIndex: number

Starts the tour at a specific step (zero-based). Useful for allowing users to continue a previous tour.

Optional status

status: "assigned" | "started" | "complete"

(optional) Status of the tour for the current user.

steps

steps: TourStep[]

Optional telemetry

telemetry: ITelemetry

Generated using TypeDoc