UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AnalyticsProviderBroadcast.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
7
25{
26public:
27
29
30 typedef TFunction<void(const FString& EventName, const TArray<FAnalyticsEventAttribute>& Attrs)> OnRecordEvent;
31
32
34
36
37 virtual bool StartSession(const TArray<FAnalyticsEventAttribute>& Attributes = {}) override;
38 virtual void EndSession() override;
39 virtual void FlushEvents() override;
40
41 virtual void SetDefaultEventAttributes(TArray<FAnalyticsEventAttribute>&& Attributes) override;
43 virtual int32 GetDefaultEventAttributeCount() const override;
44 virtual FAnalyticsEventAttribute GetDefaultEventAttribute(int AttributeIndex) const override;
45
46 virtual bool SetSessionID(const FString& InSessionID) override;
47 virtual void SetUserID(const FString& InUserID) override;
48
49 virtual FString GetSessionID() const override;
50 virtual FString GetUserID() const override;
51
52 virtual void RecordEvent(const FString& EventName, const TArray<FAnalyticsEventAttribute>& Attributes) override
53 {
54 RecordEvent(EventName, Attributes, EAnalyticsRecordEventMode::Cached);
55 }
56
57 virtual void RecordEvent(const FString& EventName, const TArray<FAnalyticsEventAttribute>& Attributes, EAnalyticsRecordEventMode Mode) override;
59 bool HasValidProviders() const { return Providers.Num() > 0; }
61
62private:
63
64 TProviders Providers;
65 FString UserID;
66 FString SessionID;
67 TArray<FAnalyticsEventAttribute> DefaultEventAttributes;
68 OnRecordEvent RecordEventCallback;
69};
OODEFFUNC typedef void(OODLE_CALLBACK t_fp_OodleCore_Plugin_Free)(void *ptr)
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
EAnalyticsRecordEventMode
Definition IAnalyticsProvider.h:16
Definition AnalyticsProviderBroadcast.h:25
TMap< FString, TSharedPtr< IAnalyticsProvider > > TProviders
Definition AnalyticsProviderBroadcast.h:28
virtual TArray< FAnalyticsEventAttribute > GetDefaultEventAttributesSafe() const override
Definition AnalyticsProviderBroadcast.cpp:201
virtual void SetDefaultEventAttributes(TArray< FAnalyticsEventAttribute > &&Attributes) override
Definition AnalyticsProviderBroadcast.cpp:191
virtual void RecordEvent(const FString &EventName, const TArray< FAnalyticsEventAttribute > &Attributes) override
Definition AnalyticsProviderBroadcast.h:52
virtual void FlushEvents() override
Definition AnalyticsProviderBroadcast.cpp:240
virtual void SetUserID(const FString &InUserID) override
Definition AnalyticsProviderBroadcast.cpp:176
static TSharedPtr< FAnalyticsProviderBroadcast > CreateAnalyticsProvider()
Definition AnalyticsProviderBroadcast.cpp:22
virtual bool SetSessionID(const FString &InSessionID) override
Definition AnalyticsProviderBroadcast.cpp:157
TWeakPtr< IAnalyticsProvider > GetAnalyticsProvider(const FString &Name)
Definition AnalyticsProviderBroadcast.cpp:27
virtual FString GetSessionID() const override
Definition AnalyticsProviderBroadcast.cpp:171
virtual FString GetUserID() const override
Definition AnalyticsProviderBroadcast.cpp:186
virtual FAnalyticsEventAttribute GetDefaultEventAttribute(int AttributeIndex) const override
Definition AnalyticsProviderBroadcast.cpp:211
FAnalyticsProviderBroadcast()
Definition AnalyticsProviderBroadcast.cpp:33
void SetRecordEventCallback(OnRecordEvent Callback)
Definition AnalyticsProviderBroadcast.cpp:258
TFunction< void(const FString &EventName, const TArray< FAnalyticsEventAttribute > &Attrs)> OnRecordEvent
Definition AnalyticsProviderBroadcast.h:30
virtual void EndSession() override
Definition AnalyticsProviderBroadcast.cpp:227
virtual int32 GetDefaultEventAttributeCount() const override
Definition AnalyticsProviderBroadcast.cpp:206
bool HasValidProviders() const
Definition AnalyticsProviderBroadcast.h:59
Definition IAnalyticsProvider.h:52
bool StartSession()
Definition IAnalyticsProvider.h:65
Definition Array.h:670
Definition AndroidPlatformMisc.h:14
Definition SharedPointer.h:692
Definition SharedPointer.h:1295
Definition AnalyticsEventAttribute.h:48