options: набор парных ключей/значений, конфигурирующих Ajax запрос. Все опции необязательны. По умолчанию может быть устанволена любая опция
$.ajaxSetup().
async:
По умолчанию: true. По умолчанию все запросы являются асинхронными (значение опции в этом случае устнаолено как true). Если Вам необходим синхронный запрос установите данную опцию как false. Однако будьте внимательны, так как синхронные запросы могут временно блокировать работу браузера, отключая любые действия, производимые пользователем до тех пор, пока запрос выполняется.
Возвращаемый тип: логический
beforeSend(XMLHttpRequest): Опция позволяет установить функцию, для модифицкации объекта XMLHttpRequest до того как он будет отправлен. Данная опция является ajax событием, поэтому для отмены отправки запроса Вам необходимо вернуть false из функции.
Возвращаемый тип: функция.
cache:
По умолчанию: true, false для опции dataType содержащей значения 'script' and 'jsonp'. Установив значение опции как false, вы предотвратите кэширование запросов браузером.
Возвращаемый тип: логический.
complete(XMLHttpRequest, textStatus): Опция содержит функцию, выполняемую после завершения ajax запроса (после события success и всех ajax ошибок). Данная функция передает два аргумента: объект XMLHttpRequest и строку, содержащую статус успешности завершения запроса. Данная опция является ajax событием.
Возвращаемый тип: функция.
contentType:
По умолчанию: 'application/x-www-form-urlencoded'. При пересылке данных на сервер используйте данную опцию, определяющую тип данные. По умолчанию данная опция содержит "application/x-www-form-urlencoded", что является удобным в большинстве запросов. Вы можете полностью удалить значение данной опции, после этого все запросы будут отправляться с пустым значением.
Возвращаемый тип: строка.
context: Объект, создающий контекст для связанной функции обратного вызова. К примеру, если указать в качеств контекста элемент DOM, то данный элемент будет доступен в функции обратного вызова.
Возвращаемый тип: объект.
Пример использования данной опции:
$.ajax({
url: "test.html",
context: document.body,
success: function(){
$(this).addClass("done");
}
});
converters: Опция добавлена в jQuery 1.5.
По умолчанию значение опции: {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}.
Каждое значение конвертируется в зависимости от типа поступивших данных.
response = $.ajax({
converters: {
"* text": window.String,
"text html": true,
"text json": jQuery.parseJSON,
"text xml": function(data){return data.toUpperCase()}
},
type: "POST",
url: "test1.php",
dataType: "xml",
cache: "false",
success: function(result) {
alert($(result).find("city").text());
}
});
contents(added 1.5):
Объект, содержащий строку или регулярное выражение, указывающий порядок разбора ответа сервера.
crossDomain:
Опция добавлена в 1.5. По умолчанию: false, то есть запросы осуществляются на тот же домен, если true, то допустимы запросы на другой домен, однако это верно для json, так как другие типы данных имеют ограничения, связанные с политикой безопасности, то есть не поддерживают возможности перенаправления. Только для json и script допускается перенаправление запроса на другой домен.
data: Опция содержит данные, отсылаемые на сервер. Данные конвертируются в строку, отсылаемую в качестве запроса. Строка прикрепляется к URL, если Вы используете GET запрос. Для того чтобы предотвратить автоматическую конвертацию данных в строку используйте опцию processData. В данной опции объект должен содержать парные ключ/значение. Если значение является массивом, jQuery объединит данные, например массив {foo:["bar1", "bar2"]} будет выглядеть следующим образом: "foo=bar1foo=bar2".
Возвращаемый тип: объект, строка.
dataFilter(data, type): Функция применяется для фильтрации данных получаемых от сервера. При использовании данного метода Вы должны сперва убедиться в корректности возвращаемых данных сервером. Функция передаёт два аргумента:
возвращенные необработанные данные от сервера и параметр dataType.
Возвращаемый тип: функция.
dataType: По умолчанию: опция самостоятельно определяет тип возвращаемых данных, если им является один из следующих типов данных: xml, json, script, html.
Опция определяет тип данных, которые Вы ожидаете получить от сервера. Если опция не указана, то jQuery самостоятельно пытается определить тип основываясь на данных MIME ответа (например тип ответа XML MIME будет представлен как XML, в версии 1.4 JSON будет представлен как объект, если script, то будет выполнен скрипт, ). Допустимые типы:
- "xml": означает, что возвращается XML документ, который может быть обработан через jQuery.
- "html": означает, что возвращается HTML как обычный текст; включающий теги, с помощью которых происходит разбор и вставка элементов в структуру DOM.
- "script": означает, что возвращается тип данных JavaScript и возвращает обычный текст. для правильной работы данной опции отключите опцию кэширования. Примечание: при использовании данной опции запрос автоматически изменяется с POST на GET если вы запрашивает скрипт с удаленного сервера.
- "json": опция рассматривает данные как JSON и возвращает объект JavaScript. В jQuery 1.4 повышены требования к структуре данных JSON и их разбору, любые незначительные ошибки в этой структуре прекращают получение данных и вызывают исключение, содержащее ошибку.
- "jsonp": опция дополняет URL дополнительными значениями - "?callback=?" для определения функции обратного вызова.
- "text": возвращается обычный текст.
Так же в версии 1.5 допускается конвертировать определенный тип данных, возвращаемых сервером, в другой тип данных. Указывая следующий вариант "text xml" вы преобразуете обычный текст в xml формат или "jsonp text xml", что означает рассматривать json формат как xml, если не уазать между ними text, то будет предпринята попытка сразу переконвертировать json в xml, но ошибочная, однако после json всё равно будет преобразован в text, а после в json.
error(XMLHttpRequest, textStatus, errorThrown): Опция определяет функцию, вызываемую, если в процессе запроса произошли ошибки. Функция передаёт три аргумента: объект XMLHttpRequest, тип ошибки, третий аргумент – необязательное исключение.
Возможные значения для второго аргумента кроме "null" - "timeout", "error", "notmodified" и "parsererror".
Данная опция является ajax событием. Возвращаемый тип: функция.
global: Опция позволяет установить, как использовать обработчик ajax события - глобально или нет. По умолчанию установлено true. Для того чтобы отключить глобальные обработчики, например для событий ajaxStart и ajaxStop, укажите false в данной опции. Данный метод используется для контроля различных событий.
Возвращаемый тип: логический.
headers(добавлено в версии 1.5):
Опция допускает ajax запрос только в случае изменения заголовка "Last-Modified". По умолчанию установлена как false, то есть данный заголовок игнорируется. В jQuery 1.4 так же проверке подлежит заголовок "etag".
$.ajax({
headers: {
"Content-Type": "application/json",
"Accept": "application/json"
},
type: "POST",
url: "/JSON-RPC",
data: jsonData,
dataType: "json",
success: function(json){
ваш код...
}
});
statusCode. Добавлено в jQuery 1.5:
Опция содержит функцию, выполняемую при получении статуса ответа определнного типа, пример, если страница существует, то выводим сообщение:
$(function(){
$.ajax({
url: 'test.php',
statusCode: {200: function() {
alert('Страница существует!');
}}
});
});
Наоборот, если страница не существует:
$(function(){
$.ajax({
url: 'test.php',
statusCode: {404: function() {
alert('Страница не существует!');
}}
});
});
В функцию передаются те же параметры, что и в опции success, если запрос завершился успешно, если запрос завершился ошибкой, то те же параметры что в опции еrror.
ifModified: По умолчанию: false. Опция позволяет отправить запрос только в том случае, если предыдущий ответ изменился. Опция проверяет ответ через заголовок Last-Modified. По умолчанию опция установлена как false, то есть все заголовки игнорируются. В jQuery 1.4 данная техника дополнена поверкой заголовка etag.
Возвращаемый тип: логический.
jsonp: По умолчанию: false. Данная опция позволяет заменить из Url название функции обратного вызова, при использовании запроса jsonp. Новое значение будет использоваться вместо 'callback' в 'callback=?, в строке, передаваемой в URL при использовании запроса GET или в объекте, если тип запроса POST. То есть опция {jsonp:'onJsonPLoad'} будет представлены как 'onJsonPLoad=?' и переданы на сервер.
Возвращаемый тип: логический.
jsonpCallback: Данная опция определяет название функции обратного вызова при использовании запроса jsoonp. Данное имя будет использоваться вместо случайного автоматически созданного jQuery имени. Автоматическое создание имени предпочтительнее использовать в jQuery, так как с ним удобнее работать. Однако если Вам нужно улучшить кэширование запросов к серверу, вы можете определить имя функции.
password: Данная опция устанавливает пароль в ответ на запрос сервера при аутентификации.
username: Опция содержит имя пользователя, данная опция используется при аутентификации в ответе на запрос сервера.
processData:
По умолчанию: true. Ао умолчанию данные переданные через опцию data, трансформируются в строку, подходящую при использовании типа содержимого "application/x-www-form-urlencoded". Однако, если вы хотите передать, к примеру DOMDocument или другие необработанные данные, то установите значение данной опции как false.
Возвращаемый тип: логический.
scriptCharset : Данная опция допустима если dataType "jsonp" или "script" и тип запроса является "GET". Опция заставляет запрос интерпретироваться в указанной кодировке.
success(data, textStatus, XMLHttpRequest): Опция определяет функцию, выполняемую, если запрос завершился успешно. Функция передаёт три аргумента:
data - данные, возвращаемые от сервера, форматируемые в соответствие с параметрами, указанными в опции dataType,
textStatus - строка, содержащая статус ответа,
и объект XMLHttpRequest.
Опция является событием ajax.
timeout: Опция устанавливает период времени для выполнения запроса. С помощью данной опции вы можете отключить глобальный период времени в ходе которого выполняется запрос. О глобально периоде выполнения запроса смотрите в описании метода $.ajaxSetup().
Возвращаемый тип: число.
traditional: Опция устанавливает тип объединения данных. Для использования традиционной типа объединения, того который установлен как приоритетный для функции .param(), установите опцию как true, иначе будет использоваться обычный тип объединения.
Возвращаемый тип: логический.
type:
По умолчанию: GET. Опция позволяет устанавливать, изменять тип запроса(GET или POST). Другие HTTP запросы, такие как PUT и DALETE могут использоваться в данном методе, однако они не поддерживаются всеми браузерами.
Возвращаемый тип: строка.
url:
По умолчанию: url текущей страницы. С использованием данной опции вы сможете установить url страницы для запроса.
Возвращаемый тип: строка.
xhr: Функция обратного вызова создающая объект XMLHttpRequest. По умолчанию им является ActiveXObject для IE, иначе XMLHttpRequest. С помощью данной функции Вы можете создать собственную разработку для объекта XMLHttpRequest.
Возвращаемый тип: фунцкия.