template class MAGES::Analytics::ICustomBaseTypeDefinition¶

Overview¶

The base class for custom types runtime definitions. More…

template 
class ICustomBaseTypeDefinition
{
public:
    // properties

    TEntryType Entry;

    // methods

    virtual void Definition(
        string actionName,
        TCustomType customType,
        Dictionary registeredEntries,
        TEntryType registeredEntry,
        MAGESAnalyticsRuntime.Type type,
        List excludedActions
    );

    void Clean();
};

// direct descendants

class CustomErrorTypeDefinition;
class CustomEventTypeDefinition;
class CustomObjectiveTypeDefinition;

Detailed Documentation¶

The base class for custom types runtime definitions.

Parameters:

TEntryType	The type of the analytics type.
TCustomType	The type of the custom type.

Properties¶

TEntryType Entry

Gets or sets the registered entries.

Methods¶

virtual void Definition(
    string actionName,
    TCustomType customType,
    Dictionary registeredEntries,
    TEntryType registeredEntry,
    MAGESAnalyticsRuntime.Type type,
    List excludedActions
)

Defines what that the analytics runtime does.

Parameters:

actionName	The name of the action.
customType	The custom type.
registeredEntries	The dictionary holding all the registered analytics types.
registeredEntry	The analytics type entry.
type	The type of the custom type.
excludedActions	The list of excluded actions.

void Clean()

Cleans up the custom type.