XYO Platform SDK - v3.10.6
    Preparing search index...
    interface ApiConfig {
        apiDomain: string;
        apiKey?: string;
        compressionThreshold?: number;
        jwtToken?: string;
        onError?: (error: ApiError, depth: number) => void;
        onFailure?: (response: ApiResponse, depth: number) => void;
        onSuccess?: (response: ApiResponse, depth: number) => void;
        query?: string;
        reportableParent?: ApiReportable;
        root?: string;
        throwError?: boolean;
        throwFailure?: boolean;
        userid?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiDomain: string

    The domain where the api is located

    apiKey?: string

    The apiKey used for authentication

    compressionThreshold?: number

    Threshold for Content-Size to cause automatic gzip of request body [default = 1024]

    jwtToken?: string

    The jwtToken of the currently logged in user

    onError?: (error: ApiError, depth: number) => void
    onFailure?: (response: ApiResponse, depth: number) => void
    onSuccess?: (response: ApiResponse, depth: number) => void
    query?: string

    The query string, if any, that is added to the end of every request

    reportableParent?: ApiReportable

    Parent that should also report events from this api

    root?: string

    The location in the API tree where this API object is mounted

    throwError?: boolean

    Throw on error

    throwFailure?: boolean

    Throw on failures

    userid?: string

    use the jwtToken instead