@twinfinity/core
    Preparing search index...

    Interface BimFolder

    Represents a folder

    interface BimFolder {
        apiUrl: string;
        availableLayerDefinitions: LayerDefinitions;
        containerId: string;
        etag: string;
        folderFileCount: { count: number; recursiveCount: number };
        format: string;
        id: string;
        metadata: { serverRelativeUrl: string } & BimChangeBaseMetadata;
        name: string;
        ownerSystem: string;
        path: string;
        permissions: Permissions;
        permissionsString: string;
        type: Folder;
        url: string;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiUrl availableLayerDefinitions containerId etag folderFileCount format id metadata name ownerSystem path permissions permissionsString type url version

    Properties

    apiUrl: string

    Contains base API URL to use when calling backend methods for this particular item.

    availableLayerDefinitions: LayerDefinitions

    List of layers, that can be added to this change, together with the permission that the current user has for each of them.

    containerId: string

    Id of BimContainer to which this change belongs.

    etag: string

    etag for change. Used for optimistic concurrency checks and in operations where we want to check if data has changed or not since last etag we have.

    folderFileCount: { count: number; recursiveCount: number }

    File count statistics for the folder.

    Type declaration

    • Readonlycount: number

      How many files there are in the folder itself.

    • ReadonlyrecursiveCount: number

      How many files there are in the folder itself and all descendant folders (all the way down to the last folder).

    format: string

    Format of change.

    id: string

    Id of change.

    metadata: { serverRelativeUrl: string } & BimChangeBaseMetadata

    Metadata for change.

    name: string

    Name of change.

    ownerSystem: string

    Id of system that the change originated from. If a change in Twinfinity was created because an external system pushed it into Twinfinity then the id will refer to that system. If change originates from Twinfinity (for example because a file was uploaded by a user) then the id will always be 'twinfinity'.

    path: string

    Unique path for the change. Each change has one. If the change or one of its parents are renamed then the path will change.

    permissions: Permissions

    64 bit permission bitmask. Used to verify that a user has required permissions on a change. Since there is no native JSON support for bitmasks, the value is derived from permissionsString.

    permissionsString: string

    String used to represent the permissions bitmask.

    type: Folder
    url: string

    URL of change content. Points to the endpoint where the content of the change can be retrieved by a simple GET request.

    version: number

    Version of change

    Settings

    Member Visibility

    On This Page

    Properties