IAnalyticsProviderET.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AnalyticsET.h"
#include "AnalyticsEventAttribute.h"
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "HAL/PlatformMisc.h"
#include "Interfaces/IAnalyticsProvider.h"
#include "Misc/Guid.h"
#include "Templates/Function.h"
#include "Templates/UnrealTemplate.h"
 
class IHttpRequest;
 
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnPreAnalyticsEventProcessed, TSharedRef<IHttpRequest, ESPMode::ThreadSafe>& /*HttpRequest*/);
 
struct FAnalyticEventQueuedInfo
{
    const EAnalyticsRecordEventMode Mode;
    const FString& EventName;
    const TArray<FAnalyticsEventAttribute>& Attributes;
};
 
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnAnalyticsEventQueued, bool& /* bQueueEvent If this boolean is made false by any registered callback, this event will not be queued.  Do not set this value to true */, 
    const FAnalyticEventQueuedInfo& /* All the details on the event that is being queued */)
 
 
class IAnalyticsProviderET : public IAnalyticsProvider
{
public:
    using IAnalyticsProvider::StartSession;
    using IAnalyticsProvider::RecordEvent;
 
    // IAnalyticsProvider overrides
 
    virtual void RecordEvent(const FString& EventName, const TArray<FAnalyticsEventAttribute>& Attributes) override
    {
        return RecordEvent(CopyTemp(EventName), Attributes);
    }
 
    virtual void RecordEvent(const FString& EventName, const TArray<FAnalyticsEventAttribute>& Attributes, EAnalyticsRecordEventMode Mode) override
    {
        return RecordEvent(CopyTemp(EventName), Attributes, Mode);
    }
 
    virtual bool StartSession(const TArray<FAnalyticsEventAttribute>& Attributes) override
    {
        FGuid SessionGUID;
        FPlatformMisc::CreateGuid(SessionGUID);
        return StartSession(SessionGUID.ToString(EGuidFormats::DigitsWithHyphensInBraces), Attributes);
    }
 
    // IAnalyticsProvider overrides
 
 
    virtual void SetAppID(FString&& AppID) = 0;
 
    const FString& GetAppID() const { return GetConfig().APIKeyET; }
 
    virtual void SetAppVersion(FString&& AppVersion) = 0;
 
    const FString& GetAppVersion() const { return GetConfig().AppVersionET; }
 
    virtual bool StartSession(FString InSessionID, const TArray<FAnalyticsEventAttribute>& Attributes) = 0;
 
    virtual bool ShouldRecordEvent(const FString& EventName) const = 0;
 
    virtual void RecordEvent(FString&& EventName, const TArray<FAnalyticsEventAttribute>& Attributes) = 0;
    
    virtual void RecordEvent(FString&& EventName, const TArray<FAnalyticsEventAttribute>& Attributes, EAnalyticsRecordEventMode Mode) = 0;
 
    virtual void SetUrlDomain(const FString& Domain, const TArray<FString>& AltDomains) = 0;
 
    virtual void SetUrlPath(const FString& Path) = 0;
 
    virtual void SetHeader(const FString& HeaderName, const FString& HeaderValue) = 0;
 
    typedef TFunction<void(const FString& EventName, const TArray<FAnalyticsEventAttribute>& Attrs, bool bJson)> OnEventRecorded;
 
    virtual void SetEventCallback(const OnEventRecorded& Callback) = 0;
 
    virtual void BlockUntilFlushed(float InTimeoutSec) = 0;
 
    virtual const FAnalyticsET::Config& GetConfig() const = 0;
 
    typedef TFunction<bool(const IAnalyticsProviderET& ThisProvider, const FString& EventName)> ShouldRecordEventFunction;
 
    virtual void SetShouldRecordEventFunc(const ShouldRecordEventFunction& ShouldRecordEventFunc) = 0;
    
    virtual FOnPreAnalyticsEventProcessed& OnPreAnalyticsEventProcessed() = 0;
    virtual FOnAnalyticsEventQueued& OnAnalyticsEventQueued() = 0;
 
private:
    mutable TArray<FAnalyticsEventAttribute> UnsafeDefaultAttributes;
};