IDarkMatter Interface Reference

The Core DarkMatter class interface. More...

Inherited by DarkMatter.

Public Member Functions
boolean	isDebugBuild ()
	Determines whether or not this is a debug build, as specified during construction.
List< String >	getSDKVersions ()
	Stores a list of all sdk versions that have been registered. More...
IAnalyticsTracker	getAnalytics ()
	The shared instance of an analytics tracker that can be used for sending analytics events.
Activity	getActivity ()
	The main activity passed to DarkMatter in its initialization.
String	getMagmicID ()
	Deprecated - The old mID used mostly by analytics.
String	getUserID ()
	The user id for the currently logged in user.
String	getDeviceID ()
	A UUID that identifies the device.
String	getGameVersion ()
	The current game version, either manually set when DarkMatter is initialize, or automatically pulled from NativeUtilities#getGameVersion().
String	getGameToken ()
	The game token used for requesting the manifest.
boolean	getSendAnalytics ()
	A boolean value determining if analytics should be sent.
void	addSDKVersion (String sdkver)
	Registers a version of a subsystem of the SDK. More...
void	logDarkMatterError (String errorKey, DarkMatterError error)
	Convenience method for sending an analytics event for the given DarkMatterError. More...
void	logDarkMatterError (String eventName, String value, String... customParameters)
	Convenience method for sending an analytics event for the given name, key, and parameters. More...

Detailed Description

The Core DarkMatter class interface.

stores ids and keys for the app.

Member Function Documentation

addSDKVersion()

void addSDKVersion

(

String

sdkver

)

Registers a version of a subsystem of the SDK.

These will be sent to the server with any request for a manifest and are used mainly for debugging.

getSDKVersions()

List<String> getSDKVersions

(

)

Stores a list of all sdk versions that have been registered.

The version strings should be in the form of:: (e.g.StoreFront::1.0.0.0).

logDarkMatterError() [1/2]

void logDarkMatterError	(	String	errorKey,
		DarkMatterError	error
	)

Convenience method for sending an analytics event for the given DarkMatterError.

The event name will be "_dmError".

Parameters

errorKey	The string representation of the error enum value.
error	The DarkMatterError object. If the error object contains a message it will be sent as a parameter with the event.

logDarkMatterError() [2/2]

void logDarkMatterError	(	String	eventName,
		String	value,
		String...	customParameters
	)

Convenience method for sending an analytics event for the given name, key, and parameters.

Parameters

eventName	The name of the event.
value	The string representation of the error enum value.
customParameters	Custom parameters to be sent with the event.