/AjaxCommunicationProtocol

A simple communication protocol for ajax actors.

AjaxCommunicationProtocol

2019-09-05 -> 2021-03-05

A simple communication protocol for ajax actors.

This is part of the universe framework.

Install

Using the planet installer via light-cli

lt install Ling.AjaxCommunicationProtocol

Using the uni command.

uni import Ling/AjaxCommunicationProtocol

Or just download it and place it where you want otherwise.

The ajax communication protocol

There are two actors:

  • the client: which sends a request to the server, and process the response
  • the server: which process the request sent by client, and returns a response

The request is usually done via POST, but can also be done via GET when it's more convenient. The response is a json array which structure depends on whether the response is erroneous or successful.

In case of an erroneous response, the json response array has the following structure:

  • type: error (fixed string)
  • error: string, the error message

In case of a successful response, the json response array has the following structure:

  • type: success (fixed string)
  • ... (depending on what the client and the server have agreed upon)

Jquery implementation example

If you're a jquery user, this snippet might help you getting started:

$.ajax({
    type: "POST",
    url: "/myurl",
    data: data,
    success: function (response) {
        var type = response.type;
        if ('error' === type) {
            errorHandler(response.error);
        } else if ('success' === type) {
            successHandler(response);
        } else {
            $this.error("Unknown response type from the server.");
        }
    },
    dataType: "json",
});

History Log

  • 1.1.4 -- 2021-05-31

    • Removing trailing plus in lpi-deps file (to work with Light_PlanetInstaller:2.0.0 api

  • 1.1.3 -- 2021-03-05

    • update README.md, add install alternative

  • 1.1.2 -- 2020-12-08

    • Fix lpi-deps not using natsort.

  • 1.1.1 -- 2020-12-04

    • Add lpi-deps.byml file

  • 1.1.0 -- 2019-09-24

    • update protocol, now accepts GET parameters

  • 1.0.1 -- 2019-09-18

    • add jquery example

  • 1.0.0 -- 2019-09-05

    • initial commit