class MAGES::Analytics::MAGESAnalyticsEntry¶

Overview¶

A class that represents a single analytics entry. More…

class MAGESAnalyticsEntry
{
public:
    // enums

    enum ErrorType;

    // structs

    struct Specification;

    // properties

    Dictionary ActionOccurence;
    Dictionary ErrorsReoccuringState;

    // methods

    MAGESAnalyticsEntry(string actionName, float actionScore);
    void InitializeScore(float score);

    void ProcessError(
        Specification spec,
        Action onError = null,
        bool reoccuring = true,
        bool filtering = true
    );

    void Trigger(
        AnalyticsTypes.BaseType entryData,
        bool reoccuring,
        List> customData
    );

    void ProcessSkip(Action onSkip = null);
};

Detailed Documentation¶

A class that represents a single analytics entry.

Properties¶

Dictionary ActionOccurence

Gets the dictionary that holds the number of times an action has been performed.

Dictionary ErrorsReoccuringState

Gets the dictionary that holds the reoccuring state of the errors.

Methods¶

MAGESAnalyticsEntry(string actionName, float actionScore)

Initializes a new instance of the MAGESAnalyticsEntry class.

Parameters:

actionName	The name of the action to associate this analytics entry with.
actionScore	The score of the action that is associated with this analytics entry.

void InitializeScore(float score)

Initializes the score of the action.

Parameters:

score	The initial score of the action.

void ProcessError(
    Specification spec,
    Action onError = null,
    bool reoccuring = true,
    bool filtering = true
)

Attaches an error to the action.

Parameters:

spec	The specification of the error.
onError	The action to perform when the error occurs.
reoccuring	Whether the error can reoccur multiple times in the same action.
filtering	Whether or not the error will filter data from the data container.

void Trigger(
    AnalyticsTypes.BaseType entryData,
    bool reoccuring,
    List> customData
)

Triggers the error.

Parameters:

entryData	The data associated with the error entry.
reoccuring	Whether the error can reoccur multiple times in the same action.
customData	Additional key value pairs that will be attached to the error event.

void ProcessSkip(Action onSkip = null)

Proccesses the skip action.

Parameters:

onSkip	The action to invoke when an action is skipped.