Navigation
API > API/Runtime > API/Runtime/AnalyticsET
ET specific analytics provider instance. Exposes additional APIs to support Json-based events, default attributes, and allowing events to be disabled (generally via hotfixing).
| Name | IAnalyticsProviderET |
| Type | class |
| Header File | /Engine/Source/Runtime/Analytics/AnalyticsET/Public/IAnalyticsProviderET.h |
| Include Path | #include "IAnalyticsProviderET.h" |
Syntax
class IAnalyticsProviderET : public IAnalyticsProvider
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| OnEventRecorded | TFunction< void(const FString &EventName, const TArray< FAnalyticsEventAttribute > &Attrs, bool bJson)> | IAnalyticsProviderET.h | |
| ShouldRecordEventFunction | TFunction< bool(const IAnalyticsProviderET &ThisProvider, const FString &EventName)> | Callback used before any event is actually sent. Allows higher level code to disable events. | IAnalyticsProviderET.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| UnsafeDefaultAttributes | TArray< FAnalyticsEventAttribute > | Needed to support the old, unsafe GetDefaultAttributes() API. | IAnalyticsProviderET.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BlockUntilFlushed
(
float InTimeoutSec |
Blocks execution in the thread until all events have been flushed to the network. | IAnalyticsProviderET.h | |
const FString & GetAppID() |
Method to get the AppID (APIKey) | IAnalyticsProviderET.h | |
const FString & GetAppVersion() |
Method to get the AppVersion | IAnalyticsProviderET.h | |
const FAnalyticsET::Config & GetConfig() |
Return the current provider configuration. | IAnalyticsProviderET.h | |
FOnAnalyticsEventQueued & OnAnalyticsEventQueued() |
IAnalyticsProviderET.h | ||
FOnPreAnalyticsEventProcessed & OnPreAnalyticsEventProcessed() |
IAnalyticsProviderET.h | ||
void RecordEvent
(
FString&& EventName, |
Overload to allow platforms to implement events that are immediately sent when supported. | IAnalyticsProviderET.h | |
virtual void RecordEvent
(
const FString& EventName, |
This class augments RecordEvent with a version that takes the EventName by rvalue reference to save a string copy. | IAnalyticsProviderET.h | |
void RecordEvent
(
FString&& EventName, |
Primary RecordEvent API. Allow move semantics to capture the attributes. | IAnalyticsProviderET.h | |
virtual void RecordEvent
(
const FString& EventName, |
This class augments RecordEvent with a version that takes the EventName by rvalue reference to save a string copy. | IAnalyticsProviderET.h | |
void SetAppID
(
FString&& AppID |
Special setter to set the AppID, something that is not normally allowed for third party analytics providers. | IAnalyticsProviderET.h | |
void SetAppVersion
(
FString&& AppVersion |
Sets the AppVersion. | IAnalyticsProviderET.h | |
void SetEventCallback
(
const OnEventRecorded& Callback |
Set a callback to be invoked any time an event is queued. | IAnalyticsProviderET.h | |
| Sets a header to be included with analytics http requests | IAnalyticsProviderET.h | ||
void SetShouldRecordEventFunc
(
const ShouldRecordEventFunction& ShouldRecordEventFunc |
Set an event filter to dynamically control whether an event should be sent. | IAnalyticsProviderET.h | |
| Updates the default Domain and AltDomains. | IAnalyticsProviderET.h | ||
void SetUrlPath
(
const FString& Path |
Updates the Path | IAnalyticsProviderET.h | |
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. | IAnalyticsProviderET.h | |
virtual bool StartSession
(
const TArray< FAnalyticsEventAttribute >& Attributes |
This class augments StartSession with a version that takes the SessionID instead of always generating it. | IAnalyticsProviderET.h | |
bool StartSession
(
FString InSessionID, |
Primary StartSession API. Allow move semantics to capture the attributes. | IAnalyticsProviderET.h |