1. Epic GamesDeveloper
  3. IAnalyticsPropertyStore

IAnalyticsPropertyStore

Implements a fast type safe key/value database to store analytics properties collected during a session.

API > API/Runtime > API/Runtime/Analytics > API/Runtime/Analytics/Interfaces

Inheritance Hierarchy

References

   
Module Analytics
Header /Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Include #include "Interfaces/IAnalyticsPropertyStore.h"

Syntax

class IAnalyticsPropertyStore

Remarks

Implements a fast type safe key/value database to store analytics properties collected during a session.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool

Contains ( const FString& Key
)

 Returns true if the store contains the specified key.
Public function bool

Flush ( bool bAsync,
const FTimespan& Timeout
)

 Flushes cached values to persistent storage.
Public function Const EStatusCode

Get ( const FString& Key,
FDateTime& OutValue
)

  
Public function Const EStatusCode

Get ( const FString& Key,
FString& OutValue
)

  
Public function Const EStatusCode

Get ( const FString& Key,
bool& OutValue
)

  
Public function Const EStatusCode

Get ( const FString& Key,
double& OutValue
)

  
Public function Const EStatusCode

Get ( const FString& Key,
uint64& OutValue
)

  
Public function Const EStatusCode

Get ( const FString& Key,
int64& OutValue
)

  
Public function Const EStatusCode

Get ( const FString& Key,
float& OutValue
)

  
Public function Const EStatusCode

Get ( const FString& Key,
int32& OutValue
)

 Reads the specified key value from the store.
Public function Const EStatusCode

Get ( const FString& Key,
uint32& OutValue
)

  
Public function Const uint32

Num ()

 Returns the number of elements in the store.
Public function bool

Remove ( const FString& Key
)

 Removes the specified key from the store.
Public function void Removes all existing keys from the store.
Public function EStatusCode

Set ( const FString& Key,
uint32 Value,
const TFunction< bool(const uint32*, const uint32&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
const FDateTime& Value,
const TFunction< bool(const FDateTime*, const FDateTime&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
const FString& Value,
const TFunction< bool(const FString*, const FString&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
bool Value,
const TFunction< bool(const bool*, const bool&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
double Value,
const TFunction< bool(const double*, const double&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
float Value,
const TFunction< bool(const float*, const float&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
uint64 Value,
const TFunction< bool(const uint64*, const uint64&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
int64 Value,
const TFunction< bool(const int64*, const int64&)>& ConditionFn
)

  
Public function EStatusCode

Set ( const FString& Key,
int32 Value,
const TFunction< bool(const int32*, const int32&)>& ConditionFn
)

 Conditionnnaly adds or updates the specified key/value pair.
Public function EStatusCode

Set ( const FString& Key,
double Value
)

  
Public function EStatusCode

Set ( const FString& Key,
const FDateTime& Value
)

  
Public function EStatusCode

Set ( const FString& Key,
bool Value
)

  
Public function EStatusCode

Set ( const FString& Key,
float Value
)

  
Public function EStatusCode

Set ( const FString& Key,
uint64 Value
)

  
Public function EStatusCode

Set ( const FString& Key,
int64 Value
)

  
Public function EStatusCode

Set ( const FString& Key,
uint32 Value
)

  
Public function EStatusCode

Set ( const FString& Key,
int32 Value
)

 Adds or updates the specified key/value pair.
Public function EStatusCode

Set ( const FString& Key,
const FString& Value,
uint32 CharCountCapacityHint
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(bool&)>& UpdateFn
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(double&)>& UpdateFn
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(float&)>& UpdateFn
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(uint64&)>& UpdateFn
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(FDateTime&)>& UpdateFn
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(uint32&)>& UpdateFn
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(int32&)>& UpdateFn
)

 Updates an exiting value.
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(FString&)>& UpdateFn
)

  
Public function EStatusCode

Update ( const FString& Key,
const TFunction< bool(int64&)>& UpdateFn
)

  
Public function Const void

VisitAll ( const TFunction< void(FAnalyticsEventAttribute&&)>& VisitFn
)

 Iterates the keys currently stored and invokes the visitor function for each key, converting the value to its string representation.

Enums

  Type Name Description
Public enum EStatusCode The list of store operation outcome.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page