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

    Interface UseFileAnnotationsResult

    Return type of useFileAnnotations.

    interface UseFileAnnotationsResult {
        getCommentsForFile: (fileId: string) => FileComment[];
        getMarkersForFile: (fileId: string) => FileTimelineMarker[];
        getRegionsForFile: (fileId: string) => FileRegion[];
        handleAddComment: (fileId: string, content: string) => Promise<void>;
        handleDeleteComment: (fileId: string, commentId: string) => Promise<void>;
        handleEditComment: (
            fileId: string,
            commentId: string,
            content: string,
        ) => Promise<void>;
        handleGetComments: (fileId: string) => Promise<FileComment[]>;
        handleMarkerAdd: (fileId: string, marker: FileTimelineMarker) => void;
        handleMarkerChange: (fileId: string, marker: FileTimelineMarker) => void;
        handleMarkerDelete: (fileId: string, markerId: string) => void;
        handleRegionChange: (fileId: string, region: FileRegion) => void;
        handleRegionDelete: (fileId: string, regionId: string) => void;
    }
    Index

    Properties

    getCommentsForFile getMarkersForFile getRegionsForFile handleAddComment handleDeleteComment handleEditComment handleGetComments handleMarkerAdd handleMarkerChange handleMarkerDelete handleRegionChange handleRegionDelete

    Properties

    getCommentsForFile: (fileId: string) => FileComment[]

    Get all comments for a file by its ID.

    getMarkersForFile: (fileId: string) => FileTimelineMarker[]

    Get all markers for a file by its ID.

    getRegionsForFile: (fileId: string) => FileRegion[]

    Get all named regions for a file by its ID.

    handleAddComment: (fileId: string, content: string) => Promise<void>

    Add a new comment to a file.

    handleDeleteComment: (fileId: string, commentId: string) => Promise<void>

    Delete a comment from a file by comment ID.

    handleEditComment: (
        fileId: string,
        commentId: string,
        content: string,
    ) => Promise<void>

    Edit a comment on a file.

    handleGetComments: (fileId: string) => Promise<FileComment[]>

    Get comments for a file (async version for FileManager compatibility).

    handleMarkerAdd: (fileId: string, marker: FileTimelineMarker) => void

    Add a new marker to a file. Enriches with authorId/authorName/createdAt.

    handleMarkerChange: (fileId: string, marker: FileTimelineMarker) => void

    Update an existing marker on a file.

    handleMarkerDelete: (fileId: string, markerId: string) => void

    Delete a marker from a file by marker ID.

    handleRegionChange: (fileId: string, region: FileRegion) => void

    Create or update a named region on a file.

    handleRegionDelete: (fileId: string, regionId: string) => void

    Delete a named region from a file by region ID.

    Settings

    Member Visibility

    On This Page

    Properties