Class BimWorksClient

The main entry point to the BIM.works API. This is usually a short-lived object, but there is no reason to not use it for longer. For better organization, the BIM.works API is namespaced in about a dozen different namespaces. These namespaces are also used in the JS SDK. Each namespaced API is available as a readonly attribute on the BimWorksClient.

Hierarchy

  • BimWorksClient

Constructors

constructor

Properties

bim checks client fs geometry2d geometry3d gis ifc registerExpiredTokenHandler render tokens upload

Methods

close loginAnonymous loginWithApiToken loginWithUsernamePassword setAuth

Constructors

constructor

Properties

Readonly bim

bim: Bim

Readonly checks

checks: Checks

Readonly client

client: Client

Readonly fs

fs: Fs

Readonly geometry2d

geometry2d: Geometry2d

Readonly geometry3d

geometry3d: Geometry3d

Readonly gis

gis: Gis

Readonly ifc

ifc: Ifc

registerExpiredTokenHandler

registerExpiredTokenHandler: ((handler: ((oldAuth: AuthToken) => Promise<AuthToken>)) => void)

Type declaration

    • (handler: ((oldAuth: AuthToken) => Promise<AuthToken>)): void

    • Parameters

      • handler: ((oldAuth: AuthToken) => Promise<AuthToken>)
          • (oldAuth: AuthToken): Promise<AuthToken>

          • Parameters

            • oldAuth: AuthToken

            Returns Promise<AuthToken>

      Returns void

Readonly render

render: Render

Readonly tokens

tokens: Tokens

Readonly upload

upload: Upload

Methods

close

Private loginAnonymous

Private loginWithApiToken

  • Parameters

    • apiToken: AuthToken

    Returns Promise<void> | Promise<Error>

Private loginWithUsernamePassword

  • Parameters

    • username: string
    • password: string

    Returns Promise<void> | Promise<Error>

Private setAuth

  • Parameters

    • auth: AuthToken

    Returns Promise<void> | Promise<Error>

Settings

Member Visibility

Theme

Generated using TypeDoc