JavaScript. Подробное руководство, 6-е издание

Флэнаган Дэвид

readonly XMLHttpRequestUpload upload

Свойство, введенное спецификацией XHR2, ссылающееся на объект

XMLHttpRequestUpload

, который определяет набор свойств регистрации обработчиков событий для слежения за процессом выгрузки тела НТТР-запроса.

boolean withCredentials

Свойство, введенное спецификацией XHR2, определяющее необходимость аутентификации при выполнении междоменного CORS-запроса и необходимость обработки заголовков cookie

в CORS-ответах. По умолчанию имеет значение false.

Методы

void abort

Возвращает объект

XMLHttpRequest

в исходное состояние, соответствующее значению 0 в свойстве

readyState

, и отменяет любые запланированные сетевые взаимодействия. Этот метод может потребоваться, например, если запрос выполняется слишком долго и надобность в получении ответа уже отпала.

string getAllResponseHeaders

Возвращает все HTTP-заголовки ответа (с отфильтрованными заголовками cookie и CОRS), полученные от сервера, или null, если заголовки еще не были получены. Заголовки cookie и CОRS отфильтровываются и не могут быть получены. Заголовки возвращаются в виде единственной строки и отделяются друг от друга комбинацией символов \r\n.

string getResponseHeader(string header)

Возвращает значение указанного заголовка header в HTTP-ответе или null, если заголовки вообще не были получены или если ответ не содержит требуемого заголовка header. Заголовки cookie и CORS отфильтровываются, и их нет смысла запрашивать. Если было принято несколько заголовков с указанным именем, значения этих заголовков объединяются в одну строку через запятую и пробел.

void open(string method, string url, [boolean async, string user, string pass])

Этот метод инициализирует объект

XMLHttpRequest

и сохраняет свои аргументы для последующего использования методом

send.

Аргумент method определяет HTTP-метод, используемый для отправки запроса. Среди наиболее устоявшихся методов можно назвать GET, POST и HEAD. Реализации могут также поддерживать методы CONNECT, DELETE, OPTIONS, PUT, TRACE и TRACK.

Аргумент url определяет URL-адрес, который является предметом запроса. Разрешение относительных URL-адресов производится обычным образом с использованием URL-адреса документа со сценарием. Политика общего происхождения (см. раздел 13.6.2) требует, чтобы данный URL-адрес содержал те же имя хоста и номер порта, что и документ со сценарием, выполняющим запрос. Объект XHR2 позволяет выполнять междоменные запросы к серверам, поддерживающим заголовки CORS. Если аргумент async указан и имеет значение false, запрос будет выполняться в синхронном режиме, и последующий вызов

send

заблокирует работу сценария, пока ответ не будет получен полностью.

Синхронные запросы рекомендуется использовать только в фоновых потоках выполнения.

Необязательные аргументы user и pass определяют имя пользователя и пароль для НТТР-запроса.

void overrideMimeType(string mime)

Этот метод позволяет указать, что ответ сервера должен интерпретироваться в соответствии с указанным MIME-типом mime (и параметром charset, если он указан в определении типа mime), без учета значения заголовка

Content-Type

в ответе.

void send(any body)

Инициирует выполнение HTTP-запроса. Если перед этим не вызывался метод

ореn

или, обобщенно, если значение свойства

readyState

не равно 1, метод

send

возбуждает исключение. В противном случае он начинает выполнение НТТР-запроса, который состоит из:

• НТТР-метода, URL-адреса и информации об авторизации (если необходимо), определенных предшествующим вызовом метода

ореn

;

• заголовков запроса, если они были определены предшествующим вызовом метода

setRequestHeader

;

• значения аргумента body, переданного данному методу. Аргумент body может быть строкой, объектом

Document

, образующим тело запроса; он может быть опущен или иметь значение null, если запрос не имеет тела (например, GET-запросы вообще не имеют тела). Согласно спецификации XHR2 телом запроса также могут быть объекты

ArrayBuffer, Blob и FormData

.

Если в предшествующем вызове метода

ореn

аргумент async имел значение false, данный метод блокируется и не возвращает управление, пока значение свойства

readyState

не станет равно 4 и ответ сервера не будет получен полностью. В противном случае метод

send

немедленно возвращает управление, а ответ сервера обрабатывается асинхронно, с помощью обработчиков событий.

void setRequestHeader(string name, string value)

Определяет HTTP-заголовок с именем name и значением value, который должен быть включен в запрос, передаваемый последующим вызовом метода

send.

Этот метод может вызываться, только когда свойство

readyState

имеет значение 1, т.е. после вызова метода

ореn,

но перед вызовом метода

send.

Если заголовок с именем пате уже был определен, новым значением заголовка станет прежнее значение заголовка плюс запятая с пробелом и новое значение value, переданное методу.