mk.gdx.firebase

Class GdxFIRAnalytics

java.lang.Object

mk.gdx.firebase.PlatformDistributor<AnalyticsDistribution>

mk.gdx.firebase.GdxFIRAnalytics

All Implemented Interfaces:

AnalyticsDistribution

public class GdxFIRAnalytics
extends PlatformDistributor<AnalyticsDistribution>
implements AnalyticsDistribution

Gets access to Firebase Analytics API in multi-modules.

See Also:

AnalyticsDistribution, PlatformDistributor

Field Summary

Fields inherited from class mk.gdx.firebase.PlatformDistributor

platformObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GdxFIRAnalytics() GdxFIRAnalytics protected constructor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAndroidClassName() Gives class name of object that will be create when application running on android platform.
protected java.lang.String	getIOSClassName() Gives class name of object that will be create when application running on ios platform.
static GdxFIRAnalytics	instance()
void	logEvent(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> params) Sends analytics event.
void	setScreen(java.lang.String name, java.lang.Class<?> screenClass) Sends information about current screen.
void	setUserId(java.lang.String id) Sends user id.
void	setUserProperty(java.lang.String name, java.lang.String value) Sends user property.

Methods inherited from class mk.gdx.firebase.PlatformDistributor

setMockObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GdxFIRAnalytics

protected GdxFIRAnalytics()
                   throws PlatformDistributorException

GdxFIRAnalytics protected constructor.

Instance of this class should be getting by instance()

PlatformDistributor.PlatformDistributor()

Throws:

PlatformDistributorException

Method Detail

instance

public static GdxFIRAnalytics instance()

Returns:

Thread-safe singleton instance of this class.

logEvent

public void logEvent(java.lang.String name,
                     java.util.Map<java.lang.String,java.lang.String> params)

Sends analytics event.

Specified by:

logEvent in interface AnalyticsDistribution

Parameters:

name - Event name, default events are defined here AnalyticsEvent

params - Event params, default params are defined here AnalyticsParam

setScreen

public void setScreen(java.lang.String name,
                      java.lang.Class<?> screenClass)

Sends information about current screen.

Specified by:

setScreen in interface AnalyticsDistribution

Parameters:

name - Screen name, can be any String name you want

screenClass - Screen class, here you can give your scene/screen/state class. For ex. MenuScreen.class

setUserProperty

public void setUserProperty(java.lang.String name,
                            java.lang.String value)

Sends user property.

Specified by:

setUserProperty in interface AnalyticsDistribution

Parameters:

name - Property name, you can read more about it here

value - Property value

setUserId

public void setUserId(java.lang.String id)

Sends user id.

Specified by:

setUserId in interface AnalyticsDistribution

Parameters:

id - Current user id

getIOSClassName

protected java.lang.String getIOSClassName()

Gives class name of object that will be create when application running on ios platform.

Specified by:

getIOSClassName in class PlatformDistributor<AnalyticsDistribution>

Returns:

Class name with package of the ios-moe module distribution object.

getAndroidClassName

protected java.lang.String getAndroidClassName()

Gives class name of object that will be create when application running on android platform.

Specified by:

getAndroidClassName in class PlatformDistributor<AnalyticsDistribution>

Returns:

Class name with package of the android module distribution object.