Events
When embedding Coassemble courses and the course builder, you can listen for various events to track progress and respond to user actions.
Course Player Events
When embedding courses for viewing as a learner, you can optionally handle progress events. This allows you to track the progress of your users through the content, and respond in your application accordingly.
| Type | Event | Description | Comments |
|---|---|---|---|
session | ready | Fires when the course player is mounted and ready to use. | |
course | start | Fires when a course is started. | |
progress | Fires when the progress of the course changes. | Progress only ever increases and will not decrease if the user navigates backwards. | |
feedback | Fires when a course feedback is selected. | Will fire multiple times if the user changes their selection. | |
completed | Fires when a course is completed. | ||
screen | start | Fires when a screen is started which is when it comes into view | |
end | Fires when a screen is navigated away from. | ||
complete | Fires when a screen is completed. | For some screen types, this may be when the screen is viewed, for others it may be when the learner completes the screen requirements. | |
screen | answer | Fires when a screen question is answered. | Only applies to Quiz type. |
retry | Fires when a screen is retried. | Only applies to Quiz type. |
Course Builder Events
When embedding the course builder, you can listen for events related to course creation and editing:
| Type | Event | Description | Comments |
|---|---|---|---|
course | created | Fires when a course is first created. | |
updated | Fires when a course is updated. | ||
back | — | Fires when the Back button is clicked. | |
session | ready | Fires when the course builder is mounted and ready to use. | |
error | Fires when an error occurs in the course builder. | ||
expired | Fires when an error occurs due to an expired session. |