MxAnalyticsInterface Class Reference

#include <mxanalytics.h>

Detailed Description

Provides functionality for metrics.

Static Public Member Functions
static MAXON_METHOD Bool	IsMxAnalyticsInitialized ()
static MAXON_METHOD Result< void >	MxAnalyticsSendEvent (const String &identifier, const String &key, const String &value, Bool omitEmpty=false)
static MAXON_METHOD Result< void >	MxAnalyticsSendEvent (const String &identifier, const DataDictionary &keyValuePairs, Bool omitEmpty=false)
static MAXON_METHOD Result< void >	MxAnalyticsSendAppUsedEvent (const String &name)
static MAXON_METHOD Result< void >	MxAnalyticsSendPluginUsedEvent (const String &name, const String &host="Cinema 4D"_s)
static MAXON_METHOD Result< void >	MxAnalyticsSendPresetUsedEvent (const String &name)
static MAXON_METHOD Result< void >	MxAnalyticsSendToolUsedEvent (const String &name)
static MAXON_METHOD Result< void >	MxAnalyticsSendFeatureUsedEvent (const String &name)
static MAXON_METHOD Result< void >	MxAnalyticsSendFrameIncrementEvent (const Int32 &batchSize)
static MAXON_METHOD Result< void >	MxAnalyticsSendFrameSubmitEvent (const String &name)
static MAXON_METHOD void	MxAnalyticsSetCinewareUsage (maxon::CINEWAREUSAGETYPE usage)
static MAXON_METHOD void	MxAnalyticsInit (const String &mainProductId, const String &selectedProductId, const String &licenseId, Bool isBetaAccount, Bool isProduction, const String &userId, Bool optedIn, Bool trialOptedIn, const String &language)
static MAXON_METHOD void	MxAnalyticsEndCineware ()
static MAXON_METHOD void	MxAnalyticsEnd ()

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (MxAnalyticsInterface, MAXON_REFERENCE_STATIC, "net.maxon.interface.mxanalytics")

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( MxAnalyticsInterface  , MAXON_REFERENCE_STATIC  , "net.maxon.interface.mxanalytics"    )

private

IsMxAnalyticsInitialized()

static MAXON_METHOD Bool IsMxAnalyticsInitialized ( )

static

Checks whether the MxAnalytics system has been initialized or not.

Returns

@trueIfOtherwiseFalse(MxAnalytics system has been initialized).

MxAnalyticsSendEvent() [1/2]

static MAXON_METHOD Result<void> MxAnalyticsSendEvent ( const String &  identifier, const String &  key, const String &  value, Bool  omitEmpty = false  )

static

Sends / stores an MxAnalytics event.

Parameters

[in]	identifier	Identifier - must not be empty!
[in]	key	Key - must not be empty!
[in]	value	Value.
[in]	omitEmpty	Omit key with empty value.

Returns

OK on success.

MxAnalyticsSendEvent() [2/2]

static MAXON_METHOD Result<void> MxAnalyticsSendEvent ( const String &  identifier, const DataDictionary &  keyValuePairs, Bool  omitEmpty = false  )

static

Sends / stores an MxAnalytics event.

Parameters

[in]	identifier	Identifier - must not be empty!.
[in]	keyValuePairs	Datadictionary of key + value string pairs - keys must not be empty!
[in]	omitEmpty	Omit keys with empty values.

Returns

OK on success.

MxAnalyticsSendAppUsedEvent()

static MAXON_METHOD Result<void> MxAnalyticsSendAppUsedEvent ( const String &  name )

static

Sends / stores an MxAnalytics event if an app was launched.

Parameters

[in]

name

Name of the app.

Returns

OK on success.

MxAnalyticsSendPluginUsedEvent()

static MAXON_METHOD Result<void> MxAnalyticsSendPluginUsedEvent ( const String &  name, const String &  host = "Cinema 4D"_s  )

static

Sends / stores an MxAnalytics event if a plugin was used.

Parameters

[in]	name	Name of the plugin.
[in]	host	Name of the plugin host.

Returns

OK on success.

MxAnalyticsSendPresetUsedEvent()

static MAXON_METHOD Result<void> MxAnalyticsSendPresetUsedEvent ( const String &  name )

static

Sends / stores an MxAnalytics event if a preset was used.

Parameters

[in]

name

Name of the preset.

Returns

OK on success.

MxAnalyticsSendToolUsedEvent()

static MAXON_METHOD Result<void> MxAnalyticsSendToolUsedEvent ( const String &  name )

static

Sends / stores an MxAnalytics event if a tool was used.

Parameters

[in]

name

Name of the tool.

Returns

OK on success.

MxAnalyticsSendFeatureUsedEvent()

static MAXON_METHOD Result<void> MxAnalyticsSendFeatureUsedEvent ( const String &  name )

static

Sends / stores an MxAnalytics event if a feature was used.

Parameters

[in]

name

Name of the feature.

Returns

OK on success.

MxAnalyticsSendFrameIncrementEvent()

static MAXON_METHOD Result<void> MxAnalyticsSendFrameIncrementEvent ( const Int32 &  batchSize )

static

Sends / stores an MxAnalytics event if a frame was rendered.

Parameters

[in]

batchSize

Batch size.

Returns

OK on success.

MxAnalyticsSendFrameSubmitEvent()

static MAXON_METHOD Result<void> MxAnalyticsSendFrameSubmitEvent ( const String &  name )

static

Sends / stores an MxAnalytics event if a rendering was finished.

Parameters

[in]

name

Name of the event.

Returns

OK on success.

MxAnalyticsSetCinewareUsage()

static MAXON_METHOD void MxAnalyticsSetCinewareUsage ( maxon::CINEWAREUSAGETYPE  usage )

static

Marks the session as active usage of Cineware.

MxAnalyticsInit()

static MAXON_METHOD void MxAnalyticsInit ( const String &  mainProductId, const String &  selectedProductId, const String &  licenseId, Bool  isBetaAccount, Bool  isProduction, const String &  userId, Bool  optedIn, Bool  trialOptedIn, const String &  language  )

static

Private.

MxAnalyticsEndCineware()

static MAXON_METHOD void MxAnalyticsEndCineware ( )

static

Private.

MxAnalyticsEnd()

static MAXON_METHOD void MxAnalyticsEnd ( )

static

Private.