W-CF Documentation - v11.0.0
    Preparing search index...

    Interface AjaxOptions

    interface AjaxOptions {
        cache?: boolean;
        dataType?: AjaxDataType;
        headers?: { [key: string]: string };
        ignoreGlobalErrorHandler?: boolean;
        password?: string;
        responseType?: "auto" | XMLHttpRequestResponseType | "xml";
        retryAttempts?: number;
        timeout?: number;
        user?: string;
        withCredentials?: boolean;
    }
    Index
    cache?: boolean

    browser caching (default: true)

    dataType?: AjaxDataType

    Defines the type of the request data. Available types: post, queryString, json, text, arraybuffer, blob, document, xml or formdata (default: post)

    headers?: { [key: string]: string }

    object containing headers to be sent

    ignoreGlobalErrorHandler?: boolean

    if true the global ajaxErrorHandler will not be triggered in case of an error (default: false)

    password?: string

    the password to access to the URL, if needed

    responseType?: "auto" | XMLHttpRequestResponseType | "xml"

    The response type. Available types: auto, json, xml, text, arraybuffer, blob or document (default: auto) Note: use xml to parse the response always as xml using the DOMParser. If document is used the response will be parsed as xml or as html by the browser depending on the content-type of the response.

    retryAttempts?: number

    defines how many retry attempts will be performed in case of connection errors (default: 3)

    timeout?: number

    the timeout for the request in ms (default: 30000)

    user?: string

    the user to access to the URL, if needed

    withCredentials?: boolean

    sends credentials with the XHR request (default: false)