Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

DownloadHandlerScript

class in UnityEngine.Networking

/

Inherits from:Networking.DownloadHandler

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

An abstract base class for user-created scripting-driven DownloadHandler implementations.

On its own, a DownloadHandlerScript object does no useful work.

Instead, it forwards data received from the network to the DownloadHandler.ReceiveData callback method, as well as invoking other useful callbacks for download-related events. By default, a DownloadHandlerScript does nothing; however, you can derive your own subclass from DownloadHandlerScript, override some or all of its callbacks and thereby implement completely custom data handling.

See Also: DownloadHandler.ReceiveData, DownloadHandler.ReceiveContentLength, DownloadHandler.CompleteContent.

Constructors

DownloadHandlerScriptCreate a DownloadHandlerScript which allocates new buffers when passing data to callbacks.

Inherited Members

Properties

dataReturns the raw bytes downloaded from the remote server, or null. (Read Only)
isDoneReturns true if this DownloadHandler has been informed by its parent UnityWebRequest that all data has been received, and this DownloadHandler has completed any necessary post-download processing. (Read Only)
textConvenience property. Returns the bytes from data interpreted as a UTF8 string. (Read Only)

Public Methods

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

Protected Methods

CompleteContentCallback, invoked when all data has been received from the remote server.
GetDataCallback, invoked when the data property is accessed.
GetProgressCallback, invoked when UnityWebRequest.downloadProgress is accessed.
GetTextCallback, invoked when the text property is accessed.
ReceiveContentLengthCallback, invoked with a Content-Length header is received.
ReceiveDataCallback, invoked as data is received from the remote server.

Did you find this page useful? Please give it a rating: