Version: 2023.2
LanguageEnglish
  • C#

UploadHandler

class in UnityEngine.Networking

/

Implemented in:UnityEngine.UnityWebRequestModule

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

Description

Helper object for UnityWebRequests. Manages the buffering and transmission of body data during HTTP requests.

When attached to a UnityWebRequest, an UploadHandler object handles all information regarding the buffering and transmission of body data during an HTTP request. By placing data in an UploadHandler and attaching it to a UnityWebRequest, the UnityWebRequest is implicitly instructed to transmit the UploadHandler's data to the remote server. The data will always be delivered as HTTP request body data.

UploadHandler is a base class and cannot be directly instantiated. Currently, only one type of UploadHandler is available: UploadHandlerRaw.

Additional resources: UnityWebRequest, UploadHandlerRaw.

Properties

contentTypeDetermines the default Content-Type header which will be transmitted with the outbound HTTP request.
dataThe raw data which will be transmitted to the remote server as body data. (Read Only)
progressReturns the proportion of data uploaded to the remote server compared to the total amount of data to upload. (Read Only)

Public Methods

DisposeSignals that this UploadHandler is no longer being used, and should clean up any resources it is using.