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

    Constructors

    Methods

    • Parameters

      • listener: () => void

      Returns void

    • Parameters

      Returns void

    • Names a BIM.works package that uses this client, e.g. a viewer; a second call replaces its version.

      Parameters

      • name: string
      • Optionalversion: string | null

      Returns void

    • The headers to add to a request to url: X-BIMworks-Client, and in Node.js the User-Agent. In a browser only on a same-origin request or one that is preflighted anyway, so no request gets an extra CORS preflight.

      Parameters

      • url: string
      • Optionalinit: RequestInit

      Returns Record<string, string>

    • Returns void

    • Returns XMLHttpRequest

    • Reconnect the socket now (a request answered NODE_GONE).

      Returns void

    • The node the main socket is on; null before the first hello, or from a server without a fleet.

      Returns ServerInfo | null

    • Parameters

      • client: Client
      • id: string
      • name: string
      • OptionalnodeId: string

      Returns Task

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • task: Pick<Task, "id">

      Returns void

    • What the client says it is from now on; an open socket hears it at once.

      Parameters

      Returns void

    • Parameters

      • fetchOptionsInterceptor: unknown

      Returns void

    • Parameters

      • xmlHttpRequestCreationInterceptor: unknown

      Returns void