Класс y5.Request

Абстрактный класс для создания запросов AJAX.

Требует загрузки модуля Request.

new

new y5.Request(url, params)

Имя аргументаТипОписание
urlString, y5.URLURL запроса
paramsObjectпараметры запроса

Пример:

// Пример запроса (на примере y5.Request.XML).
var req = new y5.Request.XML("test.xml");
req.onload = function(req) { alert(req.responseText) };
req.onexception = function(e) { alert(e.message) };
req.send();

// Запрос, обработчики которого находятся в объекте
var obj = {
    errorMessage: 'Ошибка загрузки',
    onload: function(req) { alert(req.responseText) },
    onerror: function() { alert(this.errorMessage) }
};

var req = new y5.Request.XML("test.xml", { callbackObject: obj });
req.send();


Типы событий на выполнение запроса:

loading: возникает при отправке запроса
load: возникает при успешном завершении запроса и получении запрашиваемых данных
error: ошибка при выполнении запроса
abort: возникает при прерывании запроса с помощью функции abort()
exception: ошибка связанная с работой приложения
complete: возникает всегда по завершении запроса, если не возникло исключения
{код ответа сервера}: например '200'. Если сервер вернул определенный статус и существует
функция такого вида, то она будет вызвана


Функции, реагирующие на события можно привязывать разными способами:

1) Непосредственное назначение функции экземпляру объекта (имя функции -- on{тип события}).
2) В параметрах при создании экземпляра класса ({onload: function() {}})
3) Навешивание функций на события. При возникновении события посылается сообщение
   типа request:{тип события} для ID указанного в параметрах при создании экземпляра.


Объект возвращаемый при получении запроса имеет следующие свойства:

responseText: тело ответа
text(): функция возвращает responseText с удаленными начальными и концевыми пробельными символами
getResponseHeader(header): возвращает заголовок ответа
status: код ответа (если статус в диапазоне от 200 до 299, то возникает событие load, иначе error)

abort

abort()

Прерывает запрос.

params

params -> Object

Параметры по умолчанию.

Пример:

// параметры по умолчанию
{
    // идентификатор запроса
    id: null,

    // метод запроса
    method: 'get',

    // функция выполняемая при исключении
    onexception: onExceptionDefault,

    // контекст выполнения функций callback
    callbackContext: null,

    // объект содержащий функции callback
    callbackObject: null
}

send

send(query)

Посылает запрос.

Имя аргументаТипОписание
queryString, Objectданные запроса в виде запроса GET или объекта

Пример:

req.send('foo=1&bar=2');
req.send({foo: 1, bar: 2});

toString

toString() -> String — название класса

Возвращает название класса.