FAnalyticsSessionSummarySender Class Reference

#include <AnalyticsSessionSummarySender.h>

Inheritance diagram for FAnalyticsSessionSummarySender:

Public Member Functions
ANALYTICSET_API	FAnalyticsSessionSummarySender (IAnalyticsProviderET &Provider, TFunction< bool(const FAnalyticsEventAttribute &)> ShouldEmitFilterFunc=TFunction< bool(const FAnalyticsEventAttribute &)>())
virtual ANALYTICSET_API bool	SendSessionSummary (const FString &UserId, const FString &AppId, const FString &AppVersion, const FString &SessionId, const TArray< FAnalyticsEventAttribute > &Properties) override
Public Member Functions inherited from IAnalyticsSessionSummarySender
virtual	~IAnalyticsSessionSummarySender ()=default

Detailed Description

Sends the analytics session summary to Epic Games analytics service.

Constructor & Destructor Documentation

FAnalyticsSessionSummarySender()

FAnalyticsSessionSummarySender::FAnalyticsSessionSummarySender	(	IAnalyticsProviderET &	Provider,
		TFunction< bool(const FAnalyticsEventAttribute &)>	ShouldEmitFilterFunc = TFunction<bool(const FAnalyticsEventAttribute&)>()
	)

Construction a summary sender.

Parameters

Provider	The analytics provider that will be used to emits the summary event.
ShouldEmitFilterFunc	A filter function invoked for each properties before sending. If the function is bound and returns false, the property will be filtered out. If unbound, all properties passed to SendSesionSummary() are emitted.

Member Function Documentation

SendSessionSummary()

bool FAnalyticsSessionSummarySender::SendSessionSummary ( const FString &  UserId, const FString &  AppId, const FString &  AppVersion, const FString &  SessionId, const TArray< FAnalyticsEventAttribute > &  Properties  )

overridevirtual

Emits the summary events for the specified session id on behalf of the specified user/app/appversion. The function filters the properties by invoking the functor specified at construction.

Parameters

UserId	The user emitting the report.
AppId	The application for which the reports is emitted.
AppVersion	The application version for which the report is emitted.
SessionId	The session is for which the report is emitted.
Properties	The list of properties that makes up the summary event.

Implements IAnalyticsSessionSummarySender.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Analytics/AnalyticsET/Public/AnalyticsSessionSummarySender.h
• Engine/Source/Runtime/Analytics/AnalyticsET/Private/AnalyticsSessionSummarySender.cpp