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

    Interface UserFile

    Metadata for a file stored across rooms, as returned by the signaling server.

    interface UserFile {
        appData?: Record<string, unknown>;
        brandOrgId?: string;
        contentType?: string;
        createdAt?: string;
        fileId: string;
        fileName: string;
        folderId?: string;
        isFolder?: boolean;
        location: string;
        modified: string;
        parentId?: string | null;
        resourceType?: string;
        roomName?: string;
        s3Path?: string;
        scope?: "private" | "public";
        sharedWith?: string[];
        sharing?: FileShareEntry[];
        system?: boolean;
        timestamp?: string;
        userId: string;
    }
    Index

    Properties

    appData? brandOrgId? contentType? createdAt? fileId fileName folderId? isFolder? location modified parentId? resourceType? roomName? s3Path? scope? sharedWith? sharing? system? timestamp? userId

    Properties

    appData?: Record<string, unknown>

    Application-specific metadata

    brandOrgId?: string

    Optional brand-org scoping for public files; pairs with UserProfile.brandOrgId on the server.

    contentType?: string

    MIME type

    createdAt?: string

    When the file was created (ISO 8601)

    fileId: string

    Unique file identifier

    fileName: string

    Display name of the file

    folderId?: string

    Stable folder identity (id-model users) — the rename/share handle

    isFolder?: boolean

    Whether this is a folder

    location: string

    Folder path

    modified: string

    Last modification timestamp (ISO 8601)

    parentId?: string | null

    Parent folder's folderId (id-model users; null/absent at root)

    resourceType?: string

    Resource type (e.g., 'whiteboard', 'usernote', 'recording', 'assignment', 'image')

    roomName?: string

    Associated room name

    s3Path?: string

    S3 storage path

    scope?: "private" | "public"

    Visibility of the file.

    • 'private' (default): owned by userId; visible only to owner + shared users.
    • 'public': visible to all users in the same apiKey (and optional brandOrgId) tenant who hold the public-files role. Copying / duplicating / moving a public file produces a new private file owned by the caller (copy-on-write).
    sharedWith?: string[]

    User IDs this file is shared with

    sharing?: FileShareEntry[]

    Detailed sharing entries with permissions

    system?: boolean

    System folder (auto-created: /Clips, /Assignments, …) — refused for rename/delete

    timestamp?: string

    Creation timestamp (ISO 8601)

    userId: string

    Owner user ID

    Settings

    Member Visibility

    On This Page

    Properties