LessonKit API
Preparing search index...
core/dist
Module core/dist
Type Aliases
AccordionSectionToggledData
AssessmentAnsweredData
AssessmentBaseProps
AssessmentBehaviour
AssessmentCompletedData
AssessmentHandle
AssessmentInteractionType
AssessmentPlugin
AssessmentResumeState
AssessmentScoreInput
AssessmentScoreResult
AssessmentXAPIData
BlockId
BookPageViewedData
BranchGraphNodeInput
BranchGraphValidationIssue
BranchGraphValidationResult
BranchNodeViewedData
BranchSelectedData
BuildTelemetryEventInput
CheckId
ClockPort
CompoundBaseProps
CompoundHandle
CompoundPageViewedData
CompoundParentType
CompoundResumeInput
CompoundResumeState
CourseId
CourseLifecycleContext
CourseLifecycleDeps
EmitContext
FlashcardFlippedData
HeadlessLessonkitConfig
HeadlessLessonkitRuntime
HeadlessRuntimePorts
HotspotOpenedData
IdentityIdPath
IdentityValidationIssue
IdentityValidationResult
ImageSliderChangedData
InformationWallSearchData
InteractionBlockRegistration
InteractionData
InteractionPlugin
InvalidSessionIdContext
LessonCompletionEmitter
LessonId
LessonkitPlugin
LessonkitPluginContext
LessonkitPluginKind
LessonkitRuntimeVersion
LessonkitUrn
LessonkitUrnParts
LessonLifecycleData
LifecyclePlugin
LmsBridgeMode
LoadCompoundStateOptions
McqAssessmentProps
McqScoreResult
MemoryCardFlippedData
ParallaxSlideViewedData
ParseCompoundResumeStateOptions
PluginHost
PluginIdentity
PluginRegistry
ProgressController
ProgressState
QuestionnaireSubmittedData
QuizAnsweredData
QuizCompletedData
ResolveSessionIdOptions
SlideViewedData
StoragePort
TelemetryBatchSink
TelemetryCatalogEntry
TelemetryCatalogV2Entry
TelemetryCatalogV3Entry
TelemetryDataFor
TelemetryEmitFn
TelemetryEvent
TelemetryEventBase
TelemetryEventName
TelemetryPipeline
TelemetryPipelineSink
TelemetryPlugin
TelemetrySink
TelemetryUser
TimerPort
TrackingClient
VideoCueReachedData
VideoSegmentCompletedData
Variables
ACCORDION_FORBIDDEN_CHILD_TYPES
ASSESSMENT_17_CHILD_TYPES
ASSESSMENT_SEQUENCE_ALLOWED_CHILD_TYPES
BLOCKS_14_PAGE_SLIDE
BRANCH_NODE_ALLOWED_CHILD_TYPES
BRANCHING_SCENARIO_ALLOWED_CHILD_TYPES
COMPOUND_MAX_NESTING_DEPTH
COMPOUND_RESUME_SCHEMA_VERSION
GAME_MAP_ALLOWED_CHILD_TYPES
ID_MAX_LENGTH
ID_PATTERN
INTERACTIVE_BOOK_ALLOWED_CHILD_TYPES
INTERACTIVE_VIDEO_ALLOWED_CHILD_TYPES
MAP_STAGE_ALLOWED_CHILD_TYPES
PAGE_ALLOWED_CHILD_TYPES
SESSION_STORAGE_KEY
SINGLE_CHOICE_SET_ALLOWED_CHILD_TYPES
SLIDE_ALLOWED_CHILD_TYPES
SLIDE_DECK_ALLOWED_CHILD_TYPES
TELEMETRY_EVENT_CATALOG
TELEMETRY_EVENT_CATALOG_V2
TELEMETRY_EVENT_CATALOG_V3
telemetryCatalogV2Version
telemetryCatalogV3Version
telemetryCatalogVersion
TIMED_CUE_ALLOWED_CHILD_TYPES
Functions
assertNever
assertValidId
buildCourseStartedTelemetryEvent
buildLessonkitUrn
buildPluginContext
buildTelemetryCatalog
buildTelemetryCatalogV2
buildTelemetryCatalogV3
buildTelemetryEvent
clampCompoundPageIndex
clearCompoundState
completeCourseWithTelemetry
completeLessonWithTelemetry
compoundStateStorageKey
createCompoundResumeState
createDefaultClock
createGlobalTimer
createLessonkitRuntime
createNoopStorage
createPluginRegistry
createProgressController
createSessionId
createSessionStoragePort
createTelemetryPipeline
createTrackingClient
createTrackingPipelineSink
defineAssessmentPlugin
defineLifecyclePlugin
defineTelemetryPlugin
deriveId
getAllowedChildTypes
getTabSessionId
hasCourseStarted
hasCourseStartedEmittedToTracking
hasCourseStartedPipelineDelivered
hasCourseStartedXapiSent
isChildTypeAllowed
isLifecycleTelemetryEvent
isMultiSelectMcq
loadCompoundState
markCourseStarted
markCourseStartedEmittedToTracking
markCourseStartedPipelineDelivered
markCourseStartedXapiSent
migrateCourseStartedMark
nowIso
orderChoicesByIndices
parseBlockId
parseCheckId
parseCompoundResumeState
parseCourseId
parseLessonId
resetStoragePortForTests
resetTelemetryBuilderWarningsForTests
resolveMcqCorrectAnswers
resolveMcqShuffleSeed
resolveSessionId
saveCompoundState
scoreMcqSelection
shuffleChoiceIndices
slugifyId
tryBuildTelemetryEvent
tryEmitCourseStarted
validateBranchGraph
validateId
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Type Aliases
Accordion
Section
Toggled
Data
Assessment
Answered
Data
Assessment
Base
Props
Assessment
Behaviour
Assessment
Completed
Data
Assessment
Handle
Assessment
Interaction
Type
Assessment
Plugin
Assessment
Resume
State
Assessment
Score
Input
Assessment
Score
Result
Assessment
XAPI
Data
Block
Id
Book
Page
Viewed
Data
Branch
Graph
Node
Input
Branch
Graph
Validation
Issue
Branch
Graph
Validation
Result
Branch
Node
Viewed
Data
Branch
Selected
Data
Build
Telemetry
Event
Input
Check
Id
Clock
Port
Compound
Base
Props
Compound
Handle
Compound
Page
Viewed
Data
Compound
Parent
Type
Compound
Resume
Input
Compound
Resume
State
Course
Id
Course
Lifecycle
Context
Course
Lifecycle
Deps
Emit
Context
Flashcard
Flipped
Data
Headless
Lessonkit
Config
Headless
Lessonkit
Runtime
Headless
Runtime
Ports
Hotspot
Opened
Data
Identity
Id
Path
Identity
Validation
Issue
Identity
Validation
Result
Image
Slider
Changed
Data
Information
Wall
Search
Data
Interaction
Block
Registration
Interaction
Data
Interaction
Plugin
Invalid
Session
Id
Context
Lesson
Completion
Emitter
Lesson
Id
Lessonkit
Plugin
Lessonkit
Plugin
Context
Lessonkit
Plugin
Kind
Lessonkit
Runtime
Version
Lessonkit
Urn
Lessonkit
Urn
Parts
Lesson
Lifecycle
Data
Lifecycle
Plugin
Lms
Bridge
Mode
Load
Compound
State
Options
Mcq
Assessment
Props
Mcq
Score
Result
Memory
Card
Flipped
Data
Parallax
Slide
Viewed
Data
Parse
Compound
Resume
State
Options
Plugin
Host
Plugin
Identity
Plugin
Registry
Progress
Controller
Progress
State
Questionnaire
Submitted
Data
Quiz
Answered
Data
Quiz
Completed
Data
Resolve
Session
Id
Options
Slide
Viewed
Data
Storage
Port
Telemetry
Batch
Sink
Telemetry
Catalog
Entry
Telemetry
Catalog
V2
Entry
Telemetry
Catalog
V3
Entry
Telemetry
Data
For
Telemetry
Emit
Fn
Telemetry
Event
Telemetry
Event
Base
Telemetry
Event
Name
Telemetry
Pipeline
Telemetry
Pipeline
Sink
Telemetry
Plugin
Telemetry
Sink
Telemetry
User
Timer
Port
Tracking
Client
Video
Cue
Reached
Data
Video
Segment
Completed
Data
Variables
ACCORDION_
FORBIDDEN_
CHILD_
TYPES
ASSESSMENT_
17_
CHILD_
TYPES
ASSESSMENT_
SEQUENCE_
ALLOWED_
CHILD_
TYPES
BLOCKS_
14_
PAGE_
SLIDE
BRANCH_
NODE_
ALLOWED_
CHILD_
TYPES
BRANCHING_
SCENARIO_
ALLOWED_
CHILD_
TYPES
COMPOUND_
MAX_
NESTING_
DEPTH
COMPOUND_
RESUME_
SCHEMA_
VERSION
GAME_
MAP_
ALLOWED_
CHILD_
TYPES
ID_
MAX_
LENGTH
ID_
PATTERN
INTERACTIVE_
BOOK_
ALLOWED_
CHILD_
TYPES
INTERACTIVE_
VIDEO_
ALLOWED_
CHILD_
TYPES
MAP_
STAGE_
ALLOWED_
CHILD_
TYPES
PAGE_
ALLOWED_
CHILD_
TYPES
SESSION_
STORAGE_
KEY
SINGLE_
CHOICE_
SET_
ALLOWED_
CHILD_
TYPES
SLIDE_
ALLOWED_
CHILD_
TYPES
SLIDE_
DECK_
ALLOWED_
CHILD_
TYPES
TELEMETRY_
EVENT_
CATALOG
TELEMETRY_
EVENT_
CATALOG_
V2
TELEMETRY_
EVENT_
CATALOG_
V3
telemetry
Catalog
V2
Version
telemetry
Catalog
V3
Version
telemetry
Catalog
Version
TIMED_
CUE_
ALLOWED_
CHILD_
TYPES
Functions
assert
Never
assert
Valid
Id
build
Course
Started
Telemetry
Event
build
Lessonkit
Urn
build
Plugin
Context
build
Telemetry
Catalog
build
Telemetry
Catalog
V2
build
Telemetry
Catalog
V3
build
Telemetry
Event
clamp
Compound
Page
Index
clear
Compound
State
complete
Course
With
Telemetry
complete
Lesson
With
Telemetry
compound
State
Storage
Key
create
Compound
Resume
State
create
Default
Clock
create
Global
Timer
create
Lessonkit
Runtime
create
Noop
Storage
create
Plugin
Registry
create
Progress
Controller
create
Session
Id
create
Session
Storage
Port
create
Telemetry
Pipeline
create
Tracking
Client
create
Tracking
Pipeline
Sink
define
Assessment
Plugin
define
Lifecycle
Plugin
define
Telemetry
Plugin
derive
Id
get
Allowed
Child
Types
get
Tab
Session
Id
has
Course
Started
has
Course
Started
Emitted
To
Tracking
has
Course
Started
Pipeline
Delivered
has
Course
Started
Xapi
Sent
is
Child
Type
Allowed
is
Lifecycle
Telemetry
Event
is
Multi
Select
Mcq
load
Compound
State
mark
Course
Started
mark
Course
Started
Emitted
To
Tracking
mark
Course
Started
Pipeline
Delivered
mark
Course
Started
Xapi
Sent
migrate
Course
Started
Mark
now
Iso
order
Choices
By
Indices
parse
Block
Id
parse
Check
Id
parse
Compound
Resume
State
parse
Course
Id
parse
Lesson
Id
reset
Storage
Port
For
Tests
reset
Telemetry
Builder
Warnings
For
Tests
resolve
Mcq
Correct
Answers
resolve
Mcq
Shuffle
Seed
resolve
Session
Id
save
Compound
State
score
Mcq
Selection
shuffle
Choice
Indices
slugify
Id
try
Build
Telemetry
Event
try
Emit
Course
Started
validate
Branch
Graph
validate
Id
LessonKit API
Loading...