A Demo Project for the UnrealEngineSDK
|
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")) | |
virtual void | Initialize (FSubsystemCollectionBase &Collection) override |
bool | IsWebSocketConnected () |
UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
bool | JoinSession (FString InScenarioId, const FXAPIExtension &InContextExtension) |
UFUNCTION(BlueprintCallable, Category = "Apex|API") | |
void | Login (const FApexLoginInfo &InLoginInfo, bool bShouldLogout=true) |
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") | |
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(BlueprintReadOnly, 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 Attributes | |
bool | SessionInProgress |
UPROPERTY(BlueprintReadOnly) | |
bool | WebSocketEnabled |
UPROPERTY(BlueprintReadOnly) | |
Private Member Functions | |
GENERATED_BODY () | |
Private Attributes | |
class UApexSDKSettings * | ApexSettings |
TUniquePtr< ApexWebSocket > | ApexSocket |
FString | AuthorizationToken |
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 18 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 500 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 131 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 709 of file ApexAPI.cpp.
|
protected |
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API", meta = (DisplayName = "Fetch Top Ten By User"))
Definition at line 714 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 724 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API", meta=(DisplayName = "Fetch Top Ten By User"))
Definition at line 719 of file ApexAPI.cpp.
|
private |
|
protected |
Definition at line 238 of file ApexAPI.cpp.
|
overridevirtual |
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 120 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 393 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 182 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 252 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 596 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 485 of file ApexAPI.cpp.
|
protected |
Definition at line 205 of file ApexAPI.cpp.
|
protected |
Definition at line 224 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 310 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 169 of file ApexAPI.cpp.
|
protected |
|
protected |
Definition at line 696 of file ApexAPI.cpp.
|
protected |
Definition at line 788 of file ApexAPI.cpp.
|
protected |
Definition at line 818 of file ApexAPI.cpp.
|
protected |
Definition at line 341 of file ApexAPI.cpp.
|
protected |
Definition at line 370 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 150 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 142 of file ApexAPI.cpp.
|
BlueprintCallable |
UFUNCTION(BlueprintCallable, Category = "Apex|API")
Definition at line 609 of file ApexAPI.cpp.
|
protected |
Definition at line 24 of file ApexAPI.cpp.
|
protected |
Definition at line 323 of file ApexAPI.cpp.
|
private |
|
private |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
BlueprintReadOnly |
|
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 |
|
protectedBlueprintReadOnly |
|
BlueprintReadOnly |
|
private |
|
protectedBlueprintReadOnly |
|
BlueprintReadOnly |