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

    Interface AssignmentFile

    interface AssignmentFile {
        assignedTo: string[];
        authorId: string;
        authorName?: string;
        completedBy: string[];
        content: JSONContent;
        createdAt: string;
        dueDate: string | null;
        id: string;
        lastModified: string;
        modifiedBy: string;
        status: AssignmentStatus;
        timeHours: number;
        timeMinutes: number;
        title: string;
        updatedAt: string;
        userActivities: Record<string, UserActivity>;
    }
    Index

    Properties

    assignedTo authorId authorName? completedBy content createdAt dueDate id lastModified modifiedBy status timeHours timeMinutes title updatedAt userActivities

    Properties

    assignedTo: string[]

    List of user IDs assigned to this assignment

    authorId: string

    User ID of the assignment creator

    authorName?: string

    Display name of the assignment creator

    completedBy: string[]

    User IDs of assignees who have marked the assignment complete from their side. The overall status is derived from this list plus userActivities: when every assignee appears in completedBy the assignment is 'completed'; when at least one user has activity it's 'in_progress'; otherwise 'not_started'.

    Per-student completion is reversible — a student can re-open the assignment, which removes them from this list and recomputes the status.

    content

    content: JSONContent

    Assignment content in TipTap JSON format. Includes inline file embeds as assignmentEmbed nodes.

    createdAt: string

    ISO timestamp when the assignment was created

    dueDate: string | null

    ISO timestamp for the due date (null if no due date)

    id: string

    Unique identifier for the assignment

    lastModified: string

    ISO timestamp of the last modification

    modifiedBy: string

    User ID of the last person to modify the assignment

    status: AssignmentStatus

    Overall assignment status

    timeHours: number

    Estimated hours component of the time estimate

    timeMinutes: number

    Estimated minutes component of the time estimate

    title: string

    Assignment title

    updatedAt: string

    ISO timestamp when the assignment was last updated

    userActivities: Record<string, UserActivity>

    Per-user activity tracking data, keyed by user ID

    Settings

    Member Visibility

    On This Page

    Properties