FAnalyticsET::Config Struct Reference

#include <AnalyticsET.h>

Public Member Functions
	Config ()=default
	Config (FString InAPIKeyET, FString InAPIServerET, FString InAppVersionET=FString(), bool InUseLegacyProtocol=false, FString InAppEnvironment=FString(), FString InUploadType=FString(), TArray< FString > InAltApiServers=TArray< FString >(), float InFlushIntervalSec=-1.f, int32 InMaximumPayloadSize=-1, int32 InPreallocatedPayloadSize=-1)

Static Public Member Functions
static FString	GetKeyNameForAPIKey ()
static FString	GetKeyNameForAPIServer ()
static FString	GetKeyNameForAPIEndpoint ()
static FString	GetKeyNameForAPIUnixSocketPath ()
static FString	GetKeyNameForAppVersion ()
static FString	GetKeyNameForUseLegacyProtocol ()
static FString	GetKeyNameForAppEnvironment ()
static FString	GetKeyNameForUploadType ()
static FString	GetDefaultAppEnvironment ()
static FString	GetDefaultUploadType ()
static FString	GetDefaultAPIEndpoint ()

Public Attributes
FString	APIKeyET
FString	APIServerET
FString	APIEndpointET
FString	APIUnixSocketPathET
TArray< FString >	AltAPIServersET
FString	AppVersionET
bool	UseLegacyProtocol = false
bool	bDropEventsOnFlushFailure = true
FString	AppEnvironment
FString	UploadType
uint32	RetryLimitCount = 0
float	FlushIntervalSec = -1.f
int32	MaximumPayloadSize = -1
int32	PreallocatedPayloadSize = -1

Detailed Description

Defines required configuration values for ET analytics provider. APIKeyET MUST be set. Set APIServerET to an empty string to create a "NULL" analytics provider that will be a valid instance but will suppress sending any events.

Constructor & Destructor Documentation

Config() [1/2]

FAnalyticsET::Config::Config ( )

default

Default ctor to ensure all values have their proper default.

Config() [2/2]

FAnalyticsET::Config::Config ( FString  InAPIKeyET, FString  InAPIServerET, FString  InAppVersionET = FString(), bool  InUseLegacyProtocol = false, FString  InAppEnvironment = FString(), FString  InUploadType = FString(), TArray< FString >  InAltApiServers = TArray<FString>(), float  InFlushIntervalSec = -1.f, int32  InMaximumPayloadSize = -1, int32  InPreallocatedPayloadSize = -1  )

inline

Ctor exposing common configurables .

Member Function Documentation

GetDefaultAPIEndpoint()

static FString FAnalyticsET::Config::GetDefaultAPIEndpoint ( )

inlinestatic

Default value if no APIEndpoint is given.

GetDefaultAppEnvironment()

static FString FAnalyticsET::Config::GetDefaultAppEnvironment ( )

inlinestatic

Default value if no APIServer configuration is provided.

GetDefaultUploadType()

static FString FAnalyticsET::Config::GetDefaultUploadType ( )

inlinestatic

Default value if no UploadType is given, and UseDataRouter protocol is specified.

GetKeyNameForAPIEndpoint()

static FString FAnalyticsET::Config::GetKeyNameForAPIEndpoint ( )

inlinestatic

KeyName required for APIEndpoint configuration.

GetKeyNameForAPIKey()

static FString FAnalyticsET::Config::GetKeyNameForAPIKey ( )

inlinestatic

KeyName required for APIKey configuration.

GetKeyNameForAPIServer()

static FString FAnalyticsET::Config::GetKeyNameForAPIServer ( )

inlinestatic

KeyName required for APIServer configuration.

GetKeyNameForAPIUnixSocketPath()

static FString FAnalyticsET::Config::GetKeyNameForAPIUnixSocketPath ( )

inlinestatic

KeyName required for APIEndpoint configuration.

GetKeyNameForAppEnvironment()

static FString FAnalyticsET::Config::GetKeyNameForAppEnvironment ( )

inlinestatic

For the the data router backend protocol.

GetKeyNameForAppVersion()

static FString FAnalyticsET::Config::GetKeyNameForAppVersion ( )

inlinestatic

KeyName required for AppVersion configuration.

GetKeyNameForUploadType()

static FString FAnalyticsET::Config::GetKeyNameForUploadType ( )

inlinestatic

For the the data router backend protocol.

GetKeyNameForUseLegacyProtocol()

static FString FAnalyticsET::Config::GetKeyNameForUseLegacyProtocol ( )

inlinestatic

Optional parameter to use the legacy backend protocol.

Member Data Documentation

AltAPIServersET

TArray<FString> FAnalyticsET::Config::AltAPIServersET

ET Alt API Servers - Base URLs to send events on retry.

APIEndpointET

FString FAnalyticsET::Config::APIEndpointET

ET API Endpoint - This is the API endpoint for the provider.

APIKeyET

FString FAnalyticsET::Config::APIKeyET

ET APIKey - Get from your account manager

APIServerET

FString FAnalyticsET::Config::APIServerET

ET API Server - Base URL to send events. Set this to an empty string to essentially create a NULL analytics provider that will be non-null, but won't actually send events.

APIUnixSocketPathET

FString FAnalyticsET::Config::APIUnixSocketPathET

ET API UnixSocketPath - This is the UnixSocketPath to use as the target for the API endpoint for the provider.

AppEnvironment

FString FAnalyticsET::Config::AppEnvironment

The AppEnvironment that the data router should use. Defaults to GetDefaultAppEnvironment.

AppVersionET

FString FAnalyticsET::Config::AppVersionET

AppVersion - defines the app version passed to the provider. By default this will be FEngineVersion::Current(), but you can supply your own. As a convenience, you can use -AnalyticsAppVersion=XXX to force the AppVersion to a specific value. Useful for playtest etc where you want to define a specific version string dynamically. If you supply your own Version string, occurrences of "%VERSION%" are replaced with FEngineVersion::Current(). ie, -AnalyticsAppVersion=MyCustomID-VERSION%.

bDropEventsOnFlushFailure

bool FAnalyticsET::Config::bDropEventsOnFlushFailure = true

When true (default), events are dropped if flush fails

FlushIntervalSec

float FAnalyticsET::Config::FlushIntervalSec = -1.f

Maximum time to elapse before forcing events to be flushed. Use a negative value to use the defaults (60 sec).

MaximumPayloadSize

int32 FAnalyticsET::Config::MaximumPayloadSize = -1

Maximum size a payload can reach before we force a flush of the payload. Use a negative value to use the defaults. See FAnalyticsProviderETEventCache.

PreallocatedPayloadSize

int32 FAnalyticsET::Config::PreallocatedPayloadSize = -1

We preallocate a payload. It defaults to the Maximum configured payload size (see FAnalyticsProviderETEventCache). Use a negative value use the default. See FAnalyticsProviderETEventCache.

RetryLimitCount

uint32 FAnalyticsET::Config::RetryLimitCount = 0

Maximum number of retries to attempt.

UploadType

FString FAnalyticsET::Config::UploadType

The UploadType that the data router should use. Defaults to GetDefaultUploadType.

UseLegacyProtocol

bool FAnalyticsET::Config::UseLegacyProtocol = false

When true, sends events using the legacy ET protocol that passes all attributes as URL parameters. Defaults to false.

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/Analytics/AnalyticsET/Public/AnalyticsET.h