UInterchangeAnalyticsHandlerBase | Unreal Engine 5.8 Documentation

API > API/Runtime > API/Runtime/InterchangeEngine

This is the base class implementation for the Interchange Analytics. This will NOT collect any analytics BY DESIGN. DO NOT MAKE CHANGES TO THE IMPLEMENTATIONS OF THE FUNCTIONS FOR THIS CLASS. See UInterchangeAnalyticsHandlerDefault instead for the default implementation.

Interchange Manager exposes API to set the TSoftClassPtr for a class to use to collect Analytics. By default InterchangeAnalyticsModule registers UInterchangeAnalyticsHandlerDefault as the Analytics Handler Class.


Name	UInterchangeAnalyticsHandlerBase
Type	class
Header File	/Engine/Source/Runtime/Interchange/Engine/Public/InterchangeAnalyticsHandlerBase.h
Include Path	#include "InterchangeAnalyticsHandlerBase.h"

Syntax

UCLASS (BlueprintType, Blueprintable, Abstract, MinimalAPI)  
class UInterchangeAnalyticsHandlerBase : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UInterchangeAnalyticsHandlerBase

Derived Classes

UInterchangeAnalyticsHandlerDefault

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
AnalyticsID	FGuid		InterchangeAnalyticsHandlerBase.h
CriticalSection	FCriticalSection		InterchangeAnalyticsHandlerBase.h

Functions

Public

Name	Remarks	Include Path
void Add ( const FString& Identifier, const FAnalyticsEventAttribute& Entry )	Add the analytics attribute to an event identifier in a thread safe manner.	InterchangeAnalyticsHandlerBase.h
void Append ( const FString& Identifier, const TArray< FAnalyticsEventAttribute >& ToAdd )	Adds an array of attributes to the event identifier in a thread safe manner.	InterchangeAnalyticsHandlerBase.h
void Clear ( const FString& Identifier )	Clears accumulated attributes for an event identifier.	InterchangeAnalyticsHandlerBase.h
void Flush()	Send Accumulated Analytics.	InterchangeAnalyticsHandlerBase.h
void SetGUID ( const FGuid& InGUID )	Can only be set once per instance of the Analytics Handler.	InterchangeAnalyticsHandlerBase.h

Public Virtual

Name	Remarks	Include Path
virtual FAnalyticsEventAttribute GetAnalyticsIDAttribute ()	Creates an Analytics Event Attribute for the current instance of the analytics helper.	InterchangeAnalyticsHandlerBase.h
virtual void Send ( const FInterchangeImportResultAnalyticsInfo& ImportResultAnalyticsInfo )	Send Import Result Analytics.	InterchangeAnalyticsHandlerBase.h
virtual void Send ( const TArray< UInterchangePipelineBase* >& Pipelines, const int32 AsyncHelperUniqueId )	Send Pipelines Analytics.	InterchangeAnalyticsHandlerBase.h

Protected Virtual

Name	Remarks	Include Path	Unreal Specifiers
virtual void Execute_Add ( const FString& Identifier, const FAnalyticsEventAttribute& Entry )		InterchangeAnalyticsHandlerBase.h
virtual void Execute_Append ( const FString& Identifier, const TArray< FAnalyticsEventAttribute >& ToAdd )		InterchangeAnalyticsHandlerBase.h
virtual void Execute_Clear ( const FString& Identifier )		InterchangeAnalyticsHandlerBase.h
virtual void Execute_Flush()		InterchangeAnalyticsHandlerBase.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FAnalyticsEventAttribute CreateAnalyticsIDAttribute ( FGuid AnalyticsID )		InterchangeAnalyticsHandlerBase.h
static FString GetDefaultAnalyticsCategoryName ( EInterchangeAnalyticsDefaultCategory DefaultCategory )		InterchangeAnalyticsHandlerBase.h
static FString GetImportResultEventIdentifier()		InterchangeAnalyticsHandlerBase.h
static FString GetPipelineAnalyticsEventIdentifier()		InterchangeAnalyticsHandlerBase.h

Navigation