Unity 6.3
0 онлайн 2 гостей 3 в системе
Вход

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-дружественные последовательности спасения обратно в обычный текст.