Skip to main content

UpdateCallbackEvent

The UpdateCallbackEvent enum defines various events that occur during the lessons and plans in the GOFA Lessons SDK. Below are the specific events along with their trigger points:

enum UpdateCallbackEvent {
  lessonStarted,
  lessonCancelled,
  lessonFinished,
  planStarted,
  planCancelled,
  planFinished,
}

1. lessonStarted ​

Trigger Point: This event is triggered when the user enters the lesson calibration screen, marking the beginning of a lesson.

2. lessonCancelled ​

Trigger Point: This event is activated when the user ends a lesson prematurely.

Note: that this does not automatically mean the user has failed the lesson; substantial lesson progress can still contribute to a pass (indicated by passed: true).

3. lessonFinished ​

Trigger Point: This event is fired when the user completes the entire lesson, meaning the user watches until the last second of the lesson video.

4. planStarted ​

Trigger Point: This event is triggered when the user first starts the lesson plan.

5. planCancelled ​

Trigger Point: This event is activated when the user resets the plan using the reset button on the plan detail screen.

6. planFinished ​

Trigger Point: This event is triggered when the user completes the last lesson in the lesson plan.