|
|
Documentation for the Unreal C++ Plugin
|
UCLASS(BlueprintType, Blueprintable) More...
#include <ApexAPI.h>
Public Member Functions | |
| UApexAPI () | |
| bool | CompleteSession (const FSessionData &InSessionData) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| void | ConnectWebSocketService () |
| UFUNCTION(BlueprintCallable, Category = "Apex|API", meta = (Tooltip = "This function only needs to be called when a user has logged out.")) | |
| bool | FetchTopTen (FString Scenario, int OrgUnit) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| bool | FetchTopTenByCurrentUser (FString Scenario) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API", meta = (DisplayName = "Fetch Top Ten By User")) | |
| bool | FetchTopTenByTimeRange (float TimePriorToToday, FString Scenario, int OrgUnit) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| bool | FetchTopTenByUser (int UserId, FString Scenario, int OrgUnit) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API", meta=(DisplayName = "Fetch Top Ten By User")) | |
| void | FilloutLaunchToken () |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| bool | HasLaunchAuthToken () |
| UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Apex|API") | |
| virtual void | Initialize (FSubsystemCollectionBase &Collection) override |
| bool | IsLoggedIn () |
| UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Apex|API") | |
| bool | IsWebSocketConnected () |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| bool | JoinSession (FString InScenarioId, const FXAPIExtension &InContextExtension, bool bIsMultiplayer=false) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| void | Login (const FString &InUserName, const FString &InPassword, bool bShouldLogout=true) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| void | LoginWithAuthToken () |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| void | Logout () |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| void | Ping () |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| void | RequestAuthorizationCode () |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| bool | SendSessionEvent (const FXAPIStatement &InStatement) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
| void | VerifyModuleAccess (int InModuleId) |
| UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
Public Attributes | |
| FString | ClientIP |
| UPROPERTY(BlueprintReadOnly) | |
| FUserSessionData | CurrentActiveLogin |
| UPROPERTY(BlueprintReadOnly) | |
| FGuid | CurrentSessionGuid |
| UPROPERTY(BlueprintReadOnly) | |
| FString | DeviceId |
| UPROPERTY(BlueprintReadOnly) | |
| FString | DeviceModel |
| UPROPERTY(BlueprintReadOnly) | |
| int | LoadedModuleId |
| UPROPERTY(BlueprintReadWrite, Meta=(DisplayName="Module Id")) | |
| FString | ModuleVersion |
| UPROPERTY(BlueprintReadOnly) | |
| FOnApexAuthCodeRetrieved | OnAuthorizationCodeRetrieved |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FOnApexTopTenDataComplete | OnFetchTopTenComplete |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FOnApexTopTenDataFail | OnFetchTopTenFail |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FOnApexRequestComplete | OnRequestComplete |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FOnApexRequestFail | OnRequestFail |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FOnStaticApexAuthCodeRetrieved | OnStaticAuthorizationCodeRetrieved |
| FOnStaticApexTopTenDataComplete | OnStaticFetchTopTenComplete |
| FOnStaticApexTopTenDataFail | OnStaticFetchTopTenFail |
| FOnStaticApexRequestComplete | OnStaticRequestComplete |
| FOnStaticApexRequestFail | OnStaticRequestFail |
| FOnStaticApexWebSocketConnected | OnStaticWebSocketConnected |
| FOnStaticApexWebSocketConnectFailed | OnStaticWebSocketConnectFailed |
| FOnStaticApexWebSocketDisconnected | OnStaticWebSocketDisconnected |
| FOnApexWebSocketConnected | OnWebSocketConnected |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FOnApexWebSocketConnectFailed | OnWebSocketConnectFailed |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FOnApexWebSocketDisconnected | OnWebSocketDisconnected |
| UPROPERTY(BlueprintAssignable, Category = "Apex|Event") | |
| FString | Platform |
| UPROPERTY(BlueprintReadOnly) | |
| FString | ScenarioId |
| UPROPERTY(BlueprintReadOnly) | |
| FString | URL |
| The API URL. | |
| FString | WebSocketURL |
| The API Websocket URL. | |
Protected Member Functions | |
| bool | FetchTopTen (int UserId, float TimePriorToToday, FString Scenario, int OrgUnit) |
| TSharedRef< FJsonObject > | GetUserJsonObject (TSharedRef< FJsonObject > &RootJsonObject) |
| void | HandleLogin (class UVaRestJsonObject *LoginJsonObject) |
| void | OnCompleteSessionComplete (const class UVaRestRequestJSON *Request) |
| void | OnCompleteSessionFail (const class UVaRestRequestJSON *Request) |
| void | OnJoinSessionComplete (const class UVaRestRequestJSON *Request) |
| void | OnJoinSessionFail (const class UVaRestRequestJSON *Request) |
| void | OnLoginComplete (const class UVaRestRequestJSON *Request) |
| void | OnLoginFail (const class UVaRestRequestJSON *Request) |
| void | OnLogoutComplete (const class UVaRestRequestJSON *Request) |
| void | OnLogoutFail (const class UVaRestRequestJSON *Request) |
| void | OnPingComplete (const class UVaRestRequestJSON *Request) |
| void | OnPingFail (const class UVaRestRequestJSON *Request) |
| void | OnSendSessionEventComplete (const class UVaRestRequestJSON *Request) |
| void | OnSendSessionEventFail (const class UVaRestRequestJSON *Request) |
| void | OnTopTenComplete (const class UVaRestRequestJSON *Request) |
| void | OnTopTenFail (const class UVaRestRequestJSON *Request) |
| void | OnUserVerificationComplete (const class UVaRestRequestJSON *Request) |
| void | OnUserVerificationFail (const class UVaRestRequestJSON *Request) |
| void | SendHeartbeat () |
| void | SetupModuleSettings () |
Protected Attributes | |
| bool | bSessionInProgress |
| UPROPERTY(BlueprintReadOnly) | |
| bool | bWebSocketEnabled |
| UPROPERTY(BlueprintReadOnly) | |
Private Member Functions | |
| GENERATED_BODY () | |
Private Attributes | |
| class UApexSDKSettings * | ApexSettings |
| TUniquePtr< ApexWebSocket > | ApexSocket |
| FTimerHandle | HeartbeatHandle |
| class UPixoLauncherSubsystem * | LauncherSubsystem |
| FString | LaunchToken |
| int | SessionId |
| class UVaRestSubsystem * | VaRestSubsystem |
UCLASS(BlueprintType, Blueprintable)
The main class to access the Apex platform API.
UApexAPI contains functionality to reach the Apex API. Information about the module, platform and HMD device is readable from here as well. It also contains information about the current user.
| UApexAPI::UApexAPI | ( | ) |
Definition at line 19 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 582 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API", meta = (Tooltip = "This function only needs to be called when a user has logged out."))
Definition at line 155 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 793 of file ApexAPI.cpp.
|
protected |
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API", meta = (DisplayName = "Fetch Top Ten By User"))
Definition at line 798 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 808 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API", meta=(DisplayName = "Fetch Top Ten By User"))
Definition at line 803 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 224 of file ApexAPI.cpp.
|
private |
|
protected |
|
protected |
Definition at line 295 of file ApexAPI.cpp.
|
BlueprintPureBlueprintCallable |
UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Apex|API")
Definition at line 252 of file ApexAPI.cpp.
|
overridevirtual |
|
BlueprintPureBlueprintCallable |
UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Apex|API")
Definition at line 257 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 144 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 456 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 229 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 206 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 319 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 680 of file ApexAPI.cpp.
|
protected |
Definition at line 550 of file ApexAPI.cpp.
|
protected |
Definition at line 567 of file ApexAPI.cpp.
|
protected |
Definition at line 262 of file ApexAPI.cpp.
|
protected |
Definition at line 281 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 363 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 193 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 780 of file ApexAPI.cpp.
|
protected |
Definition at line 872 of file ApexAPI.cpp.
|
protected |
Definition at line 905 of file ApexAPI.cpp.
|
protected |
Definition at line 404 of file ApexAPI.cpp.
|
protected |
Definition at line 433 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 174 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 166 of file ApexAPI.cpp.
|
protected |
Definition at line 918 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 693 of file ApexAPI.cpp.
|
protected |
Definition at line 26 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 376 of file ApexAPI.cpp.
|
private |
|
private |
|
protectedBlueprintReadOnly |
|
protectedBlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
private |
|
BlueprintReadWrite |
|
BlueprintReadOnly |
|
BlueprintAssignable |
|
BlueprintAssignable |
|
BlueprintAssignable |
|
BlueprintAssignable |
|
BlueprintAssignable |
| FOnStaticApexAuthCodeRetrieved UApexAPI::OnStaticAuthorizationCodeRetrieved |
| FOnStaticApexTopTenDataComplete UApexAPI::OnStaticFetchTopTenComplete |
| FOnStaticApexTopTenDataFail UApexAPI::OnStaticFetchTopTenFail |
| FOnStaticApexRequestComplete UApexAPI::OnStaticRequestComplete |
| FOnStaticApexWebSocketConnected UApexAPI::OnStaticWebSocketConnected |
| FOnStaticApexWebSocketConnectFailed UApexAPI::OnStaticWebSocketConnectFailed |
| FOnStaticApexWebSocketDisconnected UApexAPI::OnStaticWebSocketDisconnected |
|
BlueprintAssignable |
|
BlueprintAssignable |
|
BlueprintAssignable |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |