Hiyve Components - v1.0.0
    Preparing search index...

    Interface Progress

    A client's progress through a course, as the client records it.

    interface Progress {
        blocks: Record<string, BlockProgress>;
        clientId: string;
        courseId: string;
        enrollmentId: string;
        lastVisited?: LastVisited;
        lessonComments?: Record<string, SubmissionComment[]>;
        lessons: Record<string, LessonProgress>;
        replies?: Record<string, SubmissionComment[]>;
        resetAt?: string;
        revision: number;
        schemaVersion: 1;
        updatedAt: string;
    }
    Index

    Properties

    blocks clientId courseId enrollmentId lastVisited? lessonComments? lessons replies? resetAt? revision schemaVersion updatedAt

    Properties

    blocks: Record<string, BlockProgress>

    Progress by block id.

    clientId: string

    User id of the client.

    courseId: string

    Course id.

    enrollmentId: string

    Enrollment id.

    lastVisited?: LastVisited

    Where the client was last.

    lessonComments?: Record<string, SubmissionComment[]>

    The client's questions and notes on lessons, by lesson id.

    lessons: Record<string, LessonProgress>

    Completed lessons by lesson id.

    replies?: Record<string, SubmissionComment[]>

    The client's replies to reviews, by submission id.

    resetAt?: string

    The provider's reset this document was cleared for (ISO 8601), so an older copy is never merged back in.

    revision: number

    Increases by one on every save.

    schemaVersion: 1

    Document shape version.

    updatedAt: string

    When the progress was last saved (ISO 8601).

    Settings

    Member Visibility

    On This Page

    Properties