com.mixpanel.android.mpmetrics

Class Tweaks

java.lang.Object

com.mixpanel.android.mpmetrics.Tweaks

public class Tweaks
extends java.lang.Object

In general, you won't need to interact with this class directly - it's used internally to communicate changes in values to the tweaks you define with MixpanelAPI.stringTweak(String, String), MixpanelAPI.booleanTweak(String, boolean), MixpanelAPI.doubleTweak(String, double), MixpanelAPI.longTweak(String, long), and other tweak-related interfaces on MixpanelAPI. Instances of tweaks aren't available to library user code.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Tweaks.OnTweakDeclaredListener This interface is used internally to expose tweaks to the Mixpanel UI, and will likely not be directly useful to code that imports the Mixpanel library.
static class	Tweaks.TweakValue Represents the value and definition of a tweak known to the system.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOLEAN_TYPE An internal description of the type of a tweak.
static int	DOUBLE_TYPE An internal description of the type of a tweak.
static int	LONG_TYPE An internal description of the type of a tweak.
static int	STRING_TYPE An internal description of the type of a tweak.

Method Summary

Modifier and Type	Method and Description
void	addOnTweakDeclaredListener(Tweaks.OnTweakDeclaredListener listener) This method is used internally to expose tweaks to the Mixpanel UI, and will likely not be directly useful to code that imports the Mixpanel library.
java.util.Map<java.lang.String,Tweaks.TweakValue>	getAllValues() Returns the descriptions of all tweaks that currently exist.
void	set(java.lang.String tweakName, java.lang.Object value) Manually set the value of a tweak.

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN_TYPE

public static final int BOOLEAN_TYPE

An internal description of the type of a tweak. These values are used internally to expose tweaks to the Mixpanel UI, and will likely not be directly useful to code that imports the Mixpanel library.

See Also:

Constant Field Values

DOUBLE_TYPE

public static final int DOUBLE_TYPE

An internal description of the type of a tweak. These values are used internally to expose tweaks to the Mixpanel UI, and will likely not be directly useful to code that imports the Mixpanel library.

See Also:

Constant Field Values

LONG_TYPE

public static final int LONG_TYPE

An internal description of the type of a tweak. These values are used internally to expose tweaks to the Mixpanel UI, and will likely not be directly useful to code that imports the Mixpanel library.

See Also:

Constant Field Values

STRING_TYPE

public static final int STRING_TYPE

An internal description of the type of a tweak. These values are used internally to expose tweaks to the Mixpanel UI, and will likely not be directly useful to code that imports the Mixpanel library.

See Also:

Constant Field Values

Method Detail

addOnTweakDeclaredListener

public void addOnTweakDeclaredListener(Tweaks.OnTweakDeclaredListener listener)

This method is used internally to expose tweaks to the Mixpanel UI, and will likely not be directly useful to code that imports the Mixpanel library. The given listener's onTweakDeclared method will be called when a new tweak is declared.

set

public void set(java.lang.String tweakName,
                java.lang.Object value)

Manually set the value of a tweak. Most users of the library will not need to call this directly - instead, the library will call set when new values of the tweak are published.

getAllValues

public java.util.Map<java.lang.String,Tweaks.TweakValue> getAllValues()

Returns the descriptions of all tweaks that currently exist. The Mixpanel library uses this method internally to expose tweaks and their types to the UI. Most users will not need to call this method directly.