UnityWebRequest
класс в UnityEngine.Networking
Выполнено в:UnityEngine.UnityWebRequestModule
Описание
Предоставляет методы связи с веб-серверами.
UnityWebRequest обрабатывает поток связи HTTP с веб-серверами. Для последующей обработки загруженных данных и предварительной обработки загруженных данных, используйте DownloadHandler и UploadHandler соответственно.UnityWebRequest включает статические служебные функции, возвращающие UnityWebRequest экземпляры, настроенные для общих сценариев использования. Например:
Чтобы отправить веб-запрос из UnityWebRequest экземпляр, вызов UnityWebRequest.SendWebRequest. После UnityWebRequest начинает взаимодействовать с удаленным сервером, вы не можете изменить ни одно из свойств в этом UnityWebRequest. HTTPS Подтверждение может быть отключено (например, для сервера разработки, использующего самозаверенный сертификат) или изменено на настраиваемую обработку путем назначения UnityWebRequest.certificateHandler свойства.
В зависимости от платформы, на которой работает приложение, UnityWebRequest либо устанавливает Заголовок User-Agent самостоятельно или оставляет его для установки операционной системой. UnityWebRequest устанавливает User-Agent заголовок для всех платформ, кроме iOS, платформы Сбокс, и WebGL.
Примечание: Если устройство, на котором запускается приложение, использует параметры прокси, UnityWebRequest применяет параметры прокси-сервера после того, как приложение отправит запрос. Примечание: UnityWebRequest не поддерживает WPAD PAC конфигурация с несколькими прокси-цепями отказоустойчивости для поддерживаемых платформ. В случае использования такой конфигурацией, UnityWebRequest будет использовать первый прокси в цепи и не будет использовать другой отказоустойчивый прокси из цепи в случае отказа запроса.
using UnityEngine; using System.Collections; using UnityEngine.Networking; public class MyBehaviour : MonoBehaviour { void Start() { StartCoroutine(GetText()); } IEnumerator GetText() { UnityWebRequest www = UnityWebRequest.Get("https://www.my-server.com"); yield return www.SendWebRequest(); if (www.result != UnityWebRequest.Result.Success) { Debug.Log(www.error); } else { // Show results as text Debug.Log(www.downloadHandler.text); // Or retrieve results as binary data byte[] results = www.downloadHandler.data; } } }
Статические свойства
| Свойство | Описание |
|---|---|
| kHttpVerbCREATE | Строка "CREATE", обычно используемая в качестве глагола для запроса HTTP CREATE. |
| kHttpVerbDELETE | Строка "DELETE", обычно используемая в качестве глагола для запроса HTTP DELETE. |
| kHttpVerbGET | Строка "GET", обычно используемая в качестве глагола для запроса HTTP GET. |
| kHttpVerbHEAD | Строка "HEAD", обычно используемая в качестве глагола для запроса HTTP HEAD. |
| kHttpVerbPOST | Строка "POST", обычно используемая в качестве глагола для запроса HTTP POST. |
| kHttpVerbPUT | Строка "PUT", обычно используемая в качестве глагола для запроса HTTP PUT. |
Свойства
| Свойство | Описание |
|---|---|
| certificateHandler | Содержит ссылку на объект CertificateHandler, который управляет проверкой сертификата для этого UnityWebRequest. |
| disposeCertificateHandlerOnDispose | Если true, то любой CertificateHandler, присоединенный к этому UnityWebRequest, будет автоматически вызывать CertificateHandler.Dispose при вызове UnityWebRequest.Dispose. |
| disposeDownloadHandlerOnDispose | Если true, то любой DownloadHandler, присоединенный к этому UnityWebRequest, будет автоматически вызывать DownloadHandler.Dispose при вызове UnityWebRequest.Dispose. |
| disposeUploadHandlerOnDispose | Если true, то любой UploadHandler, присоединенный к этому UnityWebRequest, будет автоматически вызывать UploadHandler.Dispose при вызове UnityWebRequest.Dispose. |
| downloadedBytes | Возвращает количество байтов данных тела, загруженных системой с удаленного сервера. (Только для чтения) |
| downloadHandler | Содержит ссылку на объект DownloadHandler, который управляет данными тела, полученными от удаленного сервера этим UnityWebRequest. |
| downloadProgress | Возвращает значение с плавающей запятой между 0.0 и 1.0, указывающее на прогресс загрузки данных тела с сервера. (только для чтения) |
| error | Читаема для человека строка, описывающая любые системные ошибки, с которыми столкнулся этот объект UnityWebRequest при обработке запросов или ответов HTTP. Значение по умолчанию — null. (только для чтения) |
| httpForcedVersion | Принудительная версия HTTP используется при выполнении веб-запросов с UnityWebRequest. |
| isDone | Возвращает true после того, как UnityWebRequest завершит связь с удаленным сервером. (Только для чтения) |
| isModifiable | Возвращает true, пока свойства конфигурации UnityWebRequest могут быть изменены. (Только для чтения) |
| method | Определяет глагол HTTP, используемый этим UnityWebRequest, например GET или POST. |
| redirectLimit | Указывает количество перенаправлений, которые выполняет UnityWebRequest перед остановкой с системной ошибкой Redirect Limit Exceeded. |
| responseCode | Численный код ответа HTTP, возвращенный сервером, например 200, 404 или 500. (только для чтения) |
| result | Результат этого UnityWebRequest. |
| timeout | Число секунд, после которых UnityWebRequest пытается прервать запрос, если ответ не получен. |
| uploadedBytes | Возвращает количество байтов данных тела, загруженных системой на удаленный сервер. (Только для чтения) |
| uploadHandler | Содержит ссылку на объект UploadHandler, который управляет данными тела для загрузки на удаленный сервер. |
| uploadProgress | Возвращает значение с плавающей точкой между 0.0 и 1.0, указывающее на прогресс загрузки данных тела на сервер. |
| uri | Определяет цель URI для UnityWebRequest для общения. |
| url | Определяет цель URL для UnityWebRequest для общения. |
| useHttpContinue | Определяет, будет ли этот UnityWebRequest включать Expect: 100-Continue в заголовки исходящих запросов. (По умолчанию: true). |
Конструкторы
| Конструктор | Описание |
|---|---|
| UnityWebRequest | Создает UnityWebRequest с параметрами по умолчанию и без добавления DownloadHandler или UploadHandler. Метод по умолчанию — GET. |
Открытые методы
| Метод | Описание |
|---|---|
| Abort | Если в процессе, останавливает UnityWebRequest как можно скорее. |
| Dispose | Сигнализирует, что UnityWebRequest больше не используется и должен очистить все ресурсы, которые он использует. |
| GetRequestHeader | Получает значение настраиваемого заголовка запроса. |
| GetResponseHeader | Получает значение заголовка ответа из последнего полученного ответа HTTP. |
| GetResponseHeaders | Получает словарь, содержащий все заголовки ответов, полученных этим UnityWebRequest в последнем ответе HTTP. |
| SendWebRequest | Начало связи с удаленным сервером. |
| SetRequestHeader | Устанавливает заголовок запроса HTTP в пользовательское значение. |
Статические методы
| Метод | Описание |
|---|---|
| ClearCookieCache | Очистка сохраненных файлов cookie из кэша. |
| Delete | Создает UnityWebRequest, настроенный для HTTP DELETE. |
| EscapeURL | Эскапирует символы в строке, чтобы убедиться, что они совместимы с URL. |
| GenerateBoundary | Создание случайного 40-байтного массива для использования в качестве границы многочастной формы. |
| Get | Создать UnityWebRequest для HTTP GET. |
| Head | Создает UnityWebRequest, настроенный для отправки запроса HTTP HEAD. |
| Post | Создает UnityWebRequest, настроенный для отправки данных формы на сервер через HTTP POST. |
| PostWwwForm | Создает UnityWebRequest, настроенный для отправки данных формы на сервер через HTTP POST. |
| Put | Создает UnityWebRequest, настроенный для загрузки необработанных данных на удаленный сервер через HTTP PUT. |
| SerializeFormSections | Преобразует Список объектов IMultipartFormSection в байтовый массив, содержащий необработанные данные многочастной формы. |
| SerializeSimpleForm | Сериализируйте словарь строк в байтовый массив, содержащий URL-кодированный UTF8 символов. |
| UnEscapeURL | Преобразует URL-дружественные последовательности спасения обратно в обычный текст. |