Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AnalyticsET > IAnalyticsProviderET

Light Theme

Dark Theme

IAnalyticsProviderET

ET specific analytics provider instance.

Windows

MacOS

Linux

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

	Name	Description
void	BlockUntilFlushed ( float InTimeoutSec )	Blocks execution in the thread until all events have been flushed to the network.
const FStrin...	GetAppID()	Method to get the AppID (APIKey)
const FStrin...	GetAppVersion()	Method to get the AppVersion
const FAnaly...	GetConfig()	Return the current provider configuration.
FAnalyticsEv...	GetDefaultEventAttribute ( int AttributeIndex )	Used with GetDefaultEventAttributeCount to iterate over the default attributes.
int32	GetDefaultEventAttributeCount()	Used with GetDefaultAttribute to iterate over the default attributes.
TArray< FAna...	GetDefaultEventAttributesSafe()
void	RecordEvent ( FString&& EventName, const TArray< FAnalyticsEventAttrib... )	Primary RecordEvent API. Allow move semantics to capture the attributes.
void	SetAppID ( FString&& AppID )	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	SetDefaultEventAttributes ( TArray< FAnalyticsEventAttribute > ... )	Sets an array of attributes that will automatically be appended to any event that is sent.
void	SetEventCallback ( const OnEventRecorded& Callback )	Set a callback to be invoked any time an event is queued.
void	SetShouldRecordEventFunc ( const ShouldRecordEventFunction& S... )	Set an event filter to dynamically control whether an event should be sent.
void	SetURLEndpoint ( const FString& UrlEndpoint, const TArray< FString >& AltDomain... )	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 ( FString InSessionID, const TArray< FAnalyticsEventAttrib... )	Primary StartSession API. Allow move semantics to capture the attributes.

Overridden from IAnalyticsProvider

		Name	Description
	void	RecordEvent ( const FString& EventName, const TArray< FAnalyticsEventAttrib... )	This class augments RecordEvent with a version that takes the EventName by rvalue reference to save a string copy.
	bool	StartSession ( const TArray< FAnalyticsEventAttrib... )	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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss