class in UnityEngine.Networking
/
Implemented in:UnityEngine.UnityWebRequestModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseProvides methods to communicate with web servers.
UnityWebRequest
handles the flow of HTTP communication with web servers. To download and upload data, use DownloadHandler and UploadHandler respectively.
UnityWebRequest
includes static utility functions that return UnityWebRequest
instances configured for common use cases. For example:
To send a web request from a UnityWebRequest
instance, call UnityWebRequest.SendWebRequest. After the UnityWebRequest
begins to communicate with a remote server, you can't change any of the properties in that UnityWebRequest
instance.
HTTPS is supported, server certificate is validated against the root certificate store available on the system the app runs on. Validation can be disabled (for example for development server using self-signed certificate) or changed to a custom handling by assigning UnityWebRequest.certificateHandler property.
Depending on the platform your application runs on, UnityWebRequest
either sets the User-Agent header itself or leaves it for the operating system to set. UnityWebRequest
sets the User-Agent
header for all platforms except iOS and WebGL.
Note: From Unity 2019.2, UnityWebRequest
sets the User-Agent
header for Android devices. In earlier releases, the operating system set the User-Agent
header.
Note: If the device that the application runs on uses proxy settings, UnityWebRequest
applies the proxy settings after the application sends the request.
kHttpVerbCREATE | The string "CREATE", commonly used as the verb for an HTTP CREATE request. |
kHttpVerbDELETE | The string "DELETE", commonly used as the verb for an HTTP DELETE request. |
kHttpVerbGET | The string "GET", commonly used as the verb for an HTTP GET request. |
kHttpVerbHEAD | The string "HEAD", commonly used as the verb for an HTTP HEAD request. |
kHttpVerbPOST | The string "POST", commonly used as the verb for an HTTP POST request. |
kHttpVerbPUT | The string "PUT", commonly used as the verb for an HTTP PUT request. |
certificateHandler | Holds a reference to a CertificateHandler object, which manages certificate validation for this UnityWebRequest. |
disposeCertificateHandlerOnDispose | If true, any CertificateHandler attached to this UnityWebRequest will have CertificateHandler.Dispose called automatically when UnityWebRequest.Dispose is called. |
disposeDownloadHandlerOnDispose | If true, any DownloadHandler attached to this UnityWebRequest will have DownloadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. |
disposeUploadHandlerOnDispose | If true, any UploadHandler attached to this UnityWebRequest will have UploadHandler.Dispose called automatically when UnityWebRequest.Dispose is called. |
downloadedBytes | Returns the number of bytes of body data the system has downloaded from the remote server. (Read Only) |
downloadHandler | Holds a reference to a DownloadHandler object, which manages body data received from the remote server by this UnityWebRequest. |
downloadProgress | Returns a floating-point value between 0.0 and 1.0, indicating the progress of downloading body data from the server. (Read Only) |
error | A human-readable string describing any system errors encountered by this UnityWebRequest object while handling HTTP requests or responses. The default value is null. (Read Only) |
isDone | Returns true after the UnityWebRequest has finished communicating with the remote server. (Read Only) |
isModifiable | Returns true while a UnityWebRequest’s configuration properties can be altered. (Read Only) |
method | Defines the HTTP verb used by this UnityWebRequest, such as GET or POST. |
redirectLimit | Indicates the number of redirects that this UnityWebRequest follows before halting with a Redirect Limit Exceeded system error. |
responseCode | The numeric HTTP response code returned by the server, such as 200, 404 or 500. (Read Only) |
result | The result of this UnityWebRequest. |
timeout | Sets UnityWebRequest to attempt to abort after the number of seconds in timeout have passed. |
uploadedBytes | Returns the number of bytes of body data the system has uploaded to the remote server. (Read Only) |
uploadHandler | Holds a reference to the UploadHandler object which manages body data to be uploaded to the remote server. |
uploadProgress | Returns a floating-point value between 0.0 and 1.0, indicating the progress of uploading body data to the server. |
uri | Defines the target URI for the UnityWebRequest to communicate with. |
url | Defines the target URL for the UnityWebRequest to communicate with. |
useHttpContinue | Determines whether this UnityWebRequest will include Expect: 100-Continue in its outgoing request headers. (Default: true). |
UnityWebRequest | Creates a UnityWebRequest with the default options and no attached DownloadHandler or UploadHandler. Default method is GET. |
Abort | If in progress, halts the UnityWebRequest as soon as possible. |
Dispose | Signals that this UnityWebRequest is no longer being used, and should clean up any resources it is using. |
GetRequestHeader | Retrieves the value of a custom request header. |
GetResponseHeader | Retrieves the value of a response header from the latest HTTP response received. |
GetResponseHeaders | Retrieves a dictionary containing all the response headers received by this UnityWebRequest in the latest HTTP response. |
SendWebRequest | Begin communicating with the remote server. |
SetRequestHeader | Set a HTTP request header to a custom value. |
ClearCookieCache | Clears stored cookies from the cache. |
Delete | Creates a UnityWebRequest configured for HTTP DELETE. |
EscapeURL | Escapes characters in a string to ensure they are URL-friendly. |
GenerateBoundary | Generate a random 40-byte array for use as a multipart form boundary. |
Get | Create a UnityWebRequest for HTTP GET. |
Head | Creates a UnityWebRequest configured to send a HTTP HEAD request. |
Post | Creates a UnityWebRequest configured to send form data to a server via HTTP POST. |
PostWwwForm | Creates a UnityWebRequest configured to send form data to a server via HTTP POST. |
Put | Creates a UnityWebRequest configured to upload raw data to a remote server via HTTP PUT. |
SerializeFormSections | Converts a List of IMultipartFormSection objects into a byte array containing raw multipart form data. |
SerializeSimpleForm | Serialize a dictionary of strings into a byte array containing URL-encoded UTF8 characters. |
UnEscapeURL | Converts URL-friendly escape sequences back to normal text. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.