Beamable SDK
Public Member Functions | List of all members
Beamable.Api.Analytics.IAnalyticsTracker Interface Reference

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

Inheritance diagram for Beamable.Api.Analytics.IAnalyticsTracker:
Inheritance graph
[legend]

Public Member Functions

void TrackEvent (IAnalyticsEvent analyticsEvent, bool sendImmediately)
 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

img beamable-logo

Member Function Documentation

◆ RevertBatchSettings()

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

Revert any BatchSettings customizations made through the UpdateBatchSettings method.

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

Implemented in Beamable.Api.Analytics.AnalyticsTracker.

◆ TrackEvent()

void Beamable.Api.Analytics.IAnalyticsTracker.TrackEvent ( IAnalyticsEvent  analyticsEvent,
bool  sendImmediately 
)

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
analyticsEventAn instance of a IAnalyticsEvent. You can create your own types of events. For an example, see, SampleCustomEvent
sendImmediatelyIf set to true send immediately.

Implemented in Beamable.Api.Analytics.AnalyticsTracker.

◆ UpdateBatchSettings()

void Beamable.Api.Analytics.IAnalyticsTracker.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.

Parameters
batchSettingsA new set of BatchSettings. This will override the existing settings.
flushForce that any pending analytic events are sent to Beamable at this moment.

Implemented in Beamable.Api.Analytics.AnalyticsTracker.


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