Navigation
Unreal Engine C++ API Reference > Runtime > AnalyticsET
Inheritance Hierarchy
- IAnalyticsProvider
- IAnalyticsProviderET
References
Module | AnalyticsET |
Header | /Engine/Source/Runtime/Analytics/AnalyticsET/Public/IAnalyticsProviderET.h |
Include | #include "IAnalyticsProviderET.h" |
Syntax
class IAnalyticsProviderET : public IAnalyticsProvider
Remarks
ET specific analytics provider instance. Exposes additional APIs to support Json-based events, default attributes, and allowing events to be disabled (generally via hotfixing).
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | BlockUntilFlushed
(
float InTimeoutSec |
Blocks execution in the thread until all events have been flushed to the network. |
![]() ![]() |
const FString & | GetAppID () |
Method to get the AppID (APIKey) |
![]() ![]() |
const FString & | Method to get the AppVersion | |
![]() ![]() |
const FAnalyticsET::Config & | GetConfig () |
Return the current provider configuration. |
![]() |
void | RecordEvent
(
const FString& EventName, |
|
![]() |
void | RecordEvent
(
const FString& EventName |
|
![]() |
void | RecordEvent
(
FString&& EventName, |
Primary RecordEvent API. Allow move semantics to capture the attributes. |
![]() |
void | RecordEvent
(
const FString& EventName, |
|
![]() |
void | Special setter to set the AppID, something that is not normally allowed for third party analytics providers. | |
![]() |
void | SetAppVersion
(
FString&& AppVersion |
Sets the AppVersion. |
![]() |
void | SetEventCallback
(
const OnEventRecorded& Callback |
Set a callback to be invoked any time an event is queued. |
![]() |
void | Sets a header to be included with analytics http requests | |
![]() |
void | SetShouldRecordEventFunc
(
const ShouldRecordEventFunction& ShouldRecordEventFunc |
Set an event filter to dynamically control whether an event should be sent. |
![]() |
void | SetURLEndpoint
(
const FString& UrlEndpoint, |
Updates the default URL endpoint and AltDomains. |
![]() ![]() |
bool | ShouldRecordEvent
(
const FString& EventName |
Allows higher level code to abort logic to set up for a RecordEvent call by checking the filter that will be used to send the event first. |
![]() |
bool | StartSession () |
|
![]() |
bool | StartSession
(
const FAnalyticsEventAttribute& Attribute |
|
![]() |
bool | StartSession
(
FString InSessionID, |
Primary StartSession API. Allow move semantics to capture the attributes. |
![]() |
bool | StartSession
(
const FString& ParamName, |
Overridden from IAnalyticsProvider
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | RecordEvent
(
const FString& EventName, |
This class augments RecordEvent with a version that takes the EventName by rvalue reference to save a string copy. |
![]() ![]() |
bool | StartSession
(
const TArray< FAnalyticsEventAttribute >& Attributes |
This class augments StartSession with a version that takes the SessionID instead of always generating it. |
Typedefs
Name | Description |
---|---|
OnEventRecorded | |
ShouldRecordEventFunction | Callback used before any event is actually sent. Allows higher level code to disable events. |