BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Class BimWorksClient<TClient>

    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.

    Type Parameters

    • TClient extends Client | null | undefined = Client | null | undefined
    Index

    Constructors

    Properties

    ai: Ai

    Natural-language actions on servers with AI enabled.

    auth: Auth

    Account registration. Authentication is configured by the client factory.

    bim: Bim
    checks: Checks
    client: Client
    fs: Fs
    geometry2d: Geometry2d
    geometry3d: Geometry3d
    gis: Gis
    ifc: Ifc
    info: Info

    General server information, including the application version.

    registerExpiredTokenHandler: (
        handler: (oldAuth: AuthToken) => Promise<AuthToken | undefined>,
    ) => void
    render: Render
    tokens: Tokens
    upload: Upload

    Methods

    • Register a callback invoked when the transport restores its connection.

      Parameters

      • listener: () => void

      Returns void

    • This method should be called as soon as you are done using the BimWorksClient

      Returns void

    • Runs a pre-signed download (a token from Tokens) and resolves with its URL

      Parameters

      • token: unknown

      Returns Promise<string>