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

    Interface Course

    A course outline. Holds titles and rules only, never lesson content, so a client who can see the outline learns nothing about a locked lesson beyond its title and description.

    interface Course {
        cover?: MediaRef;
        coverColor?: string;
        createdAt: string;
        description?: string;
        id: string;
        isTemplate?: boolean;
        ownerId: string;
        revision: number;
        schemaVersion: 1;
        sections: Section[];
        settings: CourseSettings;
        status?: CourseStatus;
        title: string;
        updatedAt: string;
    }
    Index

    Properties

    cover? coverColor? createdAt description? id isTemplate? ownerId revision schemaVersion sections settings status? title updatedAt

    Properties

    cover?: MediaRef

    Cover image.

    coverColor?: string

    Color shown with the course (a CSS color) when it has no cover image. Without one, apps pick a color from the course id.

    createdAt: string

    When the course was created (ISO 8601).

    description?: string

    Course description.

    id: string

    Stable course id.

    isTemplate?: boolean

    A template: a starting point for new courses rather than a course clients take.

    ownerId: string

    User id of the provider who owns the course.

    revision: number

    Increases by one on every save.

    schemaVersion: 1

    Document shape version.

    sections: Section[]

    Sections, in order.

    settings: CourseSettings

    Course-wide settings.

    status?: CourseStatus

    Draft, published or archived. Absent means published.

    title: string

    Course title.

    updatedAt: string

    When the course was last saved (ISO 8601).

    Settings

    Member Visibility

    On This Page

    Properties