template class MAGES::Analytics::MAGESAnalyticsObject¶

Overview¶

Base class for all analytics objects. More…

template 
class MAGESAnalyticsObject
{
public:
    // properties

    JProperty SerializedObject;

    // methods

    virtual T SetName(string name);
    virtual T SetTag(string tag);
    virtual string GetTag();
    virtual T SetTarget(object target);
    virtual T SetMessage(string message);
    virtual abstract JProperty Export() = 0;
};

// direct descendants

class Event;
class Query;

Detailed Documentation¶

Base class for all analytics objects.

Parameters:

T	The type of the derived analytics object.

Properties¶

JProperty SerializedObject

Gets or sets the name for the analytics object.

Methods¶

virtual T SetName(string name)

Sets the name for the analytics object.

Parameters:

name	The name of the analytics object.

Returns:

The instance of this analytics object.

virtual T SetTag(string tag)

Sets the tag of the analytics object.

Parameters:

tag	The tag of the analytics objects.

Returns:

The instance of this analytics object.

virtual string GetTag()

Gets the tag of the analytics object.

Returns:

The tag of the analytics object.

virtual T SetTarget(object target)

Sets the target of the analytics object.

Parameters:

target	The target of the analytics object.

Returns:

The instance of this analytics object.

virtual T SetMessage(string message)

Sets the message of the analytics object.

Parameters:

message	The message of the analytics object.

Returns:

The instance of this analytics object.

virtual abstract JProperty Export() = 0

Exports the analytics object.

Returns:

The JObject containg the event data.