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

    Interface EnrollmentOverview

    What a provider needs to see about one enrollment — its status, what is open, the approval decisions and which lessons the client has completed — without loading the client's progress. Lists of these are cheap to fetch, so provider screens use them for progress tables and review queues.

    interface EnrollmentOverview {
        approvals: Record<string, LessonApproval>;
        clientId: string;
        clientLessons?: ClientLesson[];
        clientName?: string;
        completedLessons: Record<string, string>;
        completions?: Record<string, ManualCompletion>;
        courseId: string;
        enrolledAt: string;
        grants: Record<string, LessonGrant>;
        hiddenLessons?: string[];
        id: string;
        lastActivityAt?: string;
        lessonComments?: Record<string, CommentSummary>;
        lessonReplies?: Record<string, CommentSummary>;
        providerId: string;
        reviewStatuses?: Record<string, string>;
        status: EnrollmentStatus;
        statusChangedAt?: string;
        submissions?: Record<string, SubmissionSummary>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    approvals clientId clientLessons? clientName? completedLessons completions? courseId enrolledAt grants hiddenLessons? id lastActivityAt? lessonComments? lessonReplies? providerId reviewStatuses? status statusChangedAt? submissions?

    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.

    completedLessons: Record<string, string>

    When each completed lesson was last completed (ISO 8601), by lesson id.

    completions?: Record<string, ManualCompletion>

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

    courseId: string

    Course id.

    enrolledAt: string

    When the client was enrolled (ISO 8601).

    grants: Record<string, LessonGrant>

    Lessons opened to the client, by lesson id.

    hiddenLessons?: string[]

    Course lessons hidden from this client.

    id: string

    Enrollment id.

    lastActivityAt?: string

    When the client last saved progress (ISO 8601).

    lessonComments?: Record<string, CommentSummary>

    The client's questions and notes on each lesson: how many and when the last was written.

    lessonReplies?: Record<string, CommentSummary>

    The provider's replies on each lesson: how many and when the last was written.

    providerId: string

    User id of the provider.

    reviewStatuses?: Record<string, string>

    Status ids the provider has given, by submission id.

    status: EnrollmentStatus

    Where the enrollment stands.

    statusChangedAt?: string

    When the status last changed (ISO 8601).

    submissions?: Record<string, SubmissionSummary>

    The client's latest submission to each submission block, by block id.

    Settings

    Member Visibility

    On This Page

    Properties