|
|
Documentation for the Unity C# Library
|
Public Member Functions | |
| bool | InitializeInstance (T targetInstance) |
| virtual void | OnDestroy () |
| When Unity quits, it destroys objects in a random order. In principle, a Singleton is only destroyed when application quits. If any script calls Instance after it have been destroyed, it will create a buggy ghost object that will stay on the Editor scene even after stopping playing the Application. Really bad! So, this was made to be sure we're not creating that buggy ghost object. | |
Static Public Member Functions | |
| static void | ChangePlatformServer (PlatformServer newServer) |
| static bool | CheckModuleAccess (int targetModuleID=-1) |
| static void | CompleteSession (SessionData currentSessionData, Extension contextExtension=null, Extension resultExtension=null, Action< HttpResponseMessage, object > success=null, Action< HttpResponseMessage, FailureResponse > failure=null) |
| static void | ExitApplication (string nextExitTarget="") |
| static bool | GenerateOneTimeLoginForCurrentUser (Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure) |
| static void | GenerateOneTimeLoginForUser (int userId, Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure) |
| static bool | GetCurrentUser () |
| static bool | GetCurrentUserModules () |
| static void | GetDevicesForOrg (int page, FilterParams filterParams, Action< HttpResponseMessage, OrgDevicesResponse > success, Action< HttpResponseMessage, FailureResponse > failure) |
| static bool | GetModulesList (string platformName) |
| static bool | GetQuickIDAuthUsers (string serialNumber) |
| static void | GetSesssionHistory (int page, SessionFilters sessionFilters, FilterParams filterParams, Action< HttpResponseMessage, SessionHistoryResponse > success, Action< HttpResponseMessage, FailureResponse > failure) |
| static bool | GetUser (int userId=-1) |
| static void | GetUserMetricsForCurrentUsersOrg (int page, FilterParams filterParams, Action< UserMetricsResponse, object > success, Action< HttpResponseMessage, FailureResponse > failure) |
| static bool | GetUserModules (int userId=-1) |
| static void | JoinSession (string scenarioID=null, Extension contextExtension=null, Action< HttpResponseMessage, JoinSessionResponse > success=null, Action< HttpResponseMessage, FailureResponse > failure=null) |
| static bool | Login (LoginData login) |
| static bool | Login (string username, string password) |
| static bool | LoginWithToken () |
| static bool | LoginWithToken (string token) |
| static void | Ping (Action< HttpResponseMessage, object > success=null, Action< HttpResponseMessage, FailureResponse > failure=null) |
| static bool | QuickIDLogin (string serialNumber, string username) |
| static bool | RequestAuthorizationCode () |
| static void | SendSessionEvent (Statement eventStatement, Action< HttpResponseMessage, object > success=null, Action< HttpResponseMessage, FailureResponse > failure=null) |
| static void | SendSimpleSessionEvent (string action, string targetObject, Extension contextExtension, Action< HttpResponseMessage, object > success=null, Action< HttpResponseMessage, FailureResponse > failure=null) |
Protected Member Functions | |
| void | _ChangePlatformServer (PlatformServer newServer) |
| bool | _CheckModuleAccess (int targetModuleID=-1) |
| void | _CompleteSession (SessionData currentSessionData, Extension contextExtension, Extension resultExtension, Action< HttpResponseMessage, object > success=null, Action< HttpResponseMessage, FailureResponse > failure=null) |
| bool | _GetModuleList (string platformName) |
| bool | _GetQuickIDAuthUsers (string serialNumber) |
| bool | _GetUser (int userId=-1) |
| bool | _GetUserModules (int userId=-1) |
| void | _JoinSession (string newScenarioID, Extension contextExtension, Action< HttpResponseMessage, JoinSessionResponse > success, Action< HttpResponseMessage, FailureResponse > failure) |
| bool | _LoginWithToken (string token) |
| void | _ParsePassedData (Dictionary< string, string > arguments) |
| bool | _QuickIDLogin (string serialNumber, string username) |
| bool | _SendHeartbeat () |
| void | _SendSessionEvent (Statement eventStatement, Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure) |
| void | _SendSimpleSessionEvent (string verbName, string targetObject, Extension contextExtension, Action< HttpResponseMessage, object > success, Action< HttpResponseMessage, FailureResponse > failure) |
| FailureResponse | GenerateFailureResponse (string message) |
| void | HandleLogin (bool successful, object responseData) |
| void | OnAPIResponse (ResponseType response, HttpResponseMessage message, object responseData) |
Protected Attributes | |
| APIHandler | apexAPIHandler |
| string | clientIP |
| LoginResponseContent | currentActiveLogin = null |
| string | currentExitTargetParameter = "" |
| Guid | currentSessionID |
| string | deviceID |
| string | deviceModel |
| string | deviceSerialNumber = "" |
| bool | hasParsedArguments = false |
| int | heartbeatSessionID |
| float | heartbeatTime = 5.0f |
| [SerializeField] | |
| float | heartbeatTimer |
| string | loginToken = "" |
| int | moduleID = 0 |
| [SerializeField] | |
| string | moduleName = "Generic" |
| [SerializeField] | |
| string | moduleVersion = "" |
| [SerializeField] | |
| string | optionalParameter = "" |
| string | platform |
| PlatformServer | PlatformTargetServer |
| string | scenarioID = "Generic" |
| [SerializeField] | |
| string | serverIP = "" |
| [SerializeField] | |
| bool | sessionInProgress |
| Task< bool > | socketConnectTask |
| Task | socketDisconnectTask |
| string | targetTypeParameter = "" |
| bool | userAccessVerified = false |
| ApexWebsocket | webSocket |
| string | webSocketUrl |
Properties | |
| static APIHandler | ApexAPIHandler [get] |
| static string | APIEndpoint [get] |
| static LoginResponseContent | CurrentActiveLogin [get, set] |
| static string | CurrentExitTarget [get, set] |
| static string | DeviceSerialNumber [get, set] |
| static T | Instance [get] |
| static bool | LoginCheckModuleAccess [get, set] |
| static int | ModuleID [get, set] |
| static string | ModuleName [get, set] |
| static string | ModuleVersion [get, set] |
| static string | OptionalData [get, set] |
| static string | PassedLoginToken [get, protected set] |
| static bool | RunSetupOnAwake [get, set] |
| static string | ScenarioID [get, set] |
| static string | ServerIP [get, set] |
| static string | TargetType [get, private set] |
Private Types | |
| enum | VersionParts : int { Major = 0 , Minor , Patch } |
Static Private Attributes | |
| static bool | ApplicationIsQuitting |
| static T | instance |
| static readonly object | lockObject |
| static readonly string | MASTER_TAG |
| static readonly string | TAG = "ApexSystem" |
| static readonly Regex | VersionValidator = new Regex(@"^[0123456789.]+$") |
Definition at line 25 of file ApexSystem.cs.
|
private |
| Enumerator | |
|---|---|
| Major | |
| Minor | |
| Patch | |
Definition at line 28 of file ApexSystem.cs.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprivate |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprivate |
|
inlineprotected |
Definition at line 1246 of file ApexSystem.cs.
|
inlineprotected |
Definition at line 1076 of file ApexSystem.cs.
|
inlineprotected |
|
inlineprivate |
|
inlineprivate |
Definition at line 1325 of file ApexSystem.cs.
|
inlineprivate |
|
inlinestatic |
Definition at line 748 of file ApexSystem.cs.
|
inlinestatic |
|
inlinestatic |
Definition at line 827 of file ApexSystem.cs.
|
inlineprivate |
Definition at line 639 of file ApexSystem.cs.
|
inlineprivate |
|
inlineprivate |
Definition at line 644 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 738 of file ApexSystem.cs.
|
inlineprivate |
|
inlineprotected |
Definition at line 898 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 1536 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 1549 of file ApexSystem.cs.
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
Definition at line 1580 of file ApexSystem.cs.
|
inlineprivate |
|
inlinestatic |
Definition at line 862 of file ApexSystem.cs.
|
inlineprivate |
|
inlinestatic |
Definition at line 867 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 1592 of file ApexSystem.cs.
|
inlinestatic |
|
inlinestatic |
Definition at line 1568 of file ApexSystem.cs.
|
inlinestatic |
|
inlineprotected |
Definition at line 1503 of file ApexSystem.cs.
|
inlineinherited |
Definition at line 14 of file ApexSingleton.cs.
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
Definition at line 687 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 822 of file ApexSystem.cs.
|
inlinestatic |
|
inlinestatic |
|
inlinestatic |
Definition at line 758 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 764 of file ApexSystem.cs.
|
inlineprotected |
Definition at line 1355 of file ApexSystem.cs.
|
inlineprivate |
Definition at line 340 of file ApexSystem.cs.
|
inlinevirtualinherited |
When Unity quits, it destroys objects in a random order. In principle, a Singleton is only destroyed when application quits. If any script calls Instance after it have been destroyed, it will create a buggy ghost object that will stay on the Editor scene even after stopping playing the Application. Really bad! So, this was made to be sure we're not creating that buggy ghost object.
Definition at line 93 of file ApexSingleton.cs.
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
Definition at line 659 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 753 of file ApexSystem.cs.
|
inlineprivate |
|
inlinestatic |
Definition at line 872 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 743 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 837 of file ApexSystem.cs.
|
inlinestatic |
Definition at line 832 of file ApexSystem.cs.
|
inlineprivate |
Definition at line 402 of file ApexSystem.cs.
|
inlineprivate |
Definition at line 330 of file ApexSystem.cs.
|
inlineprivate |
Definition at line 347 of file ApexSystem.cs.
|
inlineprivate |
|
protected |
Definition at line 245 of file ApexSystem.cs.
|
staticprivateinherited |
Definition at line 84 of file ApexSingleton.cs.
|
protected |
Definition at line 230 of file ApexSystem.cs.
|
protected |
Definition at line 244 of file ApexSystem.cs.
|
protected |
Definition at line 241 of file ApexSystem.cs.
|
protected |
Definition at line 231 of file ApexSystem.cs.
|
protected |
Definition at line 227 of file ApexSystem.cs.
|
protected |
Definition at line 228 of file ApexSystem.cs.
|
protected |
Definition at line 236 of file ApexSystem.cs.
|
protected |
Definition at line 237 of file ApexSystem.cs.
|
protected |
Definition at line 232 of file ApexSystem.cs.
|
protectedSerializeField |
[SerializeField]
Definition at line 224 of file ApexSystem.cs.
|
protected |
Definition at line 233 of file ApexSystem.cs.
|
staticprivateinherited |
Definition at line 10 of file ApexSingleton.cs.
|
staticprivateinherited |
Definition at line 12 of file ApexSingleton.cs.
|
SerializeField |
[SerializeField]
Definition at line 215 of file ApexSystem.cs.
|
protected |
Definition at line 239 of file ApexSystem.cs.
|
staticprivateinherited |
Definition at line 9 of file ApexSingleton.cs.
|
protectedSerializeField |
[SerializeField]
Definition at line 170 of file ApexSystem.cs.
|
protectedSerializeField |
[SerializeField]
Definition at line 179 of file ApexSystem.cs.
|
protectedSerializeField |
[SerializeField]
Definition at line 188 of file ApexSystem.cs.
| OnAuthCodeReceived PixoVR.Apex.ApexSystem.OnAuthorizationCodeReceived = new OnAuthCodeReceived() |
Definition at line 267 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnGeneratedAssistedLoginFailed = new() |
Definition at line 270 of file ApexSystem.cs.
| OnGeneratedAssistedLoginSuccessEvent PixoVR.Apex.ApexSystem.OnGeneratedAssistedLoginSuccess = new() |
Definition at line 269 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnGetOrganizationModulesFailed = new OnApexFailureEvent() |
Definition at line 263 of file ApexSystem.cs.
| OnGetOrgModulesSuccessEvent PixoVR.Apex.ApexSystem.OnGetOrganizationModulesSuccess = new OnGetOrgModulesSuccessEvent() |
Definition at line 262 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnGetQuickIDAuthGetUsersFailed = new() |
Definition at line 273 of file ApexSystem.cs.
| OnGetQuickIDAuthUsersSuccessEvent PixoVR.Apex.ApexSystem.OnGetQuickIDAuthGetUsersSuccess = new() |
Definition at line 272 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnGetUserFailed = new OnApexFailureEvent() |
Definition at line 257 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnGetUserModulesFailed = new OnApexFailureEvent() |
Definition at line 260 of file ApexSystem.cs.
| OnGetUserModulesSuccessEvent PixoVR.Apex.ApexSystem.OnGetUserModulesSuccess = new OnGetUserModulesSuccessEvent() |
Definition at line 259 of file ApexSystem.cs.
| OnGetUserSuccessEvent PixoVR.Apex.ApexSystem.OnGetUserSuccess = new OnGetUserSuccessEvent() |
Definition at line 256 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnLoginFailed = new OnApexFailureEvent() |
Definition at line 254 of file ApexSystem.cs.
| OnLoginSuccessEvent PixoVR.Apex.ApexSystem.OnLoginSuccess = new OnLoginSuccessEvent() |
Definition at line 253 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnModuleAccessFailed = new OnApexFailureEvent() |
Definition at line 251 of file ApexSystem.cs.
| OnModuleAccessSuccessEvent PixoVR.Apex.ApexSystem.OnModuleAccessSuccess = new OnModuleAccessSuccessEvent() |
Definition at line 250 of file ApexSystem.cs.
| PlatformResponse PixoVR.Apex.ApexSystem.OnPlatformResponse = null |
Definition at line 265 of file ApexSystem.cs.
| OnApexFailureEvent PixoVR.Apex.ApexSystem.OnQuickIDAuthLoginFailed = new() |
Definition at line 276 of file ApexSystem.cs.
| OnQuickIDAuthLoginSuccessEvent PixoVR.Apex.ApexSystem.OnQuickIDAuthLoginSuccess = new() |
Definition at line 275 of file ApexSystem.cs.
|
protected |
Definition at line 240 of file ApexSystem.cs.
|
protected |
Definition at line 229 of file ApexSystem.cs.
|
protected |
Definition at line 152 of file ApexSystem.cs.
|
SerializeField |
[SerializeField]
Definition at line 206 of file ApexSystem.cs.
|
protectedSerializeField |
[SerializeField]
Definition at line 197 of file ApexSystem.cs.
|
protectedSerializeField |
[SerializeField]
Definition at line 161 of file ApexSystem.cs.
|
protected |
Definition at line 234 of file ApexSystem.cs.
|
protected |
Definition at line 247 of file ApexSystem.cs.
|
protected |
Definition at line 248 of file ApexSystem.cs.
|
staticprivate |
Definition at line 27 of file ApexSystem.cs.
|
protected |
Definition at line 242 of file ApexSystem.cs.
|
protected |
Definition at line 235 of file ApexSystem.cs.
|
staticprivate |
Definition at line 709 of file ApexSystem.cs.
|
protected |
Definition at line 246 of file ApexSystem.cs.
|
protected |
Definition at line 226 of file ApexSystem.cs.
|
staticget |
Definition at line 146 of file ApexSystem.cs.
|
staticget |
Definition at line 141 of file ApexSystem.cs.
|
staticgetset |
Definition at line 65 of file ApexSystem.cs.
|
staticgetset |
Definition at line 110 of file ApexSystem.cs.
|
staticgetset |
Definition at line 83 of file ApexSystem.cs.
|
staticgetinherited |
Definition at line 34 of file ApexSingleton.cs.
|
staticgetset |
Definition at line 77 of file ApexSystem.cs.
|
staticgetset |
Definition at line 41 of file ApexSystem.cs.
|
staticgetset |
Definition at line 47 of file ApexSystem.cs.
|
staticgetset |
Definition at line 53 of file ApexSystem.cs.
|
staticgetset |
Definition at line 104 of file ApexSystem.cs.
|
staticgetprotected set |
Definition at line 89 of file ApexSystem.cs.
|
staticgetset |
Definition at line 71 of file ApexSystem.cs.
|
staticgetset |
Definition at line 59 of file ApexSystem.cs.
|
staticgetset |
Definition at line 35 of file ApexSystem.cs.
|
staticgetprivate set |
Definition at line 135 of file ApexSystem.cs.