@twinfinity/core
    Preparing search index...

    Interface TwinfinityApiOptions

    Represents a authentication session used by BimApi and BimTwinfinityApiClient.

    interface TwinfinityApiOptions {
        applicationName?: string;
        httpClient?: TwinfinityHttpClient;
        session?: {
            getAuthorizationHeader: () => Promise<string>;
            origin?: string;
        };
    }
    Index

    Properties

    applicationName? httpClient? session?

    Properties

    applicationName?: string

    Application name used to identify the client in request headers and telemetry. If not provided, defaults to -unknown-.

    httpClient?: TwinfinityHttpClient

    HTTP client to make requests to Twinfinity API.

    session?: { getAuthorizationHeader: () => Promise<string>; origin?: string }

    Session used to get authorization header for requests. If not provided, requests will be made without an authorization header. If provided, the client will use this session to get the authorization header for each request. If the session carries an origin, BimApi.create verifies that the URL it is pointed at lives on the same origin.

    Settings

    Member Visibility

    On This Page

    Properties