Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

UnityWebRequest.timeout

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

public int timeout;

Description

Sets UnityWebRequest to attempt to abort after the number of seconds in timeout have passed.

When a timeout occurs error returns "Request timeout" . No timeout is applied when timeout is set to 0 and this property defaults to 0.
Note: The set timeout may apply to each URL redirect on Android which can result in a longer response.

using UnityEngine;
using System.Collections;
using UnityEngine.Networking;

// Ask the website to deliver an image that is very large. // Set the download to take more than 1 second. This causes // the "request timeout" error message.

public class ExampleScript : MonoBehaviour { void Start() { StartCoroutine(GetText()); }

IEnumerator GetText() { using UnityWebRequest www = UnityWebRequest.Get("https://my-website.com/verylargeimage.jpg");

// wait up to one second to download the image www.timeout = 1; yield return www.SendWebRequest();

if (www.result != UnityWebRequest.Result.Success) { Debug.LogError(www.error); } else { Debug.Log("image arrived"); } } }