Documentation for the Unity C# Library
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | List of all members
PixoVR.Apex.APIHandler Class Reference

Classes

class  GenerateAuthCodeInput
 

Public Member Functions

 APIHandler ()
 
 APIHandler (string endpointUrl)
 
delegate void APIResponse (ResponseType type, HttpResponseMessage message, object responseData)
 
async void CompleteSession (string authToken, CompleteSessionData completionData, Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure)
 
async void GenerateAssistedLogin (string authToken, int userId, Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure)
 
async void GetDevicesForOrg (string authToken, int orgID, int page, FilterParams filterParams, Action< HttpResponseMessage, OrgDevicesResponse > success, Action< HttpResponseMessage, FailureResponse > failure)
 
async void GetModuleAccess (int moduleId, int userId, string serialNumber)
 
async void GetModuleList (string authToken, string platform)
 
async void GetQuickIDAuthenticationUsers (string serialNumber)
 
async void GetSessionHistory (string authToken, int page, SessionFilters sessionFilters, FilterParams filterParams, Action< HttpResponseMessage, SessionHistoryResponse > success, Action< HttpResponseMessage, FailureResponse > failure)
 
async void GetUserData (string authToken, int userId)
 
async void GetUserMetricsForOrg (string authToken, int orgID, int page, FilterParams filterParams, Action< UserMetricsResponse, object > success, Action< HttpResponseMessage, FailureResponse > failure)
 
async void GetUserModules (string authToken, int userId)
 
async void JoinSession (string authToken, JoinSessionData joinData, Action< HttpResponseMessage, JoinSessionResponse > success, Action< HttpResponseMessage, FailureResponse > failure)
 
async void Login (LoginData login)
 
async void LoginWithToken (string token)
 
async void Ping (Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure)
 
async void QuickIDLogin (QuickIDLoginData login)
 
async void SendHeartbeat (string authToken, int sessionId, Action< HttpResponseMessage, object > success=null, Action< HttpResponseMessage, FailureResponse > failure=null)
 
async void SendSessionEvent (string authToken, SessionEventData sessionEvent, Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure)
 
void SetEndpoint (string endpointUrl)
 
void SetPlatformEndpoint (string endpointUrl)
 

Public Attributes

APIResponse OnAPIResponse
 

Protected Attributes

HttpClient apiHandlingClient = null
 
string apiURL = ""
 
HttpClient handlingClient = null
 
string URL = ""
 

Private Member Functions

void EnsureURLHasProtocol (ref string url)
 
FailureResponse GetGQLFailureResponse (JObject jsonResponse, string jsonDataObjectKey)
 
HttpResponseMessage HandleException (Exception exception)
 

Detailed Description

Definition at line 33 of file PlatformAPIHandler.cs.

Constructor & Destructor Documentation

◆ APIHandler() [1/2]

PixoVR.Apex.APIHandler.APIHandler ( )
inline

Definition at line 46 of file PlatformAPIHandler.cs.

◆ APIHandler() [2/2]

PixoVR.Apex.APIHandler.APIHandler ( string endpointUrl)
inline

Definition at line 49 of file PlatformAPIHandler.cs.

Here is the call graph for this function:

Member Function Documentation

◆ APIResponse()

delegate void PixoVR.Apex.APIHandler.APIResponse ( ResponseType type,
HttpResponseMessage message,
object responseData )

◆ CompleteSession()

async void PixoVR.Apex.APIHandler.CompleteSession ( string authToken,
CompleteSessionData completionData,
Action< HttpResponseMessage, object > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 605 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ EnsureURLHasProtocol()

void PixoVR.Apex.APIHandler.EnsureURLHasProtocol ( ref string url)
inlineprivate

Definition at line 82 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ GenerateAssistedLogin()

async void PixoVR.Apex.APIHandler.GenerateAssistedLogin ( string authToken,
int userId,
Action< HttpResponseMessage, object > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 125 of file PlatformAPIHandler.cs.

Here is the call graph for this function:

◆ GetDevicesForOrg()

async void PixoVR.Apex.APIHandler.GetDevicesForOrg ( string authToken,
int orgID,
int page,
FilterParams filterParams,
Action< HttpResponseMessage, OrgDevicesResponse > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 255 of file PlatformAPIHandler.cs.

Here is the call graph for this function:

◆ GetGQLFailureResponse()

FailureResponse PixoVR.Apex.APIHandler.GetGQLFailureResponse ( JObject jsonResponse,
string jsonDataObjectKey )
inlineprivate

Definition at line 692 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ GetModuleAccess()

async void PixoVR.Apex.APIHandler.GetModuleAccess ( int moduleId,
int userId,
string serialNumber )
inline

Definition at line 520 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ GetModuleList()

async void PixoVR.Apex.APIHandler.GetModuleList ( string authToken,
string platform )
inline

Definition at line 647 of file PlatformAPIHandler.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetQuickIDAuthenticationUsers()

async void PixoVR.Apex.APIHandler.GetQuickIDAuthenticationUsers ( string serialNumber)
inline

Definition at line 456 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ GetSessionHistory()

async void PixoVR.Apex.APIHandler.GetSessionHistory ( string authToken,
int page,
SessionFilters sessionFilters,
FilterParams filterParams,
Action< HttpResponseMessage, SessionHistoryResponse > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 309 of file PlatformAPIHandler.cs.

Here is the call graph for this function:

◆ GetUserData()

async void PixoVR.Apex.APIHandler.GetUserData ( string authToken,
int userId )
inline

Definition at line 412 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ GetUserMetricsForOrg()

async void PixoVR.Apex.APIHandler.GetUserMetricsForOrg ( string authToken,
int orgID,
int page,
FilterParams filterParams,
Action< UserMetricsResponse, object > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 201 of file PlatformAPIHandler.cs.

Here is the call graph for this function:

◆ GetUserModules()

async void PixoVR.Apex.APIHandler.GetUserModules ( string authToken,
int userId )
inline

Definition at line 430 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ HandleException()

HttpResponseMessage PixoVR.Apex.APIHandler.HandleException ( Exception exception)
inlineprivate

Definition at line 57 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ JoinSession()

async void PixoVR.Apex.APIHandler.JoinSession ( string authToken,
JoinSessionData joinData,
Action< HttpResponseMessage, JoinSessionResponse > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 578 of file PlatformAPIHandler.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Login()

async void PixoVR.Apex.APIHandler.Login ( LoginData login)
inline

Definition at line 390 of file PlatformAPIHandler.cs.

◆ LoginWithToken()

async void PixoVR.Apex.APIHandler.LoginWithToken ( string token)
inline

Definition at line 367 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ Ping()

async void PixoVR.Apex.APIHandler.Ping ( Action< HttpResponseMessage, object > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 101 of file PlatformAPIHandler.cs.

Here is the call graph for this function:

◆ QuickIDLogin()

async void PixoVR.Apex.APIHandler.QuickIDLogin ( QuickIDLoginData login)
inline

Definition at line 475 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ SendHeartbeat()

async void PixoVR.Apex.APIHandler.SendHeartbeat ( string authToken,
int sessionId,
Action< HttpResponseMessage, object > success = null,
Action< HttpResponseMessage, FailureResponse > failure = null )
inline

Definition at line 552 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ SendSessionEvent()

async void PixoVR.Apex.APIHandler.SendSessionEvent ( string authToken,
SessionEventData sessionEvent,
Action< HttpResponseMessage, object > success,
Action< HttpResponseMessage, FailureResponse > failure )
inline

Definition at line 626 of file PlatformAPIHandler.cs.

Here is the caller graph for this function:

◆ SetEndpoint()

void PixoVR.Apex.APIHandler.SetEndpoint ( string endpointUrl)
inline

Definition at line 65 of file PlatformAPIHandler.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetPlatformEndpoint()

void PixoVR.Apex.APIHandler.SetPlatformEndpoint ( string endpointUrl)
inline

Definition at line 74 of file PlatformAPIHandler.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ apiHandlingClient

HttpClient PixoVR.Apex.APIHandler.apiHandlingClient = null
protected

Definition at line 44 of file PlatformAPIHandler.cs.

◆ apiURL

string PixoVR.Apex.APIHandler.apiURL = ""
protected

Definition at line 43 of file PlatformAPIHandler.cs.

◆ handlingClient

HttpClient PixoVR.Apex.APIHandler.handlingClient = null
protected

Definition at line 39 of file PlatformAPIHandler.cs.

◆ OnAPIResponse

APIResponse PixoVR.Apex.APIHandler.OnAPIResponse

Definition at line 36 of file PlatformAPIHandler.cs.

◆ URL

string PixoVR.Apex.APIHandler.URL = ""
protected

Definition at line 38 of file PlatformAPIHandler.cs.

The documentation for this class was generated from the following file: