Show / Hide Table of Contents

Class UnityWebRequest

Inheritance
Object
UnityWebRequest
Implements
IDisposable
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: UnityEngine.Networking
Assembly: UnityEngine.dll
Syntax
public class UnityWebRequest : IDisposable

Constructors

| Improve this Doc View Source

UnityWebRequest()

Declaration
public UnityWebRequest()
| Improve this Doc View Source

UnityWebRequest(String)

Declaration
public UnityWebRequest(string url)
Parameters
Type Name Description
String url
| Improve this Doc View Source

UnityWebRequest(String, String)

Declaration
public UnityWebRequest(string url, string method)
Parameters
Type Name Description
String url
String method
| Improve this Doc View Source

UnityWebRequest(String, String, DownloadHandler, UploadHandler)

Declaration
public UnityWebRequest(string url, string method, DownloadHandler downloadHandler, UploadHandler uploadHandler)
Parameters
Type Name Description
String url
String method
DownloadHandler downloadHandler
UploadHandler uploadHandler
| Improve this Doc View Source

UnityWebRequest(Uri)

Declaration
public UnityWebRequest(Uri uri)
Parameters
Type Name Description
Uri uri
| Improve this Doc View Source

UnityWebRequest(Uri, String)

Declaration
public UnityWebRequest(Uri uri, string method)
Parameters
Type Name Description
Uri uri
String method
| Improve this Doc View Source

UnityWebRequest(Uri, String, DownloadHandler, UploadHandler)

Declaration
public UnityWebRequest(Uri uri, string method, DownloadHandler downloadHandler, UploadHandler uploadHandler)
Parameters
Type Name Description
Uri uri
String method
DownloadHandler downloadHandler
UploadHandler uploadHandler

Fields

| Improve this Doc View Source

kHttpVerbCREATE

Declaration
public const string kHttpVerbCREATE = "CREATE"
Field Value
Type Description
String
| Improve this Doc View Source

kHttpVerbDELETE

Declaration
public const string kHttpVerbDELETE = "DELETE"
Field Value
Type Description
String
| Improve this Doc View Source

kHttpVerbGET

Declaration
public const string kHttpVerbGET = "GET"
Field Value
Type Description
String
| Improve this Doc View Source

kHttpVerbHEAD

Declaration
public const string kHttpVerbHEAD = "HEAD"
Field Value
Type Description
String
| Improve this Doc View Source

kHttpVerbPOST

Declaration
public const string kHttpVerbPOST = "POST"
Field Value
Type Description
String
| Improve this Doc View Source

kHttpVerbPUT

Declaration
public const string kHttpVerbPUT = "PUT"
Field Value
Type Description
String

Properties

| Improve this Doc View Source

certificateHandler

Declaration
public CertificateHandler certificateHandler { get; set; }
Property Value
Type Description
CertificateHandler
| Improve this Doc View Source

chunkedTransfer

Declaration
public bool chunkedTransfer { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

disposeCertificateHandlerOnDispose

Declaration
public bool disposeCertificateHandlerOnDispose { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

disposeDownloadHandlerOnDispose

Declaration
public bool disposeDownloadHandlerOnDispose { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

disposeUploadHandlerOnDispose

Declaration
public bool disposeUploadHandlerOnDispose { get; set; }
Property Value
Type Description
Boolean

downloadedBytes

Declaration
public ulong downloadedBytes { get; }
Property Value
Type Description
UInt64
| Improve this Doc View Source

downloadHandler

Declaration
public DownloadHandler downloadHandler { get; set; }
Property Value
Type Description
DownloadHandler
| Improve this Doc View Source

downloadProgress

Declaration
public float downloadProgress { get; }
Property Value
Type Description
Single
| Improve this Doc View Source

error

Declaration
public string error { get; }
Property Value
Type Description
String

isDone

Declaration
public bool isDone { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

isError

Declaration
[Obsolete("UnityWebRequest.isError has been renamed to isNetworkError for clarity. (UnityUpgradable) -> isNetworkError", false)]
public bool isError { get; }
Property Value
Type Description
Boolean

isHttpError

Declaration
public bool isHttpError { get; }
Property Value
Type Description
Boolean

isModifiable

Declaration
public bool isModifiable { get; }
Property Value
Type Description
Boolean

isNetworkError

Declaration
public bool isNetworkError { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

method

Declaration
public string method { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

redirectLimit

Declaration
public int redirectLimit { get; set; }
Property Value
Type Description
Int32

responseCode

Declaration
public long responseCode { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

timeout

Declaration
public int timeout { get; set; }
Property Value
Type Description
Int32

uploadedBytes

Declaration
public ulong uploadedBytes { get; }
Property Value
Type Description
UInt64
| Improve this Doc View Source

uploadHandler

Declaration
public UploadHandler uploadHandler { get; set; }
Property Value
Type Description
UploadHandler
| Improve this Doc View Source

uploadProgress

Declaration
public float uploadProgress { get; }
Property Value
Type Description
Single
| Improve this Doc View Source

uri

Declaration
public Uri uri { get; set; }
Property Value
Type Description
Uri
| Improve this Doc View Source

url

Declaration
public string url { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

useHttpContinue

Declaration
public bool useHttpContinue { get; set; }
Property Value
Type Description
Boolean

Methods

Abort()

Declaration
public void Abort()
| Improve this Doc View Source

ClearCookieCache()

Declaration
public static void ClearCookieCache()
| Improve this Doc View Source

ClearCookieCache(Uri)

Declaration
public static void ClearCookieCache(Uri uri)
Parameters
Type Name Description
Uri uri
| Improve this Doc View Source

Delete(String)

Declaration
public static UnityWebRequest Delete(string uri)
Parameters
Type Name Description
String uri
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Delete(Uri)

Declaration
public static UnityWebRequest Delete(Uri uri)
Parameters
Type Name Description
Uri uri
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

EscapeURL(String)

Declaration
public static string EscapeURL(string s)
Parameters
Type Name Description
String s
Returns
Type Description
String
| Improve this Doc View Source

EscapeURL(String, Encoding)

Declaration
public static string EscapeURL(string s, Encoding e)
Parameters
Type Name Description
String s
Encoding e
Returns
Type Description
String
| Improve this Doc View Source

Finalize()

Declaration
protected void Finalize()
| Improve this Doc View Source

GenerateBoundary()

Declaration
public static byte[] GenerateBoundary()
Returns
Type Description
Byte[]
| Improve this Doc View Source

Get(String)

Declaration
public static UnityWebRequest Get(string uri)
Parameters
Type Name Description
String uri
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Get(Uri)

Declaration
public static UnityWebRequest Get(Uri uri)
Parameters
Type Name Description
Uri uri
Returns
Type Description
UnityWebRequest

GetRequestHeader(String)

Declaration
public string GetRequestHeader(string name)
Parameters
Type Name Description
String name
Returns
Type Description
String

GetResponseHeader(String)

Declaration
public string GetResponseHeader(string name)
Parameters
Type Name Description
String name
Returns
Type Description
String
| Improve this Doc View Source

GetResponseHeaders()

Declaration
public Dictionary<string, string> GetResponseHeaders()
Returns
Type Description
Dictionary<String, String>
| Improve this Doc View Source

Head(String)

Declaration
public static UnityWebRequest Head(string uri)
Parameters
Type Name Description
String uri
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Head(Uri)

Declaration
public static UnityWebRequest Head(Uri uri)
Parameters
Type Name Description
Uri uri
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(String, Dictionary<String, String>)

Declaration
public static UnityWebRequest Post(string uri, Dictionary<string, string> formFields)
Parameters
Type Name Description
String uri
Dictionary<String, String> formFields
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(String, List<IMultipartFormSection>)

Declaration
public static UnityWebRequest Post(string uri, List<IMultipartFormSection> multipartFormSections)
Parameters
Type Name Description
String uri
List<IMultipartFormSection> multipartFormSections
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(String, List<IMultipartFormSection>, Byte[])

Declaration
public static UnityWebRequest Post(string uri, List<IMultipartFormSection> multipartFormSections, byte[] boundary)
Parameters
Type Name Description
String uri
List<IMultipartFormSection> multipartFormSections
Byte[] boundary
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(String, String)

Declaration
public static UnityWebRequest Post(string uri, string postData)
Parameters
Type Name Description
String uri
String postData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(String, WWWForm)

Declaration
public static UnityWebRequest Post(string uri, WWWForm formData)
Parameters
Type Name Description
String uri
WWWForm formData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(Uri, Dictionary<String, String>)

Declaration
public static UnityWebRequest Post(Uri uri, Dictionary<string, string> formFields)
Parameters
Type Name Description
Uri uri
Dictionary<String, String> formFields
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(Uri, List<IMultipartFormSection>)

Declaration
public static UnityWebRequest Post(Uri uri, List<IMultipartFormSection> multipartFormSections)
Parameters
Type Name Description
Uri uri
List<IMultipartFormSection> multipartFormSections
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(Uri, List<IMultipartFormSection>, Byte[])

Declaration
public static UnityWebRequest Post(Uri uri, List<IMultipartFormSection> multipartFormSections, byte[] boundary)
Parameters
Type Name Description
Uri uri
List<IMultipartFormSection> multipartFormSections
Byte[] boundary
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(Uri, String)

Declaration
public static UnityWebRequest Post(Uri uri, string postData)
Parameters
Type Name Description
Uri uri
String postData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Post(Uri, WWWForm)

Declaration
public static UnityWebRequest Post(Uri uri, WWWForm formData)
Parameters
Type Name Description
Uri uri
WWWForm formData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Put(String, Byte[])

Declaration
public static UnityWebRequest Put(string uri, byte[] bodyData)
Parameters
Type Name Description
String uri
Byte[] bodyData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Put(String, String)

Declaration
public static UnityWebRequest Put(string uri, string bodyData)
Parameters
Type Name Description
String uri
String bodyData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Put(Uri, Byte[])

Declaration
public static UnityWebRequest Put(Uri uri, byte[] bodyData)
Parameters
Type Name Description
Uri uri
Byte[] bodyData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Put(Uri, String)

Declaration
public static UnityWebRequest Put(Uri uri, string bodyData)
Parameters
Type Name Description
Uri uri
String bodyData
Returns
Type Description
UnityWebRequest
| Improve this Doc View Source

Send()

Declaration
[Obsolete("Use SendWebRequest.  It returns a UnityWebRequestAsyncOperation which contains a reference to the WebRequest object.", false)]
public AsyncOperation Send()
Returns
Type Description
AsyncOperation
| Improve this Doc View Source

SendWebRequest()

Declaration
public UnityWebRequestAsyncOperation SendWebRequest()
Returns
Type Description
UnityWebRequestAsyncOperation
| Improve this Doc View Source

SerializeFormSections(List<IMultipartFormSection>, Byte[])

Declaration
public static byte[] SerializeFormSections(List<IMultipartFormSection> multipartFormSections, byte[] boundary)
Parameters
Type Name Description
List<IMultipartFormSection> multipartFormSections
Byte[] boundary
Returns
Type Description
Byte[]
| Improve this Doc View Source

SerializeSimpleForm(Dictionary<String, String>)

Declaration
public static byte[] SerializeSimpleForm(Dictionary<string, string> formFields)
Parameters
Type Name Description
Dictionary<String, String> formFields
Returns
Type Description
Byte[]
| Improve this Doc View Source

SetRequestHeader(String, String)

Declaration
public void SetRequestHeader(string name, string value)
Parameters
Type Name Description
String name
String value
| Improve this Doc View Source

UnEscapeURL(String)

Declaration
public static string UnEscapeURL(string s)
Parameters
Type Name Description
String s
Returns
Type Description
String
| Improve this Doc View Source

UnEscapeURL(String, Encoding)

Declaration
public static string UnEscapeURL(string s, Encoding e)
Parameters
Type Name Description
String s
Encoding e
Returns
Type Description
String

Implements

System.IDisposable

Extension Methods

MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
MustExtensions.MustBeNull<T>(T)
MustExtensions.MustBeNull<T>(T, String)
MustExtensions.MustNotBeNull<T>(T)
MustExtensions.MustNotBeNull<T>(T, String)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX