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

    Interface UseCourseClientsResult

    Result of useCourseClients.

    interface UseCourseClientsResult {
        course: Course | null;
        decide: (
            enrollmentId: string,
            lessonId: string,
            decision: { approved: boolean; note?: string },
        ) => Promise<void>;
        enroll: (clients: readonly ClientRef[]) => Promise<void>;
        error: Error | null;
        loadAnswers: (
            enrollmentId: string,
            lessonId: string,
        ) => Promise<ReviewAnswers>;
        loading: boolean;
        loadReview: (
            enrollmentId: string,
            lessonId: string,
        ) => Promise<ReviewDetails>;
        markComplete: (enrollmentId: string, lessonId: string) => Promise<void>;
        reload: () => void;
        remove: (enrollmentId: string) => Promise<void>;
        replyToLesson: (
            enrollmentId: string,
            lessonId: string,
            input: CommentInput,
        ) => Promise<void>;
        resetProgress: (enrollmentId: string) => Promise<void>;
        review: (
            enrollmentId: string,
            submissionId: string,
            input: { comment?: CommentInput; status?: ReviewStatus },
        ) => Promise<void>;
        reviews: ReviewItem[];
        rows: ClientRow[];
        saveStatuses: (statuses: ReviewStatus[]) => Promise<void>;
        setPaused: (enrollmentId: string, paused: boolean) => Promise<void>;
        statuses: ReviewStatus[];
        unlock: (enrollmentId: string, lessonIds: string[]) => Promise<void>;
    }
    Index

    Properties

    course decide enroll error loadAnswers loading loadReview markComplete reload remove replyToLesson resetProgress review reviews rows saveStatuses setPaused statuses unlock

    Properties

    course: Course | null
    decide: (
        enrollmentId: string,
        lessonId: string,
        decision: { approved: boolean; note?: string },
    ) => Promise<void>
    enroll: (clients: readonly ClientRef[]) => Promise<void>
    error: Error | null
    loadAnswers: (enrollmentId: string, lessonId: string) => Promise<ReviewAnswers>
    loading: boolean
    loadReview: (enrollmentId: string, lessonId: string) => Promise<ReviewDetails>

    Load what is needed to review a lesson: the enrollment, progress, lesson and quiz answers.

    markComplete: (enrollmentId: string, lessonId: string) => Promise<void>

    Mark a lesson complete for a client by hand; what it unlocks opens.

    reload: () => void
    remove: (enrollmentId: string) => Promise<void>
    replyToLesson: (
        enrollmentId: string,
        lessonId: string,
        input: CommentInput,
    ) => Promise<void>

    Reply to a client's question or note on a lesson.

    resetProgress: (enrollmentId: string) => Promise<void>

    Start a client over.

    review: (
        enrollmentId: string,
        submissionId: string,
        input: { comment?: CommentInput; status?: ReviewStatus },
    ) => Promise<void>

    Comment on and/or give a status to a submission.

    reviews: ReviewItem[]
    rows: ClientRow[]
    saveStatuses: (statuses: ReviewStatus[]) => Promise<void>
    setPaused: (enrollmentId: string, paused: boolean) => Promise<void>
    statuses: ReviewStatus[]

    The provider's review statuses.

    unlock: (enrollmentId: string, lessonIds: string[]) => Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties