@umbraco-cms/backoffice
    Preparing search index...

    Interface XhrRequestOptions

    interface XhrRequestOptions {
        abortSignal?: AbortSignal;
        baseUrl?: string;
        body?: unknown;
        disableNotifications?: boolean;
        headers?: Record<string, string>;
        method: "DELETE" | "HEAD" | "GET" | "OPTIONS" | "PATCH" | "POST" | "PUT";
        onProgress?: (event: ProgressEvent) => void;
        responseHeader?: string;
        token?: string | (() => string | Promise<string | undefined> | undefined);
        url: string;
        withCredentials?: boolean;
    }

    Hierarchy (View Summary)

    Index
    abortSignal? baseUrl? body? disableNotifications? headers? method onProgress? responseHeader? token? url withCredentials?
    abortSignal?: AbortSignal

    Signal that cancels the request. When it aborts, the call resolves straight away with an UmbCancelError and shows no notification. A promise with a cancel() method, such as an UmbCancelablePromise, is cancelled too. To also stop a fetch request, pass the same signal to the request.

    baseUrl?: string

    Optionalbody

    body?: unknown
    disableNotifications?: boolean

    If set to true, the controller will not show any notifications at all.

    false
    headers?: Record<string, string>
    method: "DELETE" | "HEAD" | "GET" | "OPTIONS" | "PATCH" | "POST" | "PUT"
    onProgress?: (event: ProgressEvent) => void
    responseHeader?: string
    token?: string | (() => string | Promise<string | undefined> | undefined)
    url: string
    withCredentials?: boolean

    Settings
    Member Visibility

    On This Page
    Properties