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

    Interface AssignmentFileClient

    Client interface for file persistence operations.

    This is the minimal interface the persistence hook requires from the Hiyve client. Consumers building custom integrations can implement this interface to provide their own file storage backend.

    interface AssignmentFileClient {
        modifyFile: (opts: { file: File; fileId: string }) => Promise<void>;
        updateFilename?: (
            opts: { fileId: string; newFilename: string },
        ) => Promise<unknown>;
        uploadFile: (
            opts: { file: File; location: string; resourceType?: string },
        ) => Promise<{ fileId: string }>;
    }
    Index

    Properties

    modifyFile updateFilename? uploadFile

    Properties

    modifyFile: (opts: { file: File; fileId: string }) => Promise<void>

    Modify an existing file in storage

    updateFilename?: (
        opts: { fileId: string; newFilename: string },
    ) => Promise<unknown>

    Rename a file's display name in the file manager

    uploadFile: (
        opts: { file: File; location: string; resourceType?: string },
    ) => Promise<{ fileId: string }>

    Upload a new file to storage

    Settings

    Member Visibility

    On This Page

    Properties