Skip to main content

BimContainer

Represents a container. For example a project

Hierarchy

Index

Properties

Properties

readonlyapiUrl

apiUrl: string

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

readonlyavailableLayerDefinitions

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.

readonlycontainerId

containerId: string

Id of BimContainer to which this change belongs.

readonlycontainerType

containerType: string

Type of container, for example “Project”

readonlyetag

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.

readonlyformat

format: string

Format of change.

readonlyhasGeometry

hasGeometry: boolean

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

readonlyid

id: string

Id of change.

readonlylanguage

language: string

Language. Corresponds to lcid. Example: en-US

readonlylcid

lcid: Lcid

Container language

optionalreadonlymainProject

mainProject?: string

Id of BimContainer that represents the main project.

readonlymetadata

metadata: BimChangeBaseMetadata

Metadata for change.

optionalreadonlymetadataProperties

metadataProperties?: {}

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

Type declaration

  • [propertyName string]: { displayName?: string; value?: string }

readonlymodifiedUtc

modifiedUtc: Date

Time in UTC

readonlyname

name: string

Name of change.

optionalreadonlynavigationAttributes

navigationAttributes?: [string, string][]

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

readonlyownerSystem

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’.

readonlypath

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.

readonlypermissions

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.

readonlypermissionsString

permissionsString: string

String used to represent the permissions bitmask.

readonlyserverRelativeUrl

serverRelativeUrl: string

Server relative URL of container

@deprecated

Use url instead.

optionalreadonlysiteNumber

siteNumber?: string

Site number

readonlytype

type: Container

Indicates change is a container

readonlyurl

url: string

readonlyversion

version: number

Version of change