Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


UnityWebRequest

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET.
Read time 8 minutesLast updated 7 days ago

Definition

UnityWebRequest()

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is
GET
.
public UnityWebRequest()

Remarks

The raw constructor is useful for use cases which require detailed custom configuration of a UnityWebRequest. Most use cases will require the attachment of a DownloadHandler, an UploadHandler or both in order to function propertly.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class SimpleGetRequest : MonoBehaviour{ private const string Url = "https://jsonplaceholder.typicode.com/todos/1"; void Start() { StartCoroutine(GetExample()); } private IEnumerator GetExample() { // Use the constructor: UnityWebRequest(string url, string method) // Method can be UnityWebRequest.kHttpVerbGET, "GET", "POST", etc. using (UnityWebRequest request = new UnityWebRequest(Url, UnityWebRequest.kHttpVerbGET)) { // Attach a download handler to receive body data request.downloadHandler = new DownloadHandlerBuffer(); // Optionally set headers request.SetRequestHeader("Accept", "application/json"); // Send the request and wait for completion yield return request.SendWebRequest(); if (request.result != UnityWebRequest.Result.Success) { Debug.LogError($"Request failed: {request.error}"); } else { // Access the response body string json = request.downloadHandler.text; Debug.Log($"Response Code: {request.responseCode}"); Debug.Log($"Body: {json}"); } } }}

UnityWebRequest(string)

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is
GET
.
public UnityWebRequest(string url)

Parameters

The target URL with which this UnityWebRequest will communicate. Also accessible via the UnityWebRequest.url property.

Remarks

The raw constructor is useful for use cases which require detailed custom configuration of a UnityWebRequest. Most use cases will require the attachment of a DownloadHandler, an UploadHandler or both in order to function propertly.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class SimpleGetRequest : MonoBehaviour{ private const string Url = "https://jsonplaceholder.typicode.com/todos/1"; void Start() { StartCoroutine(GetExample()); } private IEnumerator GetExample() { // Use the constructor: UnityWebRequest(string url, string method) // Method can be UnityWebRequest.kHttpVerbGET, "GET", "POST", etc. using (UnityWebRequest request = new UnityWebRequest(Url, UnityWebRequest.kHttpVerbGET)) { // Attach a download handler to receive body data request.downloadHandler = new DownloadHandlerBuffer(); // Optionally set headers request.SetRequestHeader("Accept", "application/json"); // Send the request and wait for completion yield return request.SendWebRequest(); if (request.result != UnityWebRequest.Result.Success) { Debug.LogError($"Request failed: {request.error}"); } else { // Access the response body string json = request.downloadHandler.text; Debug.Log($"Response Code: {request.responseCode}"); Debug.Log($"Body: {json}"); } } }}

UnityWebRequest(Uri)

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is
GET
.
public UnityWebRequest(Uri uri)

Parameters

uri

The target URI to which form data will be transmitted.

Remarks

The raw constructor is useful for use cases which require detailed custom configuration of a UnityWebRequest. Most use cases will require the attachment of a DownloadHandler, an UploadHandler or both in order to function propertly.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class SimpleGetRequest : MonoBehaviour{ private const string Url = "https://jsonplaceholder.typicode.com/todos/1"; void Start() { StartCoroutine(GetExample()); } private IEnumerator GetExample() { // Use the constructor: UnityWebRequest(string url, string method) // Method can be UnityWebRequest.kHttpVerbGET, "GET", "POST", etc. using (UnityWebRequest request = new UnityWebRequest(Url, UnityWebRequest.kHttpVerbGET)) { // Attach a download handler to receive body data request.downloadHandler = new DownloadHandlerBuffer(); // Optionally set headers request.SetRequestHeader("Accept", "application/json"); // Send the request and wait for completion yield return request.SendWebRequest(); if (request.result != UnityWebRequest.Result.Success) { Debug.LogError($"Request failed: {request.error}"); } else { // Access the response body string json = request.downloadHandler.text; Debug.Log($"Response Code: {request.responseCode}"); Debug.Log($"Body: {json}"); } } }}

UnityWebRequest(string, string)

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is
GET
.
public UnityWebRequest(string url, string method)

Parameters

The target URL with which this UnityWebRequest will communicate. Also accessible via the UnityWebRequest.url property.

method

HTTP GET, POST, etc. methods.

Remarks

The raw constructor is useful for use cases which require detailed custom configuration of a UnityWebRequest. Most use cases will require the attachment of a DownloadHandler, an UploadHandler or both in order to function propertly.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class SimpleGetRequest : MonoBehaviour{ private const string Url = "https://jsonplaceholder.typicode.com/todos/1"; void Start() { StartCoroutine(GetExample()); } private IEnumerator GetExample() { // Use the constructor: UnityWebRequest(string url, string method) // Method can be UnityWebRequest.kHttpVerbGET, "GET", "POST", etc. using (UnityWebRequest request = new UnityWebRequest(Url, UnityWebRequest.kHttpVerbGET)) { // Attach a download handler to receive body data request.downloadHandler = new DownloadHandlerBuffer(); // Optionally set headers request.SetRequestHeader("Accept", "application/json"); // Send the request and wait for completion yield return request.SendWebRequest(); if (request.result != UnityWebRequest.Result.Success) { Debug.LogError($"Request failed: {request.error}"); } else { // Access the response body string json = request.downloadHandler.text; Debug.Log($"Response Code: {request.responseCode}"); Debug.Log($"Body: {json}"); } } }}

UnityWebRequest(Uri, string)

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is
GET
.
public UnityWebRequest(Uri uri, string method)

Parameters

uri

The target URI to which form data will be transmitted.

method

HTTP GET, POST, etc. methods.

Remarks

The raw constructor is useful for use cases which require detailed custom configuration of a UnityWebRequest. Most use cases will require the attachment of a DownloadHandler, an UploadHandler or both in order to function propertly.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class SimpleGetRequest : MonoBehaviour{ private const string Url = "https://jsonplaceholder.typicode.com/todos/1"; void Start() { StartCoroutine(GetExample()); } private IEnumerator GetExample() { // Use the constructor: UnityWebRequest(string url, string method) // Method can be UnityWebRequest.kHttpVerbGET, "GET", "POST", etc. using (UnityWebRequest request = new UnityWebRequest(Url, UnityWebRequest.kHttpVerbGET)) { // Attach a download handler to receive body data request.downloadHandler = new DownloadHandlerBuffer(); // Optionally set headers request.SetRequestHeader("Accept", "application/json"); // Send the request and wait for completion yield return request.SendWebRequest(); if (request.result != UnityWebRequest.Result.Success) { Debug.LogError($"Request failed: {request.error}"); } else { // Access the response body string json = request.downloadHandler.text; Debug.Log($"Response Code: {request.responseCode}"); Debug.Log($"Body: {json}"); } } }}

UnityWebRequest(string, string, DownloadHandler, UploadHandler)

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is
GET
.
public UnityWebRequest(string url, string method, DownloadHandler downloadHandler, UploadHandler uploadHandler)

Parameters

The target URL with which this UnityWebRequest will communicate. Also accessible via the UnityWebRequest.url property.

method

HTTP GET, POST, etc. methods.

downloadHandler

Replies from the server.

uploadHandler

Upload data to the server.

Remarks

The raw constructor is useful for use cases which require detailed custom configuration of a UnityWebRequest. Most use cases will require the attachment of a DownloadHandler, an UploadHandler or both in order to function propertly.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class SimpleGetRequest : MonoBehaviour{ private const string Url = "https://jsonplaceholder.typicode.com/todos/1"; void Start() { StartCoroutine(GetExample()); } private IEnumerator GetExample() { // Use the constructor: UnityWebRequest(string url, string method) // Method can be UnityWebRequest.kHttpVerbGET, "GET", "POST", etc. using (UnityWebRequest request = new UnityWebRequest(Url, UnityWebRequest.kHttpVerbGET)) { // Attach a download handler to receive body data request.downloadHandler = new DownloadHandlerBuffer(); // Optionally set headers request.SetRequestHeader("Accept", "application/json"); // Send the request and wait for completion yield return request.SendWebRequest(); if (request.result != UnityWebRequest.Result.Success) { Debug.LogError($"Request failed: {request.error}"); } else { // Access the response body string json = request.downloadHandler.text; Debug.Log($"Response Code: {request.responseCode}"); Debug.Log($"Body: {json}"); } } }}

UnityWebRequest(Uri, string, DownloadHandler, UploadHandler)

Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is
GET
.
public UnityWebRequest(Uri uri, string method, DownloadHandler downloadHandler, UploadHandler uploadHandler)

Parameters

uri

The target URI to which form data will be transmitted.

method

HTTP GET, POST, etc. methods.

downloadHandler

Replies from the server.

uploadHandler

Upload data to the server.

Remarks

The raw constructor is useful for use cases which require detailed custom configuration of a UnityWebRequest. Most use cases will require the attachment of a DownloadHandler, an UploadHandler or both in order to function propertly.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class SimpleGetRequest : MonoBehaviour{ private const string Url = "https://jsonplaceholder.typicode.com/todos/1"; void Start() { StartCoroutine(GetExample()); } private IEnumerator GetExample() { // Use the constructor: UnityWebRequest(string url, string method) // Method can be UnityWebRequest.kHttpVerbGET, "GET", "POST", etc. using (UnityWebRequest request = new UnityWebRequest(Url, UnityWebRequest.kHttpVerbGET)) { // Attach a download handler to receive body data request.downloadHandler = new DownloadHandlerBuffer(); // Optionally set headers request.SetRequestHeader("Accept", "application/json"); // Send the request and wait for completion yield return request.SendWebRequest(); if (request.result != UnityWebRequest.Result.Success) { Debug.LogError($"Request failed: {request.error}"); } else { // Access the response body string json = request.downloadHandler.text; Debug.Log($"Response Code: {request.responseCode}"); Debug.Log($"Body: {json}"); } } }}