A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
UApexAPI Class ReferenceBlueprintableBlueprintType

UCLASS(BlueprintType, Blueprintable) More...

#include <ApexAPI.h>

Inheritance diagram for UApexAPI:
[legend]

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 Member Functions

bool FetchTopTen (int UserId, float TimePriorToToday, FString Scenario, int OrgUnit)
 
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 SetupModuleSettings ()
 
void VerifyModuleAcess ()
 

Protected Attributes

bool SessionInProgress
 UPROPERTY(BlueprintReadOnly)
 
bool WebSocketEnabled
 UPROPERTY(BlueprintReadOnly)
 

Private Member Functions

 GENERATED_BODY ()
 

Private Attributes

class UApexSDKSettingsApexSettings
 
TUniquePtr< ApexWebSocketApexSocket
 
FString AuthorizationToken
 
class UVaRestSubsystemVaRestSubsystem
 

Detailed Description

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.

Todo
Uncomment out the Logout API call once it's implemented.

Definition at line 67 of file ApexAPI.h.

Constructor & Destructor Documentation

◆ UApexAPI()

UApexAPI::UApexAPI ( )

Definition at line 18 of file ApexAPI.cpp.

Member Function Documentation

◆ CompleteSession()

bool UApexAPI::CompleteSession ( const FSessionData & InSessionData)
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 500 of file ApexAPI.cpp.

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

◆ ConnectWebSocketService()

void UApexAPI::ConnectWebSocketService ( )
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.

◆ FetchTopTen() [1/2]

bool UApexAPI::FetchTopTen ( FString Scenario,
int OrgUnit )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 709 of file ApexAPI.cpp.

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

◆ FetchTopTen() [2/2]

bool UApexAPI::FetchTopTen ( int UserId,
float TimePriorToToday,
FString Scenario,
int OrgUnit )
protected

Definition at line 729 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ FetchTopTenByCurrentUser()

bool UApexAPI::FetchTopTenByCurrentUser ( FString Scenario)
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API", meta = (DisplayName = "Fetch Top Ten By User"))

Definition at line 714 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ FetchTopTenByTimeRange()

bool UApexAPI::FetchTopTenByTimeRange ( float TimePriorToToday,
FString Scenario,
int OrgUnit )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 724 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ FetchTopTenByUser()

bool UApexAPI::FetchTopTenByUser ( int UserId,
FString Scenario,
int OrgUnit )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API", meta=(DisplayName = "Fetch Top Ten By User"))

Definition at line 719 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ GENERATED_BODY()

UApexAPI::GENERATED_BODY ( )
private

◆ HandleLogin()

void UApexAPI::HandleLogin ( class UVaRestJsonObject * LoginJsonObject)
protected

Definition at line 238 of file ApexAPI.cpp.

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

◆ Initialize()

void UApexAPI::Initialize ( FSubsystemCollectionBase & Collection)
overridevirtual

Definition at line 86 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ IsWebSocketConnected()

bool UApexAPI::IsWebSocketConnected ( )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 120 of file ApexAPI.cpp.

◆ JoinSession()

bool UApexAPI::JoinSession ( FString InScenarioId,
const FXAPIExtension & InContextExtension )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 393 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ Login()

void UApexAPI::Login ( const FApexLoginInfo & InLoginInfo,
bool bShouldLogout = true )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 182 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ Logout()

void UApexAPI::Logout ( )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 252 of file ApexAPI.cpp.

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

◆ OnCompleteSessionComplete()

void UApexAPI::OnCompleteSessionComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 587 of file ApexAPI.cpp.

Here is the caller graph for this function:

◆ OnCompleteSessionFail()

void UApexAPI::OnCompleteSessionFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 596 of file ApexAPI.cpp.

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

◆ OnJoinSessionComplete()

void UApexAPI::OnJoinSessionComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 477 of file ApexAPI.cpp.

Here is the caller graph for this function:

◆ OnJoinSessionFail()

void UApexAPI::OnJoinSessionFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 485 of file ApexAPI.cpp.

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

◆ OnLoginComplete()

void UApexAPI::OnLoginComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 205 of file ApexAPI.cpp.

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

◆ OnLoginFail()

void UApexAPI::OnLoginFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 224 of file ApexAPI.cpp.

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

◆ OnLogoutComplete()

void UApexAPI::OnLogoutComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 292 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ OnLogoutFail()

void UApexAPI::OnLogoutFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 310 of file ApexAPI.cpp.

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

◆ OnPingComplete()

void UApexAPI::OnPingComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 162 of file ApexAPI.cpp.

Here is the caller graph for this function:

◆ OnPingFail()

void UApexAPI::OnPingFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 169 of file ApexAPI.cpp.

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

◆ OnSendSessionEventComplete()

void UApexAPI::OnSendSessionEventComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 689 of file ApexAPI.cpp.

Here is the caller graph for this function:

◆ OnSendSessionEventFail()

void UApexAPI::OnSendSessionEventFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 696 of file ApexAPI.cpp.

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

◆ OnTopTenComplete()

void UApexAPI::OnTopTenComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 788 of file ApexAPI.cpp.

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

◆ OnTopTenFail()

void UApexAPI::OnTopTenFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 818 of file ApexAPI.cpp.

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

◆ OnUserVerificationComplete()

void UApexAPI::OnUserVerificationComplete ( const class UVaRestRequestJSON * Request)
protected

Definition at line 341 of file ApexAPI.cpp.

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

◆ OnUserVerificationFail()

void UApexAPI::OnUserVerificationFail ( const class UVaRestRequestJSON * Request)
protected

Definition at line 370 of file ApexAPI.cpp.

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

◆ Ping()

void UApexAPI::Ping ( )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 150 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ RequestAuthorizationCode()

void UApexAPI::RequestAuthorizationCode ( )
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 142 of file ApexAPI.cpp.

◆ SendSessionEvent()

bool UApexAPI::SendSessionEvent ( const FXAPIStatement & InStatement)
BlueprintCallable

UFUNCTION(BlueprintCallable, Category = "Apex|API")

Definition at line 609 of file ApexAPI.cpp.

Here is the call graph for this function:

◆ SetupModuleSettings()

void UApexAPI::SetupModuleSettings ( )
protected

Definition at line 24 of file ApexAPI.cpp.

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

◆ VerifyModuleAcess()

void UApexAPI::VerifyModuleAcess ( )
protected

Definition at line 323 of file ApexAPI.cpp.

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

Member Data Documentation

◆ ApexSettings

class UApexSDKSettings* UApexAPI::ApexSettings
private

Definition at line 279 of file ApexAPI.h.

◆ ApexSocket

TUniquePtr<ApexWebSocket> UApexAPI::ApexSocket
private

Definition at line 283 of file ApexAPI.h.

◆ AuthorizationToken

FString UApexAPI::AuthorizationToken
private

Definition at line 281 of file ApexAPI.h.

◆ ClientIP

FString UApexAPI::ClientIP
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 137 of file ApexAPI.h.

◆ CurrentActiveLogin

FUserSessionData UApexAPI::CurrentActiveLogin
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 149 of file ApexAPI.h.

◆ CurrentSessionGuid

FGuid UApexAPI::CurrentSessionGuid
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 143 of file ApexAPI.h.

◆ DeviceId

FString UApexAPI::DeviceId
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 125 of file ApexAPI.h.

◆ DeviceModel

FString UApexAPI::DeviceModel
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 131 of file ApexAPI.h.

◆ LoadedModuleId

int UApexAPI::LoadedModuleId
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly, Meta=(DisplayName="Module Id"))

Definition at line 107 of file ApexAPI.h.

◆ ModuleVersion

FString UApexAPI::ModuleVersion
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 113 of file ApexAPI.h.

◆ OnAuthorizationCodeRetrieved

FOnApexAuthCodeRetrieved UApexAPI::OnAuthorizationCodeRetrieved
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 345 of file ApexAPI.h.

◆ OnFetchTopTenComplete

FOnApexTopTenDataComplete UApexAPI::OnFetchTopTenComplete
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 310 of file ApexAPI.h.

◆ OnFetchTopTenFail

FOnApexTopTenDataFail UApexAPI::OnFetchTopTenFail
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 316 of file ApexAPI.h.

◆ OnRequestComplete

FOnApexRequestComplete UApexAPI::OnRequestComplete
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 294 of file ApexAPI.h.

◆ OnRequestFail

FOnApexRequestFail UApexAPI::OnRequestFail
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 300 of file ApexAPI.h.

◆ OnStaticAuthorizationCodeRetrieved

FOnStaticApexAuthCodeRetrieved UApexAPI::OnStaticAuthorizationCodeRetrieved

Definition at line 353 of file ApexAPI.h.

◆ OnStaticFetchTopTenComplete

FOnStaticApexTopTenDataComplete UApexAPI::OnStaticFetchTopTenComplete

Definition at line 318 of file ApexAPI.h.

◆ OnStaticFetchTopTenFail

FOnStaticApexTopTenDataFail UApexAPI::OnStaticFetchTopTenFail

Definition at line 320 of file ApexAPI.h.

◆ OnStaticRequestComplete

FOnStaticApexRequestComplete UApexAPI::OnStaticRequestComplete

Definition at line 302 of file ApexAPI.h.

◆ OnStaticRequestFail

FOnStaticApexRequestFail UApexAPI::OnStaticRequestFail

Definition at line 303 of file ApexAPI.h.

◆ OnStaticWebSocketConnected

FOnStaticApexWebSocketConnected UApexAPI::OnStaticWebSocketConnected

Definition at line 347 of file ApexAPI.h.

◆ OnStaticWebSocketConnectFailed

FOnStaticApexWebSocketConnectFailed UApexAPI::OnStaticWebSocketConnectFailed

Definition at line 349 of file ApexAPI.h.

◆ OnStaticWebSocketDisconnected

FOnStaticApexWebSocketDisconnected UApexAPI::OnStaticWebSocketDisconnected

Definition at line 351 of file ApexAPI.h.

◆ OnWebSocketConnected

FOnApexWebSocketConnected UApexAPI::OnWebSocketConnected
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 327 of file ApexAPI.h.

◆ OnWebSocketConnectFailed

FOnApexWebSocketConnectFailed UApexAPI::OnWebSocketConnectFailed
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 333 of file ApexAPI.h.

◆ OnWebSocketDisconnected

FOnApexWebSocketDisconnected UApexAPI::OnWebSocketDisconnected
BlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Apex|Event")

Definition at line 339 of file ApexAPI.h.

◆ Platform

FString UApexAPI::Platform
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 119 of file ApexAPI.h.

◆ ScenarioId

FString UApexAPI::ScenarioId
BlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 101 of file ApexAPI.h.

◆ SessionInProgress

bool UApexAPI::SessionInProgress
protectedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 158 of file ApexAPI.h.

◆ URL

FString UApexAPI::URL
BlueprintReadOnly

The API URL.

See also
URL

UPROPERTY(BlueprintReadOnly)

Definition at line 84 of file ApexAPI.h.

◆ VaRestSubsystem

class UVaRestSubsystem* UApexAPI::VaRestSubsystem
private

Definition at line 278 of file ApexAPI.h.

◆ WebSocketEnabled

bool UApexAPI::WebSocketEnabled
protectedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly)

Definition at line 164 of file ApexAPI.h.

◆ WebSocketURL

FString UApexAPI::WebSocketURL
BlueprintReadOnly

The API Websocket URL.

See also
WebSocketURL

UPROPERTY(BlueprintReadOnly)

Definition at line 95 of file ApexAPI.h.


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