Beamable.Api.Analytics.AnalyticsTracker Class Reference

This type defines the Client main entry point for the Analytics feature. More...

Inheritance diagram for Beamable.Api.Analytics.AnalyticsTracker:

Collaboration diagram for Beamable.Api.Analytics.AnalyticsTracker:

Public Member Functions
	AnalyticsTracker (IPlatformService platform, PlatformRequester requester, CoroutineService coroutineService, int batchTimeoutSeconds, int batchMaxSize)
	Initialize the specified platformServer, customerId, projectId, batchTimeoutSeconds and batchMaxSize. Analytics Events can be tracked before initialization, but will not be sent until initialization occurs. More...
void	TrackEvent (IAnalyticsEvent analyticsEvent, bool sendImmediately=false)
	Report some analytics event to the Beamable Cloud. Note that this analytic event may not be reported immediately unless the sendImmediately argument is set. Otherwise, the event will be recorded during the next analytics batch event. More...
void	UpdateBatchSettings (BatchSettings batchSettings, bool flush=true)
	Change the BatchSettings that the IAnalyticsTracker uses to send messages to Beamable. You can revert these changes by using the RevertBatchSettings method. More...
void	RevertBatchSettings (bool flush=true)
	Revert any BatchSettings customizations made through the UpdateBatchSettings method. More...

Detailed Description

This type defines the Client main entry point for the Analytics feature.

Related Links

• See the Analytics feature documentation
• See Beamable.API script reference

Constructor & Destructor Documentation

AnalyticsTracker()

Beamable.Api.Analytics.AnalyticsTracker.AnalyticsTracker ( IPlatformService  platform, PlatformRequester  requester, CoroutineService  coroutineService, int  batchTimeoutSeconds, int  batchMaxSize  )

inline

Initialize the specified platformServer, customerId, projectId, batchTimeoutSeconds and batchMaxSize. Analytics Events can be tracked before initialization, but will not be sent until initialization occurs.

Parameters

batchTimeoutSeconds	Batch timeout seconds before expiration.
batchMaxSize	Batch max size before expiration.

Member Function Documentation

RevertBatchSettings()

void Beamable.Api.Analytics.AnalyticsTracker.RevertBatchSettings ( bool  flush = true )

inline

Revert any BatchSettings customizations made through the UpdateBatchSettings method.

Parameters

flush

Force that any pending analytic events are sent to Beamable at this moment.

Implements Beamable.Api.Analytics.IAnalyticsTracker.

TrackEvent()

void Beamable.Api.Analytics.AnalyticsTracker.TrackEvent ( IAnalyticsEvent  analyticsEvent, bool  sendImmediately = false  )

inline

Report some analytics event to the Beamable Cloud. Note that this analytic event may not be reported immediately unless the sendImmediately argument is set. Otherwise, the event will be recorded during the next analytics batch event.

Parameters

analyticsEvent	An instance of a IAnalyticsEvent. You can create your own types of events. For an example, see, SampleCustomEvent
sendImmediately	If set to true send immediately.

Implements Beamable.Api.Analytics.IAnalyticsTracker.

UpdateBatchSettings()

void Beamable.Api.Analytics.AnalyticsTracker.UpdateBatchSettings ( BatchSettings  batchSettings, bool  flush = true  )

inline

Change the BatchSettings that the IAnalyticsTracker uses to send messages to Beamable. You can revert these changes by using the RevertBatchSettings method.

Parameters

batchSettings	A new set of BatchSettings. This will override the existing settings.
flush	Force that any pending analytic events are sent to Beamable at this moment.

Implements Beamable.Api.Analytics.IAnalyticsTracker.

---

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

• com.beamable/Runtime/Core/Platform/SDK/Analytics/AnalyticsTracker.cs