The UnityWebRequest object is used to communicate with web servers.
UnityWebRequests handle the flow of HTTP communication with web servers. Other objects - specifically DownloadHandler and UploadHandler - govern downloading and uploading data, respectively.
A set of static functions are provided for convenience; these return UnityWebRequest objects properly configured for many common use cases. See: Get, Post, Put, GetTexture.
Note: Most properties on the UnityWebRequest object cannot be altered once the UnityWebRequest has begun communicating with a remote server by calling the Send method.
| 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. |
| chunkedTransfer | Indicates whether the UnityWebRequest system should employ the HTTP/1.1 chunked-transfer encoding method. |
| 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. (Read Only) |
| isDone | Returns true after the UnityWebRequest has finished communicating with the remote server. (Read Only) |
| isError | Returns true after this UnityWebRequest encounters a system error. (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 which this UnityWebRequest will follow 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) |
| 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. |
| 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. |
| Send | Begin communicating with the remote server. |
| SetRequestHeader | Set a HTTP request header to a custom value. |
| Delete | Creates a UnityWebRequest configured for HTTP DELETE. |
| GenerateBoundary | Generate a random 40-byte array for use as a multipart form boundary. |
| Get | Creates a UnityWebRequest configured for HTTP GET. |
| GetAssetBundle | Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET. |
| GetAudioClip | Create a UnityWebRequest intended to download an audio clip via HTTP GET and create an AudioClip based on the retrieved data. |
| GetTexture | Create a UnityWebRequest intended to download an image via HTTP GET and create a Texture based on the retrieved data. |
| Head | Creates a UnityWebRequest configured to send a HTTP HEAD request. |
| Post | Create a UnityWebRequest configured to send form data to a server via HTTP POST. |
| Put | Create 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. |