Open 3D Engine AWSCore Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AWSCore::AttributionMetric Class Reference

Defines the operational metric sent periodically. More...

#include <AWSCoreAttributionMetric.h>

Public Member Functions

 AttributionMetric (const AZStd::string &timestamp)
 
void SetO3DEVersion (const AZStd::string &version)
 
const AZStd::string & GetPlatform () const
 
void SetPlatform (const AZStd::string &platform, const AZStd::string &platformVersion)
 
void AddActiveGem (const AZStd::string &gemName)
 
AZStd::string SerializeToJson ()
 
bool SerializeToJson (AWSCore::JsonWriter &writer) const
 
bool ReadFromJson (rapidjson::Value &metricsObjVal)
 

Static Public Member Functions

static AZStd::string GenerateTimeStamp ()
 Generates a UTC 8601 formatted timestamp.
 

Detailed Description

Defines the operational metric sent periodically.

Member Function Documentation

◆ ReadFromJson()

bool AWSCore::AttributionMetric::ReadFromJson ( rapidjson::Value &  metricsObjVal)

Read from a JSON value to the metrics event.

Parameters
metricsObjValJSON value to read from.
Returns
Whether the metrics event is created successfully.

◆ SerializeToJson() [1/2]

AZStd::string AWSCore::AttributionMetric::SerializeToJson ( )

Serialize the metrics object queue to a string.

Returns
Serialized string.

◆ SerializeToJson() [2/2]

bool AWSCore::AttributionMetric::SerializeToJson ( AWSCore::JsonWriter writer) const

Serialize the metrics object to JSON for the sending requests.

Parameters
writerJSON writer for the serialization.
Returns
Whether the metrics event is serialized successfully.

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