Skip to main content

BimFolder

Represents a folder

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.

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.

readonlyfolderFileCount

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

readonlyformat

format: string

Format of change.

readonlyid

id: string

Id of change.

readonlymetadata

metadata: { serverRelativeUrl: string } & BimChangeBaseMetadata

Metadata for change.

readonlyname

name: string

Name of change.

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.

readonlytype

type: Folder

readonlyurl

url: string

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

readonlyversion

version: number

Version of change