API reference
VRequest Class
Extends IVRequest, ILogSource
Helper class for performing http web requests using UnityWebRequest
Properties
IVLogger Logger[Get]
string Url[Get]
Url to be used for the vrequest
Dictionary< string, string > UrlParameters[Get]
Url parameters to be used for the vrequest
string ContentType[Get]
The content type to be used
VRequestMethod Method[Get]
Method the request will be used
DownloadHandler Downloader[Get]
Script used as download handler
UploadHandler Uploader[Get]
Script used as upload handler
int Timeout[Get]
Timeout in seconds
int TimeoutMs[Get]
Timeout in milliseconds
bool IsQueued[Get]
If request is currently queued to run
bool IsRunning[Get]
If request is currently transmitting or receiving data
bool IsDecoding[Get]
If request is currently decoding following a response
bool HasFirstResponse[Get]
If first response has been received
bool IsComplete[Get]
If request has completed queueing and running a request
TaskCompletionSource< bool > Completion[Get]
Completion source task
int ResponseCode[Get]
Response Code if applicable
string ResponseError[Get]
Response error
float UploadProgress[Get]
Current progress for get requests
float DownloadProgress[Get]
Current progress for download
Public Statics
static int MaxConcurrentRequests[Get]
Ensures only this many requests can run at one time
Events
VRequestProgressDelegate OnUploadProgress
Callback on request upload progress change
VRequestProgressDelegate OnDownloadProgress
Callback on request download progress change
VRequestResponseDelegate OnFirstResponse
Callback on request first response
Fields
bool IsPerforming[Get]
If request is queued to run or running
Protected Fields
const string FilePrepend[Get]
Obtains uri from the url and url parameters
Member Functions
virtual void Reset ( )
Resets all data
virtual async Task< VRequestResponse< TValue > > Request< TValue >
( VRequestDecodeDelegate< TValue > decoder )
Performs a request from the main thread or a background thread
virtual void Cancel ( )
Method to cancel a VRequest
async Task< VRequestResponse< Dictionary< string, string > > > RequestFileHeaders
( string url )
Performs a header request on a uri
async Task< VRequestResponse< byte[]> > RequestFile
( string url )
Performs a get request on a file url
async Task< VRequestResponse< bool > > RequestFileDownload
( string url,
string downloadPath )
Performs a download from a specified location to a new location
string GetTmpDownloadPath
( string downloadPath )
async Task< VRequestResponse< bool > > RequestFileExists
( string url )
Checks if a file exists at a specified location using async calls
async Task< VRequestResponse< string > > RequestText
( Action< string > onPartial )
Performs a text request with an option partial response callback
async Task< VRequestResponse< TData > > RequestJson< TData >
( Action< TData > onPartial )
Performs a request for text & decodes it into json
async Task< VRequestResponse< TData > > RequestJsonGet< TData >
( Action< TData > onPartial )
Perform a json get request with the option for a partial response
async Task< VRequestResponse< TData > > RequestJsonPost< TData >
( Action< TData > onPartial )
Perform a json get request with the option for a partial response
async Task< VRequestResponse< TData > > RequestJsonPost< TData >
( byte [] postData,
Action< TData > onPartial )
Perform a json post request with raw data and the option for a partial response
async Task< VRequestResponse< TData > > RequestJsonPost< TData >
( string postText,
Action< TData > onPartial )
Perform a json post request with string data and the option for a partial response
async Task< VRequestResponse< TData > > RequestJsonPut< TData >
( Action< TData > onPartial )
Perform a json put request with the option for a partial response
async Task< VRequestResponse< TData > > RequestJsonPut< TData >
( byte [] putData,
Action< TData > onPartial )
Perform a json put request with raw data and the option for a partial response
async Task< VRequestResponse< TData > > RequestJsonPut< TData >
( string putText,
Action< TData > onPartial )
Perform a json put request with string data and the option for a partial response
Protected Functions
virtual Uri GetUri ( )
virtual string GetMethod ( )
Obtain request method id
virtual Dictionary< string, string > GetHeaders ( )
Obtains request headers if applicable
virtual UnityWebRequest CreateRequest
( string url,
string method,
Dictionary< string, string > headers )
Generates UnityWebRequest
virtual async Task WaitWhileRunning ( )
Wait while request is running
virtual async Task< Tuple< int, string > > GetError
( UnityWebRequest request )
Attempts to obtain any errors
virtual void Dispose ( )
Handles dispose and removal of request from running queue
virtual void RaiseFirstResponse ( )
Raise first response callback
virtual void UpdateDownloadProgress
( float progress )
Update download progress
Task< bool > DecodeSuccess
( UnityWebRequest request )
Returns true if no error
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta