@eclipse-scout/core/dist/d.ts/src/ajax/ajax.d.ts

Eclipse Scout runtime

/// <reference types="jquery" />
import { AjaxCall, AjaxCallModel, AjaxError } from '../index';
/**
 * Utility to perform AJAX requests via HTTP in an easy way. It provides some common functions to call a REST backend using {@link AjaxCall}.
 */
export declare const ajax: {
    /**
     * Performs an HTTP GET request.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    get(url: string, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP POST request.
     *
     * @param data the data to be sent.
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    post(url: string, data?: any, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP PUT request.
     *
     * @param data the data to be sent.
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    put(url: string, data?: any, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP DELETE request.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    remove(url: string, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP request.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    call(options: UrlAjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Prepares an {@link AjaxCall}, but does not execute it yet.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns the prepared {@link AjaxCall}. Execute it with the `call()` function.
     */
    createCall(options: UrlAjaxSettings, model?: AjaxCallModel): AjaxCall;
    /**
     * Performs an HTTP GET request using JSON as format for the request and the response.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    getJson(url: string, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP POST request using JSON as format for the request and the response.
     *
     * @param data the data to be sent. If the data is not a string it will be converted to a string using JSON.stringify().
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    postJson(url: string, data?: any, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP PUT request using JSON as format for the request and the response.
     *
     * @param data the data to be sent. If the data is not a string it will be converted to a string using JSON.stringify().
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    putJson(url: string, data?: any, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP DELETE request using JSON as format for the request and the response.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    removeJson(url: string, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP request using JSON as format for the request and the response.
     * The default HTTP method is POST.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns a promise which is resolved when the request succeeds.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    callJson(options?: UrlAjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Prepares an HTTP call with JSON as format for the request and the response, but does not execute it yet.
     * The default HTTP method is POST.
     *
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall}.
     * @returns the prepared Ajax call object. Execute it with the call() function.
     */
    createCallJson(options?: UrlAjaxSettings, model?: AjaxCallModel): AjaxCall;
    /**
     * Performs an HTTP GET request to the given URL.
     * Supports automatic {@link BaseDoEntity} deserialization of the response.
     *
     * @param url The URL of the request.
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall} which is created to perform the request.
     * @returns A promise which is resolved when the request succeeds.
     *          If the response is a data object it will be automatically converted to a {@link BaseDoEntity}.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    getDataObject(url: string, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP POST request using JSON as format for the request and the response.
     * Supports automatic {@link BaseDoEntity} serialization and deserialization of the request data and response.
     *
     * @param url The URL of the request.
     * @param data The data to be sent or `null`.
     *        If it is a {@link BaseDoEntity} it will automatically be converted to a string using {@link dataObjects.stringify}.
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall} which is created to perform the request.
     * @returns A promise which is resolved when the request succeeds.
     *          If the response is a data object it will be automatically converted to a {@link BaseDoEntity}.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    postDataObject(url: string, dataObject?: any, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP PUT request using JSON as format for the request and the response.
     * Supports automatic {@link BaseDoEntity} serialization and deserialization of the request data and response.
     *
     * @param url The URL of the request.
     * @param data The data to be sent or `null`.
     *        If it is a {@link BaseDoEntity} it will automatically be converted to a string using {@link dataObjects.stringify}.
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall} which is created to perform the request.
     * @returns A promise which is resolved when the request succeeds.
     *          If the response is a data object it will be automatically converted to a {@link BaseDoEntity}.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    putDataObject(url: string, data?: any, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP DELETE request using JSON as format for the request and the response.
     * Supports automatic {@link BaseDoEntity} serialization and deserialization of the request data and response.
     *
     * @param url The URL of the request.
     * @param data The data to be sent or `null`.
     *        If it is a {@link BaseDoEntity} it will automatically be converted to a string using {@link dataObjects.stringify}.
     * @param options additional settings for the request.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param model additional properties for the {@link AjaxCall} which is created to perform the request.
     * @returns A promise which is resolved when the request succeeds.
     *          If the response is a data object it will be automatically converted to a {@link BaseDoEntity}.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    removeDataObject(url: string, data?: any, options?: AjaxSettings, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Performs an HTTP request using JSON as format for the request and the response.
     * Supports automatic {@link BaseDoEntity} serialization and deserialization of the request data and response.
     *
     * @param options Settings for the request. Must contain the properties `url` and `method`.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param data The data to be sent or `null`.
     *        If it is a {@link BaseDoEntity} it will automatically be converted to a string using {@link dataObjects.stringify}.
     * @param model additional properties for the {@link AjaxCall} which is created to perform the request.
     * @returns A promise which is resolved when the request succeeds.
     *          If the response is a data object it will be automatically converted to a {@link BaseDoEntity}.
     *          In case of an error the promise is rejected with an {@link AjaxError}.
     */
    callDataObject(options: UrlAjaxSettings, data?: any, model?: AjaxCallModel): JQuery.Promise<any, AjaxError>;
    /**
     * Creates an {@link AjaxCall} which sends the given data object as json.
     * Supports automatic {@link BaseDoEntity} serialization and deserialization.
     *
     * @param options Settings for the request. Must contain the property 'url' and 'method'.
     *        Since jQuery is used to perform the request, all {@link https://api.jquery.com/jQuery.ajax/ jQuery.ajax} settings are accepted.
     * @param data The data to be sent or `null`.
     *        If it is a {@link BaseDoEntity} it will automatically be converted to a string using {@link dataObjects.stringify}.
     * @param model Properties for the {@link AjaxCall} which is created.
     * @returns an {@link AjaxCall} which sends the given data, pre-configured using the given options and model.
     *          If the response is a data object it will be automatically converted to a {@link BaseDoEntity}.
     */
    createCallDataObject(options: UrlAjaxSettings, data?: any, model?: AjaxCallModel): AjaxCall;
};
/**
 * Like JQuery.AjaxSettings without 'type' property. Use 'method' instead.
 */
export type AjaxSettings = Omit<JQuery.AjaxSettings, 'type'>;
/**
 * Like JQuery.UrlAjaxSettings without 'type' property. Use 'method' instead.
 */
export type UrlAjaxSettings = AjaxSettings & {
    url: string;
};
//# sourceMappingURL=ajax.d.ts.map