matrix-js-sdk
    Preparing search index...

    Interface IHttpOpts

    Options object for FetchHttpApi and MatrixHttpApi.

    interface IHttpOpts {
        accessToken?: string;
        baseUrl: string;
        extraParams?: QueryDict;
        fetchFn?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        idBaseUrl?: string;
        localTimeoutMs?: number;
        logger?: Logger;
        onlyData?: boolean;
        prefix: string;
        refreshToken?: string;
        tokenRefreshFunction?: TokenRefreshFunction;
        useAuthorizationHeader?: boolean;
    }
    Index

    Properties

    accessToken? baseUrl extraParams? fetchFn? idBaseUrl? localTimeoutMs? logger? onlyData? prefix refreshToken? tokenRefreshFunction? useAuthorizationHeader?

    Properties

    accessToken?: string
    baseUrl: string
    extraParams?: QueryDict
    fetchFn?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Type Declaration

    idBaseUrl?: string
    localTimeoutMs?: number
    logger?: Logger

    Optional logger instance. If provided, requests and responses will be logged.

    onlyData?: boolean

    For historical reasons, must be set to true. Will eventually be removed.

    prefix: string
    refreshToken?: string

    Used in conjunction with tokenRefreshFunction to attempt token refresh

    tokenRefreshFunction?: TokenRefreshFunction

    Function to attempt token refresh when a possibly expired token is encountered Optional, only called when a refreshToken is present

    useAuthorizationHeader?: boolean

    Whether to use the HTTP Authorization header over the access_token query parameter

    as of v1.11 in https://spec.matrix.org/v1.17/client-server-api/#using-access-tokens

    Settings

    Member Visibility

    On This Page

    Properties