1.x.x |
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.")) | |
void | ExitApplication (const FString &InReturnTarget, const FString &InReturnTargetType) |
UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
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 | SetExitParameters (const FString &SetExitTarget) |
UFUNCTION(BlueprintCallable, Category = "Apex|SDK") | |
void | SetExitTarget (const FString &InExitTarget, const FString &InExitTargetType) |
UFUNCTION(BlueprintCallable, Category = "Apex|SDK") | |
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 | ParseIntentData (const FString &InIntentData) |
void | SendHeartbeat () |
void | SetupModuleSettings () |
Protected Attributes | |
bool | bSessionInProgress |
UPROPERTY(BlueprintReadOnly) | |
bool | bWebSocketEnabled |
UPROPERTY(BlueprintReadOnly) | |
FString | ReturnParameters |
UPROPERTY(BlueprintReadOnly) | |
FString | ReturnTarget |
UPROPERTY(BlueprintReadOnly) | |
FString | ReturnTargetType |
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 756 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 237 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 269 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 967 of file ApexAPI.cpp.
|
protected |
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API", meta = (DisplayName = "Fetch Top Ten By User"))
Definition at line 972 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 982 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API", meta=(DisplayName = "Fetch Top Ten By User"))
Definition at line 977 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 397 of file ApexAPI.cpp.
|
private |
|
protected |
|
protected |
Definition at line 469 of file ApexAPI.cpp.
|
BlueprintPureBlueprintCallable |
UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Apex|API")
Definition at line 426 of file ApexAPI.cpp.
|
overridevirtual |
|
BlueprintPureBlueprintCallable |
UFUNCTION(BlueprintPure, BlueprintCallable, Category = "Apex|API")
Definition at line 431 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 226 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 630 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 403 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 379 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 493 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 854 of file ApexAPI.cpp.
|
protected |
Definition at line 724 of file ApexAPI.cpp.
|
protected |
Definition at line 741 of file ApexAPI.cpp.
|
protected |
Definition at line 436 of file ApexAPI.cpp.
|
protected |
Definition at line 455 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 537 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 366 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 954 of file ApexAPI.cpp.
|
protected |
Definition at line 1046 of file ApexAPI.cpp.
|
protected |
Definition at line 1079 of file ApexAPI.cpp.
|
protected |
Definition at line 578 of file ApexAPI.cpp.
|
protected |
Definition at line 607 of file ApexAPI.cpp.
|
protected |
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 347 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 248 of file ApexAPI.cpp.
|
protected |
Definition at line 1092 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 867 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|SDK")
Definition at line 263 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|SDK")
Definition at line 256 of file ApexAPI.cpp.
|
protected |
Definition at line 26 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 550 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 |
|
protectedBlueprintReadOnly |
|
protectedBlueprintReadOnly |
|
protectedBlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |