IAnalyticsProviderET

ET specific analytics provider instance. Exposes additional APIs to support Json-based events.

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.

Functions

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 FStrin...

 

GetAppID()

Method to get the AppID (APIKey)

Public function Const

const FStrin...

 

GetAppVersion()

Method to get the AppVersion

Public function Const

const TArray...

 

GetDefaultEventAttributes()

Returns the current set of default event attributes set on the provider.

Public function

void

 

RecordEvent

(
    FString EventName,
    TArray< FAnalyticsEventAttribute > ...
)

Optimization for RecordEvent that avoids the array copy using rvalue references.

Public function

void

 

RecordEventJson

(
    FString EventName,
    TArray< FAnalyticsEventAttribute > ...
)

Sends an event where each attribute value is expected to be a string-ified Json value.

Public function

void

 

RecordEventJson

(
    FString EventName,
    const TArray< FAnalyticsEventAttrib...
)

Helper for RecordEventJson when the array is not an rvalue reference.

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

 

SetDefaultEventAttributes

(
    TArray< FAnalyticsEventAttribute > ...
)

When set, all events recorded will have these attributes appended to them.

Public function

void

 

SetEventCallback

(
    const OnEventRecorded& Callback
)

Public function

void

 

SetURLEndpoint

(
    const FString& UrlEndpoint,
    const TArray< FString >& AltDomain...
)

Updates the default URL endpoint and AltDomains.

Public function

bool

 

StartSession

(
    TArray< FAnalyticsEventAttribute > ...
)

Optimization for StartSession that avoids the array copy using rvalue references.

Typedefs

Name

Description

OnEventRecorded

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback