API reference
API reference
Select your platform
No SDKs available
No versions available

Request Class

Extends Request
This Request class provides a set of tools and services for developing VR applications. It represents a request made to the OculusPlatform, such as a request to initialize the platform or to retrieve user data.

Constructors

Request ( requestID )
Signature
Oculus.Platform.Request< T >.Request(ulong requestID)
Parameters
requestID: ulong
Request ( requestID )
Signature
Oculus.Platform.Request< T >.Request(ulong requestID)
Parameters
requestID: ulong

Properties

RequestID : ulong
[Get][Set]
It is a public property of the Request class that represents the unique identifier for a request. It can be used to identify and track requests.
Signature
ulong Oculus.Platform.Request< T >.RequestID

Methods

Gen ()
Signature
new async Task<Message<T> > Oculus.Platform.Request< T >.Gen()
Returns
new async Task< Message< T > >
Gen ()
Signature
async Task<Message> Oculus.Platform.Request< T >.Gen()
Returns
async Task< Message >
GetAwaiter ()
Makes the Request<T> class awaitable, allowing it to be used with the await keyword. Returns an awaiter that completes when the request completes.
Signature
new TaskAwaiter<Message<T> > Oculus.Platform.Request< T >.GetAwaiter()
Returns
new TaskAwaiter< Message< T > >
GetAwaiter ()
Makes the Request class awaitable, allowing it to be used with the await keyword. Returns an awaiter that completes when the request completes.
Signature
TaskAwaiter<Message> Oculus.Platform.Request< T >.GetAwaiter()
Returns
TaskAwaiter< Message >
HandleMessage ( msg )
This function is called when a message is received from the OculusPlatform in response to the request. It takes a Message object as a parameter, which contains the result of the request.
Signature
override void Oculus.Platform.Request< T >.HandleMessage(Message msg)
Parameters
msg: Message
Returns
override void
HandleMessage ( msg )
It is called when a message is received in response to a request made by the application.
Signature
virtual void Oculus.Platform.Request< T >.HandleMessage(Message msg)
Parameters
msg: Message
Returns
void
OnComplete ( callback )
This function takes a callback function as a parameter and attaches it to the request. When the request is completed, the callback function will be called with the result of the request.
Signature
Request<T> Oculus.Platform.Request< T >.OnComplete(Message< T >.Callback callback)
Parameters
callback: Message< T >.Callback
Returns
Request< T >
OnComplete ( callback )
Signature
Request Oculus.Platform.Request< T >.OnComplete(Message.Callback callback)
Parameters
Returns
Request

Static Methods

RunCallbacks ( limit )
This will run callbacks on all messages that returned from the server. If too many message are coming back at once, then a limit can be passed in as an arg to limit the number of messages to run callbacks on at a time
Signature
static void Oculus.Platform.Request< T >.RunCallbacks(uint limit=0)
Parameters
limit: uint
Returns
void