@twinfinity/core
    Preparing search index...

    Interface BimContainer

    Represents a container. For example a project

    interface BimContainer {
        apiUrl: string;
        availableLayerDefinitions: LayerDefinitions;
        containerId: string;
        containerType: string;
        etag: string;
        format: string;
        hasGeometry: boolean;
        id: string;
        language: string;
        lcid: Lcid;
        mainProject?: string;
        metadata: BimChangeBaseMetadata;
        metadataProperties?: {
            readonly [propertyName: string]: {
                displayName?: string;
                value?: string;
            };
        };
        modifiedUtc: Date;
        name: string;
        navigationAttributes?: [string, string][];
        ownerSystem: string;
        path: string;
        permissions: Permissions;
        permissionsString: string;
        serverRelativeUrl: string;
        siteNumber?: string;
        type: Container;
        url: string;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiUrl availableLayerDefinitions containerId containerType etag format hasGeometry id language lcid mainProject? metadata metadataProperties? modifiedUtc name navigationAttributes? ownerSystem path permissions permissionsString serverRelativeUrl siteNumber? 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.

    containerType: string

    Type of container, for example "Project"

    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.

    format: string

    Format of change.

    hasGeometry: boolean

    Whether or not there is any geometry in the container. If true, parsed IFC files exist that are accessible to the user.

    id: string

    Id of change.

    language: string

    Language. Corresponds to lcid. Example: en-US

    lcid: Lcid

    Container language

    mainProject?: string

    Id of BimContainer that represents the main project.

    metadata: BimChangeBaseMetadata

    Metadata for change.

    metadataProperties?: {
        readonly [propertyName: string]: {
            displayName?: string;
            value?: string;
        };
    }

    Optional container metadata properties. May or may not be set.

    modifiedUtc: Date

    Time in UTC

    name: string

    Name of change.

    navigationAttributes?: [string, string][]

    Navigation attributes in format [[title, value], ..., [title, value]]

    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.

    serverRelativeUrl: string

    Server relative URL of container

    Use url instead.

    siteNumber?: string

    Site number

    type: Container

    Indicates change is a container

    url: string
    version: number

    Version of change

    Settings

    Member Visibility

    On This Page

    Properties