Class TwinfinityApiClientWithTwin

ReadonlybaseUrl

Readonlylayers

ReadonlymapBox

Readonlymessages

Readonlysettings

Readonlytwins

Readonlyupload

id

• get id(): string

  Hostname of baseUrl.

  Returns string

canDelete

• canDelete(__namedParameters: BimChange): boolean

  Parameters

  • __namedParameters: BimChange

  Returns boolean

  Inherit Doc

deleteChanges

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

  Parameters

  • changesToDelete: BimChange[]

  Returns Promise<TypedResponse<number>[]>

  Inherit Doc

get

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

  Type Parameters

  • T

  Parameters

  • absoluteUrl: string | URL
  • converter: (r: Response) => TypedResponse<T>
  • Optionalinit: RequestInit

  Returns Promise<TypedResponse<T>>

  Inherit Doc

getChanges

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

  Type Parameters

  • T extends BimChange = BimChange

  Parameters

  • parentOrUrl: URL | BimContainer | BimChange
  • options: { id: string } | { query: string } | { query: "all" }

  Returns Promise<TypedResponse<T[]>>

  Inherit Doc

getContainerInfo

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

  Parameters

  • OptionalcontainerOrUrl: URL | BimContainer

  Returns Promise<TypedResponse<BimContainerInfo>>

  Inherit Doc

getContainers

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

  Parameters

  • Optionalid: string

  Returns Promise<BimContainer[]>

  Inherit Doc

getIfcChanges

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

  Parameters

  • parentOrUrl: URL | BimContainer | BimChange

  Returns Promise<BimChangeIfc[]>

  Inherit Doc

getInfo

• getInfo(): Promise<TwinfinityInfo>

  Returns Promise<TwinfinityInfo>

  Inherit Doc

Staticcreate

• create(
      hostnameOrUrl: string | URL,
      options?: TwinfinityApiOptions,
  ): Promise<undefined | BimTwinfinityApiClient>

  Creates a new instance of BimTwinfinityApiClient by detecting available root URLs for the current user.

  Parameters

  • hostnameOrUrl: string | URL

    Hostname of the Twinfinity installation. If the hostname does not start with bim. it will be added automatically. Its ok to pass a full URL too, but only the hostname is used. Scheme is always set to https.
  • Optionaloptions: TwinfinityApiOptions

    Optional session used to get authorization header for requests.

  Returns Promise<undefined | BimTwinfinityApiClient>

  A promise that resolves to a new instance of BimTwinfinityApiClient. If no root URLs are detected, the promise resolves to undefined. undefined indicates that the user is not authorized or does not have access to any Twinfinity resources.

  Example

  const client = await BimTwinfinityApiClient.create('demo.projektstruktur.se');
  if (client == null) {
    console.log('User does not have access to any root URLs.');
    return;
  }
  const containers = await client.getContainers(); // Fetch containers from all available root URLs.
  console.log(containers);
  Copy

StaticdetectRootUrls

• detectRootUrls(baseUrl: URL, options?: TwinfinityApiOptions): Promise<URL[]>

  Detects the root URLs available for the current user given a base URL. The result depends on type of Twinfinity installation, how its configured and which resources the user has access to. The method will test the following root URLs:

  • {protocol}://{host}/sites/portal/
  • {protocol}://{host}/sites/archive/
  • {protocol}://{host}/workspaces/ Where {protocol} and {host} is taken from the provided baseUrl.

  Parameters

  • baseUrl: URL

    The base URL to detect root URLs for.
  • Optionaloptions: TwinfinityApiOptions

    Optional session used to get authorization header for requests.

  Returns Promise<URL[]>

  A promise that resolves to an array of detected root URLs.

  Example

  const baseUrl = new URL('https://bim.demo.projektstruktur.se');
  const rootUrls = await BimTwinfinityApiClient.detectRootUrls(baseUrl);
  console.log(rootUrls); // [ 'https://bim.demo.projektstruktur.se/sites/portal/', 'https://bim.demo.projektstruktur.se/sites/archive/' ]
  Copy