1. Epic GamesDeveloper
  3. IAnalyticsProviderET

IAnalyticsProviderET

ET specific analytics provider instance.

API > API/Runtime > API/Runtime/AnalyticsET

Inheritance Hierarchy

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
Public function void

BlockUntilFlushed ( float InTimeoutSec
)

 Blocks execution in the thread until all events have been flushed to the network.
Public function Const const FString & Method to get the AppID (APIKey)
Public function Const const FString & Method to get the AppVersion
Public function Const const FAnalyticsET::Config & Return the current provider configuration.
Public function Const FAnalyticsEventAttribute

GetDefaultEventAttribute ( int AttributeIndex
)

 Used with GetDefaultEventAttributeCount to iterate over the default attributes.
Public function Const int32 Used with GetDefaultAttribute to iterate over the default attributes.
Public function Const TArray< FAnalyticsEventAttribute >  
Public function void

RecordEvent ( FString&& EventName,
const TArray< FAnalyticsEventAttribute >& Attributes
)

 Primary RecordEvent API. Allow move semantics to capture the attributes.
Public function void

SetAppID ( FString&& AppID
)

 Special setter to set the AppID, something that is not normally allowed for third party analytics providers.
Public function void

SetAppVersion ( FString&& AppVersion
)

 Sets the AppVersion.
Public function void Sets an array of attributes that will automatically be appended to any event that is sent.
Public function void

SetEventCallback ( const OnEventRecorded& Callback
)

 Set a callback to be invoked any time an event is queued.
Public function void

SetHeader ( const FString& HeaderName,
const FString& HeaderValue
)

 Sets a header to be included with analytics http requests
Public function void

SetShouldRecordEventFunc ( const ShouldRecordEventFunction& ShouldRecordEventFunc
)

 Set an event filter to dynamically control whether an event should be sent.
Public function void

SetURLEndpoint ( const FString& UrlEndpoint,
const TArray< FString >& AltDomains
)

 Updates the default URL endpoint and AltDomains.
Public function Const 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.
Public function bool

StartSession ( FString InSessionID,
const TArray< FAnalyticsEventAttribute >& Attributes
)

 Primary StartSession API. Allow move semantics to capture the attributes.

Overridden from IAnalyticsProvider

  Type Name Description
Public function Virtual void

RecordEvent ( const FString& EventName,
const TArray< FAnalyticsEventAttribute >& Attributes
)

 This class augments RecordEvent with a version that takes the EventName by rvalue reference to save a string copy.
Public function Virtual 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page