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

    Interface UseWhiteboardFileResult

    File operations hook return type

    interface UseWhiteboardFileResult {
        autosaveSuspended: boolean;
        canSave: boolean;
        clearError: () => void;
        error: string | null;
        file: WhiteboardFile | null;
        fileMetadata: Record<string, unknown> | null;
        hasUnsavedChanges: boolean;
        isLoading: boolean;
        isSaving: boolean;
        lastSaved: Date | null;
        loadFile: () => Promise<void>;
        markSaved: () => void;
        markUnsaved: () => void;
        renameFile: (newTitle: string) => Promise<void>;
        saveFile: () => Promise<WhiteboardFile | undefined>;
    }
    Index

    Properties

    autosaveSuspended canSave clearError error file fileMetadata hasUnsavedChanges isLoading isSaving lastSaved loadFile markSaved markUnsaved renameFile saveFile

    Properties

    autosaveSuspended: boolean

    True while auto-save is paused because the last save was refused for an expired or invalid credential (HTTP 401/410). Retrying on a timer cannot renew a token, so the hook stops until the next local edit or a successful saveFile(). Hosts should tell the user to sign in again. Other failures do not pause; the hook keeps retrying with a growing delay.

    canSave: boolean

    Whether the local user may persist the file right now. False only for a non-owner in a live collaboration session while the owner is present (the owner's save is authoritative) — see canPersistWhiteboard. saveFile is a no-op while this is false; hosts should hide or disable their save affordance accordingly.

    clearError: () => void

    Clear the current error

    error: string | null

    Error message from last operation

    file: WhiteboardFile | null

    Loaded file data

    fileMetadata: Record<string, unknown> | null

    File metadata

    hasUnsavedChanges: boolean

    Whether there are unsaved changes

    isLoading: boolean

    Whether loading is in progress

    isSaving: boolean

    Whether saving is in progress

    lastSaved: Date | null

    Timestamp of the last successful save, or null if not saved since open

    loadFile: () => Promise<void>

    Load file from server

    markSaved: () => void

    Mark changes as saved

    markUnsaved: () => void

    Mark that changes exist

    renameFile: (newTitle: string) => Promise<void>

    Rename the file's display name and internal name

    saveFile: () => Promise<WhiteboardFile | undefined>

    Resolves with the persisted file, or undefined when nothing was saved (not permitted, or the save failed — see error).

    Settings

    Member Visibility

    On This Page

    Properties