BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Class BimWorksClientFactory

    Index

    Constructors

    Methods

    • Create an anonymous BIM.works client. The returned BimWorksClient will usually not be very usefull as anonymous users can't do much in BIM.works. This can be useful for getting information about the deployed BIM.works version for example, or to simply test connectivity.

      Returns Promise<BimWorksClient<Client | null | undefined>>

    • Create a new BimWorksClient based on the provided API Token. Please refer to generic BIM.works documentation about how to create API Tokens.

      Parameters

      • token: string

      Returns Promise<BimWorksClient<Client | null | undefined>>

    • Create a new BimWorksClient based on the provided Auth Token. Please refer to generic BIM.works documentation about how to create Auth Tokens.

      Parameters

      Returns Promise<BimWorksClient<Client | null | undefined>>

    • Create a new BimWorksClient based on the provided username/password. This method is not recommended, on most cases using an API Token or Auth Token is safer/more stable.

      Parameters

      • username: string
      • password: string

      Returns Promise<BimWorksClient<Client | null | undefined>>

    • Leaves the runtime and the platform out of what the clients send from now on.

      Returns this

    • Names your application, sent with every request from now on (the app of the X-BIMworks-Client header). It tells BIM.works support which of your integrations made a call. Letters, digits and . _ + -.

      Parameters

      • name: string
      • Optionalversion: string | null

      Returns this