Options
Menu

Class Ajax

Helper Class to perform specific asynchronous HTTP (Ajax) request.

important

Please use static ajax instead of new ix.Ajax() for better update support!

Hierarchy

  • Ajax

Index

Methods

Methods

request

  • request(url?: null | string, settings?: IxAjaxSettings): Deferred<any, any, any> | jqXHR<any>

  • Send a request to the server.

    Parameters

    • Optional url: null | string

      The location of the file on the server.

    • Optional settings: IxAjaxSettings

      Ajax settings e.g. {dataType: 'json', urlParameters: {}}

    Returns Deferred<any, any, any> | jqXHR<any>

    jQuery Deferred object

requestAppGroovy

  • requestAppGroovy(groovyFile: string, settings: IxAjaxSettings, appContext?: UpObject | HTMLElement): Deferred<any, any, any>

  • Request a groovy file, stored in the current application.

    example
    ix.ajax().requestAppGroovy('newGuid.groovy', {
    dataType: "json",
    data: {
        "hello": "world!"
    },
    success: function (data) {
        Notifier.status.notify(data.guids.join("<br>"));
    }
}, ix.util.getHtml("<GUID>"));

    Parameters

    • groovyFile: string

      Path to a groovy file started after application/${application.guid}/groovy/.

    • settings: IxAjaxSettings

      Ajax settings e.g. {dataType: 'json', urlParameters: {}}.

    • Optional appContext: UpObject | HTMLElement

      Element object represents an HTML element.

    Returns Deferred<any, any, any>

    jQuery Deferred object

requestGroovy

  • requestGroovy(groovyFile: string, settings: IxAjaxSettings): Deferred<any, any, any> | jqXHR<any>

  • Request a groovy file.

    example
    ix.ajax().requestGroovy('groovy/de/uplanet/lucy/samples/newGuid.groovy', {
    dataType: "json",
    data: {
        "hello": "world!"
    },
    success: function (data) {
        Notifier.status.notify(data.guids.join("<br>"));
    }
});

    Parameters

    • groovyFile: string

      Path to a groovy file (should be in the portal groovy directory: <portal>/groovy).

    • settings: IxAjaxSettings

      Ajax settings e.g. {dataType: 'json', urlParameters: {}}.

    Returns Deferred<any, any, any> | jqXHR<any>

    jQuery Deferred object

setAppContext

  • setAppContext(element: UpObject | HTMLElement): Deferred<any, any, any> | Ajax

  • Add the current application page context informations (Request-Params e.g. rq_AppGuid and form fields) to the current ix.Ajax object.

    example
    var ixAjax = ix.ajax();
ixAjax.setAppContext(ix.util.getHtml("<GUID>"));
ixAjax.requestGroovy('groovy/de/uplanet/lucy/samples/newGuid.groovy', {
    data: {
        "hello": "world!"
    },
    success: function (data) {
        Notifier.status.notify(data.guids.join("<br>"));
    }
});

    Parameters

    • element: UpObject | HTMLElement

      Element object represents an HTML element.

    Returns Deferred<any, any, any> | Ajax

    jQuery Deferred object