Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


PostWwwForm

Creates a UnityWebRequest configured to send form data to a server via HTTP POST.
Read time 2 minutesLast updated 6 days ago

Definition

PostWwwForm(string, string)

Creates a UnityWebRequest configured to send form data to a server via HTTP
POST
.
public static UnityWebRequest PostWwwForm(string uri, string form)

Parameters

The target URI to which form data will be transmitted.

form

An HTML form to send.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to
uri
via
POST
.

Remarks

This method creates a UnityWebRequest, sets the
uri
and sets the method to
POST
. The
Content-Type
header will be set to
application/x-www-form-urlencoded
by default.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The string in the
form
parameter is expected to be a preformatted HTML form. It will be escaped and sent as UTF-8 string.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehavior : MonoBehaviour{ void Start() { StartCoroutine(Upload()); } IEnumerator Upload() { using (UnityWebRequest www = UnityWebRequest.PostWwwForm("https://www.my-server.com/myapi", "field1=1&field2=value2")) { yield return www.SendWebRequest(); if (www.result != UnityWebRequest.Result.Success) { Debug.LogError(www.error); } else { Debug.Log("Form upload complete!"); } } }}

PostWwwForm(Uri, string)

Creates a UnityWebRequest configured to send form data to a server via HTTP
POST
.
public static UnityWebRequest PostWwwForm(Uri uri, string form)

Parameters

uri

The target URI to which form data will be transmitted.

form

An HTML form to send.

Returns

Type

Description

UnityWebRequestA UnityWebRequest configured to send form data to
uri
via
POST
.

Remarks

This method creates a UnityWebRequest, sets the
uri
and sets the method to
POST
. The
Content-Type
header will be set to
application/x-www-form-urlencoded
by default.
This method attaches a DownloadHandlerBuffer to the UnityWebRequest. This is for convenience, as we anticipate most users will use the DownloadHandler to check replies from the server, particularly in the case of REST APIs.
The string in the
form
parameter is expected to be a preformatted HTML form. It will be escaped and sent as UTF-8 string.

Examples

using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehavior : MonoBehaviour{ void Start() { StartCoroutine(Upload()); } IEnumerator Upload() { using (UnityWebRequest www = UnityWebRequest.PostWwwForm("https://www.my-server.com/myapi", "field1=1&field2=value2")) { yield return www.SendWebRequest(); if (www.result != UnityWebRequest.Result.Success) { Debug.LogError(www.error); } else { Debug.Log("Form upload complete!"); } } }}