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

    Interface CourseContextValue

    What every course component reads from CourseProvider.

    interface CourseContextValue {
        allowedEmbedOrigins: readonly string[];
        blockTypes: ReadonlyMap<string, CourseBlockType<unknown>>;
        colors: CourseColors;
        currentUser: CourseUser;
        events: CourseEvents;
        labels: CourseLabels;
        now: () => number;
        reportError: (error: unknown) => void;
        resolveUserName: (userId: string) => string | undefined;
        storage: CourseStorage;
        storageVersion: number;
        uploadMedia: (file: File) => Promise<MediaRef>;
    }
    Index

    Properties

    allowedEmbedOrigins blockTypes colors currentUser events labels now reportError resolveUserName storage storageVersion uploadMedia

    Properties

    allowedEmbedOrigins: readonly string[]
    blockTypes: ReadonlyMap<string, CourseBlockType<unknown>>
    colors: CourseColors
    currentUser: CourseUser
    events: CourseEvents
    labels: CourseLabels
    now: () => number
    reportError: (error: unknown) => void
    resolveUserName: (userId: string) => string | undefined
    storage: CourseStorage
    storageVersion: number

    Increases whenever storage reports a change the user can see.

    uploadMedia: (file: File) => Promise<MediaRef>

    Store a file, refusing one over the provider's maxUploadBytes (see isFileTooLarge).

    Settings

    Member Visibility

    On This Page

    Properties