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

    Interface Enrollment

    A client's place in a course, as the provider records it.

    interface Enrollment {
        approvals: Record<string, LessonApproval>;
        clientId: string;
        clientLessons?: ClientLesson[];
        clientName?: string;
        completions?: Record<string, ManualCompletion>;
        courseId: string;
        customizedAt?: string;
        enrolledAt: string;
        grants: Record<string, LessonGrant>;
        hiddenLessons?: string[];
        id: string;
        lessonReplies?: Record<string, SubmissionComment[]>;
        progressResetAt?: string;
        providerId: string;
        reviews?: Record<string, SubmissionReview>;
        revision: number;
        schemaVersion: 1;
        status: EnrollmentStatus;
        statusChangedAt?: string;
        updatedAt: string;
    }
    Index

    Properties

    approvals clientId clientLessons? clientName? completions? courseId customizedAt? enrolledAt grants hiddenLessons? id lessonReplies? progressResetAt? providerId reviews? revision schemaVersion status statusChangedAt? updatedAt

    Properties

    approvals: Record<string, LessonApproval>

    The provider's approval decisions, by lesson id.

    clientId: string

    User id of the client.

    clientLessons?: ClientLesson[]

    Lessons added for this client only.

    clientName?: string

    Name to show for the client.

    completions?: Record<string, ManualCompletion>

    Lessons the provider marked complete by hand, by lesson id.

    courseId: string

    Course id.

    customizedAt?: string

    When this client's lessons were last changed (ISO 8601).

    enrolledAt: string

    When the client was enrolled (ISO 8601). Drip timers count from here.

    grants: Record<string, LessonGrant>

    Lessons opened to the client so far, by lesson id.

    hiddenLessons?: string[]

    Course lessons hidden from this client.

    id: string

    Stable enrollment id.

    lessonReplies?: Record<string, SubmissionComment[]>

    The provider's replies and notes on lessons, by lesson id.

    progressResetAt?: string

    When the provider last reset the client's progress (ISO 8601): anything done before doesn't count, and the client's app clears it.

    providerId: string

    User id of the provider.

    reviews?: Record<string, SubmissionReview>

    The provider's reviews of the client's submissions, by submission id.

    revision: number

    Increases by one on every save.

    schemaVersion: 1

    Document shape version.

    status: EnrollmentStatus

    Where the enrollment stands.

    statusChangedAt?: string

    When the status last changed (ISO 8601).

    updatedAt: string

    When the enrollment was last saved (ISO 8601).

    Settings

    Member Visibility

    On This Page

    Properties