TwinfinityApiClientWithTwin

Hierarchy

• BimTwinfinityApiClient
  • TwinfinityApiClientWithTwin

Index

Constructors

• constructor

Properties

• baseUrl
• layers
• mapBox
• messages
• settings
• upload

Accessors

• id

Methods

• canDelete
• deleteChanges
• get
• getChanges
• getContainerInfo
• getContainers
• getIfcChanges
• getInfo
• getTwinIfcChanges
• getTwins

Constructors

constructor

• new TwinfinityApiClientWithTwin(baseUrl: URL): TwinfinityApiClientWithTwin

• Inherited from BimTwinfinityApiClient.constructor

  Constructor

  ---

  Parameters

  • baseUrl: URL

    Url to twinfinity. Example: https://bim.demo.projektstruktur.se or https://bim.demo.projektstruktur.se/sites/portal/projects/projectA

  Returns TwinfinityApiClientWithTwin

Properties

readonlybaseUrl

baseUrl: URL

Inherited from BimTwinfinityApiClient.baseUrl

readonlylayers

layers: LayerApiClient

Inherited from BimTwinfinityApiClient.layers

Access to layer operations.

readonlymapBox

mapBox: MapBoxApiClient

Inherited from BimTwinfinityApiClient.mapBox

Access to MapBox operations.

readonlymessages

messages: MessageApiClient

Inherited from BimTwinfinityApiClient.messages

Access to message operations.

readonlysettings

settings: SettingsApiClient

Inherited from BimTwinfinityApiClient.settings

Access to settings operations.

readonlyupload

upload: UploadApiClient

Inherited from BimTwinfinityApiClient.upload

Access to upload operations.

Accessors

id

• get id(): string

• Inherited from BimTwinfinityApiClient.id

  Hostname of baseUrl.

  ---

  Returns string

Methods

canDelete

• canDelete(__namedParameters: BimChange): boolean

• Inherited from BimTwinfinityApiClient.canDelete

  @inheritDoc

  ---

  Parameters

  • __namedParameters: BimChange

  Returns boolean

deleteChanges

• deleteChanges(changesToDelete: BimChange[]): Promise<TypedResponse<number>[]>

• Inherited from BimTwinfinityApiClient.deleteChanges

  @inheritDoc

  ---

  Parameters

  • changesToDelete: BimChange[]

  Returns Promise<TypedResponse<number>[]>

get

• get<T>(absoluteUrl: string | URL, converter: (r: Response) => TypedResponse<T>, init?: RequestInit): Promise<TypedResponse<T>>

• Inherited from BimTwinfinityApiClient.get

  @inheritDoc

  ---

  Type parameters

  • T

  Parameters

  • absoluteUrl: string | URL

  • converter: (r: Response) => TypedResponse<T>

  • optionalinit: RequestInit

  Returns Promise<TypedResponse<T>>

getChanges

• getChanges<T>(parentOrUrl: URL | BimChange | BimContainer, options: { id: string } | { query: string } | { query: all }): Promise<TypedResponse<T[]>>

• Inherited from BimTwinfinityApiClient.getChanges

  @inheritDoc

  ---

  Type parameters

  • T: BimChange = BimChange

  Parameters

  • parentOrUrl: URL | BimChange | BimContainer

  • options: { id: string } | { query: string } | { query: all }

  Returns Promise<TypedResponse<T[]>>

getContainerInfo

• getContainerInfo(containerOrUrl?: URL | BimContainer): Promise<TypedResponse<BimContainerInfo>>

• Inherited from BimTwinfinityApiClient.getContainerInfo

  @inheritDoc

  ---

  Parameters

  • optionalcontainerOrUrl: URL | BimContainer

  Returns Promise<TypedResponse<BimContainerInfo>>

getContainers

• getContainers(id?: string): Promise<BimContainer[]>

• Inherited from BimTwinfinityApiClient.getContainers

  @inheritDoc

  ---

  Parameters

  • optionalid: string

  Returns Promise<BimContainer[]>

getIfcChanges

• getIfcChanges(parentOrUrl: URL | BimChange | BimContainer): Promise<BimChangeIfc[]>

• Inherited from BimTwinfinityApiClient.getIfcChanges

  @inheritDoc

  ---

  Parameters

  • parentOrUrl: URL | BimChange | BimContainer

  Returns Promise<BimChangeIfc[]>

getInfo

• getInfo(): Promise<TwinfinityInfo>

• Inherited from BimTwinfinityApiClient.getInfo

  @inheritDoc

  ---

  Returns Promise<TwinfinityInfo>

publicgetTwinIfcChanges

• getTwinIfcChanges(twin: Twin): Promise<BimChangeIfc[]>

• Parameters

  • twin: Twin

  Returns Promise<BimChangeIfc[]>

publicgetTwins

• getTwins(): Promise<Twin[]>

• Returns Promise<Twin[]>