com.apptimize

Class Apptimize

java.lang.Object

com.apptimize.Apptimize

public class Apptimize
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Apptimize.OnExperimentRunListener Interface definition for a callback to be invoked when an Apptimize A/B experiment is run.
static interface	Apptimize.OnExperimentsProcessedListener Interface definition for a callback to be invoked when an Apptimize A/B experiment configuration is recalculated.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addOnExperimentsProcessedListener(Apptimize.OnExperimentsProcessedListener l) Add a callback to be invoked when an Apptimize configuration is recalculated.
static void	addToMetric(java.lang.String metricName, double value) Deprecated. Use track(String, double) instead.
static void	clearAllForcedVariants() Stop forcing variants.
static void	clearForcedVariant(java.lang.Long variantId) Stop forcing the variant with the given Id.
static void	clearUserAttribute(java.lang.String attributeName) Erase a user attribute from memory so it's no longer used for targeting/filtering/segmenting.
static void	disable() Disables Apptimize.
static double	doubleForTest(java.lang.String varName, double defaultValue) Get the double associated with an Apptimize variable.
static double	doubleForTest(java.lang.String varName, double defaultValue, ApptimizeOptions options) Get the double associated with an Apptimize variable.
static void	event(java.lang.String eventName) Deprecated. Use track(String) instead.
static void	event(java.lang.String eventName, double value) Deprecated. Use track(String, double) instead.
static void	forceVariant(java.lang.Long variantId) Force the variant with the given ID to be enabled.
static java.lang.String	getApptimizeAnonUserId() Get the current Apptimize-created anonymous user ID
static java.lang.String	getCustomerUserId() Get the current customer-specified userId
static java.lang.String	getExperimentString(java.lang.String varName, java.lang.String defaultValue) Deprecated. Use stringForTest(String, String) instead.
static java.lang.String	getPilotTargetingId()
static java.util.Map<java.lang.String,ApptimizeTestInfo>	getTestInfo() Returns information about all Apptimize A/B tests and Feature Flags that the device is enrolled in.
static java.util.Map<java.lang.String,ApptimizeTestInfo>	getTestInfo(ApptimizeOptions options) Returns information about all Apptimize A/B tests and Feature Flags that the device is enrolled in.
static java.lang.String	getUserId() Deprecated. Use getApptimizeAnonUserId() instead.
static java.util.Map<java.lang.Long,java.util.Map<java.lang.String,java.lang.Object>>	getVariants() return information about all variants launched.
static java.util.Map<java.lang.Long,java.util.Map<java.lang.String,java.lang.Object>>	getVariants(ApptimizeOptions options) return information about all variants launched.
static void	goalAchieved(java.lang.String goalName) Inform Apptimize a metric was achieved.
static int	integerForTest(java.lang.String varName, int defaultValue) Get the int associated with an Apptimize variable.
static int	integerForTest(java.lang.String varName, int defaultValue, ApptimizeOptions options) Get the int associated with an Apptimize variable.
static boolean	isFeatureFlagOn(java.lang.String name)
static boolean	isFeatureFlagOn(java.lang.String name, ApptimizeOptions options)
static void	metricAchieved(java.lang.String metricName) Inform Apptimize a metric was achieved.
static void	removeOnExperimentsProcessedListener(Apptimize.OnExperimentsProcessedListener l) Remove an observer to be invoked when an Apptimize configuration is recalculated.
static void	reset() Simulates a fresh install of Apptimize.
static void	reset(boolean setupAgain)
static void	runExperiment(java.lang.String experimentName, ApptimizeExperiment experiment) Executes an experiment.
static void	runTest(java.lang.String testName, ApptimizeTest test) Executes a code block test.
static void	runTest(java.lang.String testName, ApptimizeTest test, ApptimizeOptions options) Executes a code block test.
static void	setActiveCodeBlockForExperiment(java.lang.String experimentName, java.lang.String variationMethodName) Set the active code block for a specific experiment
static <T> void	setActiveValueForDynamicVariable(ApptimizeVar<T> dynVar, T value) Set the active value for a dynamic variable
static void	setCustomerUserId(java.lang.String customerUserId) Set the current customer-specified user ID
static void	setMetric(java.lang.String metricName, double value) Deprecated. Use track(String, double) instead.
static void	setOffline(boolean offline) Set whether Apptimize should be in offline mode.
static void	setOnExperimentRunListener(Apptimize.OnExperimentRunListener l) Register a callback to be invoked when an Apptimize A/B test is run.
static void	setPilotTargetingId(java.lang.String id)
static void	setTestmodeActive(boolean mode) Activate the Apptimize SDK test mode (used for unit testing)
static void	setup(android.content.Context context, java.lang.String appKey) Initializes Apptimize with the default options.
static void	setup(android.content.Context context, java.lang.String appKey, ApptimizeOptions options) Initializes Apptimize with the given options.
static void	setUserAttribute(java.lang.String attributeName, boolean value) Set a user attribute to be used in targeting/filtering/segmenting.
static void	setUserAttribute(java.lang.String attributeName, double number) Set a user attribute to be used in targeting/filtering/segmenting.
static void	setUserAttribute(java.lang.String attributeName, int number) Set a user attribute to be used in targeting/filtering/segmenting.
static void	setUserAttribute(java.lang.String attributeName, java.lang.String string) Set a user attribute to be used in targeting/filtering/segmenting.
static java.lang.String	stringForTest(java.lang.String varName, java.lang.String defaultValue) Get the String associated with an Apptimize variable.
static java.lang.String	stringForTest(java.lang.String varName, java.lang.String defaultValue, ApptimizeOptions options) Get the String associated with an Apptimize variable.
static void	track(java.lang.String eventName) Inform Apptimize that an event occurred.
static void	track(java.lang.String eventName, double value) Inform Apptimize that an event occurred.

Methods inherited from class java.lang.Object

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

Method Detail

setup

public static void setup(android.content.Context context,
         java.lang.String appKey)

Initializes Apptimize with the default options. You should either call Apptimize.setup(this, "your app key") in all of your activities' onCreate methods or in your Application subclass. The latter is easier since you only need to add code in one place, but many Android apps do not specify a custom Application class (via http://developer .android.com/guide/topics/manifest/application-element.html#nm). Apptimize.setup() can be safely called multiple times and should be called on the main thread.

Parameters:

context - Your Context object (e.g., your Application or Activity). Usually just "this".

appKey - The key provided to you by Apptimize. It links your app to your Apptimize account.

setup

public static void setup(android.content.Context context,
         java.lang.String appKey,
         ApptimizeOptions options)

Initializes Apptimize with the given options. You should either call Apptimize.setup(this, "your app key") in all of your activities' onCreate methods or in your Application subclass. The latter is easier since you only need to add code in one place, but many Android apps do not specify a custom Application class (via http://developer .android.com/guide/topics/manifest/application-element.html#nm).

Parameters:

context - Your Context object (e.g., your Application or Activity). Usually just "this".

appKey - The key provided to you by Apptimize. It links your app to your Apptimize account.

options - Options for configuring Apptimize. See ApptimizeOptions

reset

public static void reset()

Simulates a fresh install of Apptimize. For use in testing. All persisted data and attributes will disappear.

reset

public static void reset(boolean setupAgain)

disable

public static void disable()

Disables Apptimize. This will prevent Apptimize from further receiving or sending data, until the Application is closed/destroyed, restarted, and the setup(android.content.Context, String) method is called. If setup(android.content.Context, String) method has not been called yet, this disable method does nothing. Note that this disable method is only activated the moment it is called. Any events after setup(android.content.Context, String) is called, and prior to this disable method is called, will still be tracked.

setOffline

public static void setOffline(boolean offline)

Set whether Apptimize should be in offline mode.

The default value for this setting is false. If set to true, Apptimize will not receive or send data until this setting is reset to false. This setting will persist across app restarts; e.g., if it is set to true and the app is restarted, Apptimize will still be in offline mode until this method is called with a value of false.

You may call this method before or after the Apptimize.setup() call. However, note that if you call this method and then do not call Apptimize.setup() before the app is destroyed, your requested setting will NOT be persisted for the next time the app is created.

Parameters:

offline - True to request offline mode, or false to reset to online mode.

forceVariant

public static void forceVariant(java.lang.Long variantId)

Force the variant with the given ID to be enabled. Normal allocations, including instant updates, will be ignored when there are forced variants. In particular, note that the "Advanced Verify" feature on the dashboard will not work when there are forced variants on the paired device (because "Advanced Verify" works by sending an instant update to the paired device). All variants forced using this method will be treated as though they underwent experiment selection, and will be reflected on your results dashboard. Forced variants are persistent across application launches and will not be reset except by calls to clearForcedVariant or clearAllForcedVariants. If called multiple times, all variants supplied to invocations of this method will be turned on.

Parameters:

variantId - The variantId to be forced.

clearForcedVariant

public static void clearForcedVariant(java.lang.Long variantId)

Stop forcing the variant with the given Id. If this is the only forced variant, normal allocation will resume.

Parameters:

variantId - The variantId to stop forcing.

See Also:

forceVariant(java.lang.Long)

clearAllForcedVariants

public static void clearAllForcedVariants()

Stop forcing variants. Normal allocation will resume.

See Also:

forceVariant(java.lang.Long)

setUserAttribute

public static void setUserAttribute(java.lang.String attributeName,
                    boolean value)

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Parameters:

attributeName - The attribute's name/key.

value - The value of the attribute.

setUserAttribute

public static void setUserAttribute(java.lang.String attributeName,
                    double number)

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Parameters:

attributeName - The attribute's name/key.

number - The value of the attribute.

setUserAttribute

public static void setUserAttribute(java.lang.String attributeName,
                    int number)

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Parameters:

attributeName - The attribute's name/key.

number - The value of the attribute.

setUserAttribute

public static void setUserAttribute(java.lang.String attributeName,
                    java.lang.String string)

Set a user attribute to be used in targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup(). Passing null as the value (the string parameter) has the same effect as calling clearUserAttribute.

Parameters:

attributeName - The attribute's name/key.

string - The value of the attribute.

clearUserAttribute

public static void clearUserAttribute(java.lang.String attributeName)

Erase a user attribute from memory so it's no longer used for targeting/filtering/segmenting. You may call this before or after the Apptimize.setup() call. Attributes will be uploaded with your data so you can filter and segment on them in the Apptimize results browser. You can also use them to target users via the Apptimize frontend. If you want to do targeting of users based on these attributes, you should ideally set your attributes before calling Apptimize.setup().

Parameters:

attributeName - The attribute's name/key.

setPilotTargetingId

public static void setPilotTargetingId(java.lang.String id)

getPilotTargetingId

public static java.lang.String getPilotTargetingId()

isFeatureFlagOn

public static boolean isFeatureFlagOn(java.lang.String name)

isFeatureFlagOn

public static boolean isFeatureFlagOn(java.lang.String name,
                      ApptimizeOptions options)

runTest

public static void runTest(java.lang.String testName,
           ApptimizeTest test,
           ApptimizeOptions options)

Executes a code block test. The code to run a test can be easily obtained from the Apptimize administration website. In it, you specify the test and variant names and it gives you code to paste into your app. It's best to cut and paste from the website to avoid typos. A single method on ApptimizeTest will be called synchronously (i.e. before the method returns). No reference to the ApptimizeTest instance is held or ever called again, unless you call runTest again. So in terms of control flow, this method works exactly like an if statement. Rather than using a code block test, we recommend controlling flow by creating an ApptimizeVar (whose value can be changed by A/B experiments) and then having an if/else or switch statement based on the value of the ApptimizeVar. Options can be configured using the input ApptimizeOptions.

Parameters:

testName - The name of the test you're running.

test - The code for the test. If the test is not currently running, the baseline method will be run.

options - Options for configuring this method. See ApptimizeOptions

runTest

public static void runTest(java.lang.String testName,
           ApptimizeTest test)

Executes a code block test. The code to run a test can be easily obtained from the Apptimize administration website. In it, you specify the test and variant names and it gives you code to paste into your app. It's best to cut and paste from the website to avoid typos. A single method on ApptimizeTest will be called synchronously (i.e. before the method returns). No reference to the ApptimizeTest instance is held or ever called again, unless you call runTest again. So in terms of control flow, this method works exactly like an if statement. Rather than using a code block test, we recommend controlling flow by creating an ApptimizeVar (whose value can be changed by A/B experiments) and then having an if/else or switch statement based on the value of the ApptimizeVar. This method's options can be configured by instead calling runTest(String, ApptimizeTest, ApptimizeOptions).

Parameters:

testName - The name of the test you're running.

test - The code for the test. If the test is not currently running, the baseline method will be run.

runExperiment

public static void runExperiment(java.lang.String experimentName,
                 ApptimizeExperiment experiment)

Executes an experiment. The code to run an experiment can be easily obtained from the Apptimize administration website. In it, you specify the experiment and variant names and it gives you code to paste into your app. It's best to cut and paste from the website to avoid typos. A single method on ApptimizeExperiment will be called synchronously (i.e. before the method returns). No reference to the ApptimizeExperiment instance is held or ever called again, unless you call runExperiment again. So in terms of control flow, this method works exactly like an if statement. Rather than using a code block test, we recommend controlling flow by creating an ApptimizeVar (whose value can be changed by A/B experiments) and then having an if/else or switch statement based on the value of the ApptimizeVar. Note: This method will soon be deprecated. Use runTest(String, ApptimizeTest) instead. This method's options can be configured by instead calling runTest(String, ApptimizeTest, ApptimizeOptions).

Parameters:

experimentName - The name of the experiment you're running.

experiment - The code for the experiment. If the experiment is not currently running, the baseline method will be run.

stringForTest

public static java.lang.String stringForTest(java.lang.String varName,
                             java.lang.String defaultValue,
                             ApptimizeOptions options)

Get the String associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using ApptimizeVar.createString(String, String) and then calling its ApptimizeVar.value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

Options can be configured using the input ApptimizeOptions.

Parameters:

varName - The name of the Apptimize variable.

defaultValue - The value to return if this device is not enrolled in any A/B experiments that affect this variable.

options - Options for configuring this method. See ApptimizeOptions

Returns:

The String value this device should use for this A/B test variable.

stringForTest

public static java.lang.String stringForTest(java.lang.String varName,
                             java.lang.String defaultValue)

Get the String associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using ApptimizeVar.createString(String, String) and then calling its ApptimizeVar.value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling stringForTest(String, String, ApptimizeOptions).

Parameters:

varName - The name of the Apptimize variable.

defaultValue - The value to return if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The String value this device should use for this A/B test variable.

getExperimentString

@Deprecated
public static java.lang.String getExperimentString(java.lang.String varName,
                                              java.lang.String defaultValue)

Deprecated. Use stringForTest(String, String) instead.

Get the String associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using ApptimizeVar.createString(String, String) and then calling its ApptimizeVar.value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling stringForTest(String, String, ApptimizeOptions).

Parameters:

varName - The name of the Apptimize variable.

defaultValue - The value to return if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The String value this device should use for this A/B test variable.

doubleForTest

public static double doubleForTest(java.lang.String varName,
                   double defaultValue,
                   ApptimizeOptions options)

Get the double associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using ApptimizeVar.createDouble(String, Double) and then calling its ApptimizeVar.value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

Options can be configured using the input ApptimizeOptions.

Parameters:

varName - The name of the Apptimize variable.

defaultValue - The value to return if this device is not enrolled in any A/B experiments that affect this variable.

options - Options for configuring this method. See ApptimizeOptions

Returns:

The double value this device should use for this A/B test variable.

doubleForTest

public static double doubleForTest(java.lang.String varName,
                   double defaultValue)

Get the double associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using ApptimizeVar.createDouble(String, Double) and then calling its ApptimizeVar.value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling doubleForTest(String, double, ApptimizeOptions)

Parameters:

varName - The name of the Apptimize variable.

defaultValue - The value to return if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The double value this device should use for this A/B test variable.

integerForTest

public static int integerForTest(java.lang.String varName,
                 int defaultValue,
                 ApptimizeOptions options)

Get the int associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using ApptimizeVar.createInteger(String, Integer) and then calling its ApptimizeVar.value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

Options can be configured using the input ApptimizeOptions.

Parameters:

varName - The name of the Apptimize variable.

defaultValue - The value to return if this device is not enrolled in any A/B experiments that affect this variable.

options - Options for configuring this method. See ApptimizeOptions

Returns:

The int value this device should use for this A/B test variable.

integerForTest

public static int integerForTest(java.lang.String varName,
                 int defaultValue)

Get the int associated with an Apptimize variable. Calling this method is the equivalent of defining an ApptimizeVar using ApptimizeVar.createInteger(String, Integer) and then calling its ApptimizeVar.value() method.

Note that this method will likely be deprecated soon in favor of using ApptimizeVar directly.

This method's options can be configured by instead calling integerForTest(String, int, ApptimizeOptions).

Parameters:

varName - The name of the Apptimize variable.

defaultValue - The value to return if this device is not enrolled in any A/B experiments that affect this variable.

Returns:

The int value this device should use for this A/B test variable.

track

public static void track(java.lang.String eventName)

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, use track(String, double) instead.

Parameters:

eventName - The event's name.

track

public static void track(java.lang.String eventName,
         double value)

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, provide it as the input parameter value. For example, if the event is a purchase, the value might be the price. If there is no such value, use track(String) instead.

Parameters:

eventName - The event's name.

value - The numeric value associated with this event.

event

public static void event(java.lang.String eventName)

Deprecated. Use track(String) instead.

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, use track(String, double) instead.

Parameters:

eventName - The event's name.

event

public static void event(java.lang.String eventName,
         double value)

Deprecated. Use track(String, double) instead.

Inform Apptimize that an event occurred. For noteworthy events that you wish to track, you should call this method each time the event occurs. This data will then be displayed in your results at apptimize.com. Examples of events you could track include: purchases being made, login events, and Facebook shares.

If there is a numeric value associated with this event that you'd like to track and view at apptimize.com, provide it as the input parameter value. For example, if the event is a purchase, the value might be the price. If there is no such value, use track(String) instead.

Parameters:

eventName - The event's name.

value - The numeric value associated with this event.

goalAchieved

public static void goalAchieved(java.lang.String goalName)

Inform Apptimize a metric was achieved. Call this whenever a metric has been achieved. Note: This method will soon be deprecated. Use track(String) instead.

Parameters:

goalName - The metric's name.

metricAchieved

public static void metricAchieved(java.lang.String metricName)

Inform Apptimize a metric was achieved. Call this whenever a metric has been achieved. Note: This method will soon be deprecated. Use track(String) instead.

Parameters:

metricName - The metric's name.

setMetric

public static void setMetric(java.lang.String metricName,
             double value)

Deprecated. Use track(String, double) instead.

Inform Apptimize that a numeric metric was achieved. A numeric metric is a noteworthy event associated with a numeric value that you wish to track. Call this whenever a numeric metric has been achieved, and this data will then be displayed in your results at apptimize.com.

For example, if the event you're interested in is a purchase event, you could call this method when a purchase is made and provide the price as the value. Then when viewing your results at apptimize.com you would be able to see the sum of the purchase prices.

Parameters:

metricName - The metric's name.

value - The numeric value associated with this metric event.

addToMetric

public static void addToMetric(java.lang.String metricName,
               double value)

Deprecated. Use track(String, double) instead.

Inform Apptimize that a numeric metric was achieved. A numeric metric is a noteworthy event associated with a numeric value that you wish to track. Call this whenever a numeric metric has been achieved, and this data will then be displayed in your results at apptimize.com.

For example, if the event you're interested in is a purchase event, you could call this method when a purchase is made and provide the price as the value. Then when viewing your results at apptimize.com you would be able to see the sum of the purchase prices.

Parameters:

metricName - The metric's name.

value - The numeric value associated with this metric event.

getTestInfo

public static java.util.Map<java.lang.String,ApptimizeTestInfo> getTestInfo()

Returns information about all Apptimize A/B tests and Feature Flags that the device is enrolled in. Note that this does NOT include information about Apptimize A/B tests or Feature Flags that are running but that this device is not enrolled in.

The returned Map will contain one entry for each A/B test and Feature Flag that the device is enrolled in. The key will be the name of the test or Feature Flag, and the value will be the ApptimizeTestInfo containing information about this test. The return will be empty if this device is enrolled in no tests.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Returns:

The Map with a ApptimizeTestInfo for each A/B test and Feature Flag that the device is enrolled in, or null if no information could be returned.

getTestInfo

public static java.util.Map<java.lang.String,ApptimizeTestInfo> getTestInfo(ApptimizeOptions options)

Returns information about all Apptimize A/B tests and Feature Flags that the device is enrolled in. Note that this does NOT include information about Apptimize A/B tests or Feature Flags that are running but that this device is not enrolled in.

The returned Map will contain one entry for each A/B test and Feature Flag that the device is enrolled in. The key will be the name of the test or Feature Flag and the value will be the ApptimizeTestInfo containing information about this test. The return will be empty if this device is enrolled in no tests.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Parameters:

options - Options for configuring this method. See ApptimizeOptions

Returns:

The Map with a ApptimizeTestInfo for each A/B test and Feature Flag that the device is enrolled in, or null if this information could not be returned.

getVariants

public static java.util.Map<java.lang.Long,java.util.Map<java.lang.String,java.lang.Object>> getVariants()

return information about all variants launched.

The returned Map will contain one entry for each variant in a currently running experiment. The returned Map will have the key as the variant's ID, and the value as another Map that maps String key to their corresponding Object values:
("variantId" : Long, "variantName" : String, "experimentId" : Long, "experimentName" : String). The return will be empty if there are no running experiments.

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Returns:

the Map for each variant launched, or null if this information could not be found

getVariants

public static java.util.Map<java.lang.Long,java.util.Map<java.lang.String,java.lang.Object>> getVariants(ApptimizeOptions options)

return information about all variants launched.

The returned Map will contain one entry for each variant in a currently running experiment. The returned Map will have the key as the variant's ID, and the value as another Map that maps String key to their corresponding Object values:
("variantId" : Long, "variantName" : String, "experimentId" : Long, "experimentName" : String). The return will be empty if there are no running experiments.

In rare cases where results come from old verions of Apptimize, the field 'experimentId' may be null;

Note that it is also possible for this method to return null if no information could be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called.

Parameters:

options - Options for configuring this method. See ApptimizeOptions

Returns:

the Map for each variant launched, or null if this information could not be found

getUserId

public static java.lang.String getUserId()

Deprecated. Use getApptimizeAnonUserId() instead.

Returns the String user ID that uniquely identifies this device to Apptimize. This method will return null if the user ID could not be returned; e.g., in the case where this method is called before setup(android.content.Context, String) is called. In rare cases this method could return the empty string, like in the case where you have remotely disabled the Apptimize library.

Returns:

The String user ID that uniquely identifies this device to Apptimize, or, in uncommon cases where there is no user ID, either null or the empty string.

setOnExperimentRunListener

public static void setOnExperimentRunListener(Apptimize.OnExperimentRunListener l)

Register a callback to be invoked when an Apptimize A/B test is run.

Parameters:

l - The Apptimize.OnExperimentRunListener that will be invoked when an Apptimize A/B test is run. If this null then any previously set listener will be unset.

addOnExperimentsProcessedListener

public static void addOnExperimentsProcessedListener(Apptimize.OnExperimentsProcessedListener l)

Add a callback to be invoked when an Apptimize configuration is recalculated. The enrolled experiments may or may not have changed. The dynamic variable values may or may not have changed. Feature flag values may or may not have changed. This happens at various times:

• new information from server
• device properties or custom attributes changed
• and a few other cases

Parameters:

l - The Apptimize.OnExperimentsProcessedListener that will be invoked when an Apptimize configuration is recalculated.

removeOnExperimentsProcessedListener

public static void removeOnExperimentsProcessedListener(Apptimize.OnExperimentsProcessedListener l)

Remove an observer to be invoked when an Apptimize configuration is recalculated.

Parameters:

l - The Apptimize.OnExperimentsProcessedListener to be removed.

setTestmodeActive

public static void setTestmodeActive(boolean mode)

Activate the Apptimize SDK test mode (used for unit testing)

Parameters:

mode - if true, this method will activate the test mode which overrides normal sdk behavior. if false, this method will restore the sdk normal behavior

setActiveCodeBlockForExperiment

public static void setActiveCodeBlockForExperiment(java.lang.String experimentName,
                                   java.lang.String variationMethodName)

Set the active code block for a specific experiment

Parameters:

experimentName - name of the experiment

variationMethodName - the variation method name being applied

setActiveValueForDynamicVariable

public static <T> void setActiveValueForDynamicVariable(ApptimizeVar<T> dynVar,
                                        T value)

Set the active value for a dynamic variable

Parameters:

dynVar - the dynamic variable

value - the value of the dynamic variable

setCustomerUserId

public static void setCustomerUserId(java.lang.String customerUserId)

Set the current customer-specified user ID

User IDs are arbitrary strings, except that they cannot be the empty string "". When the customer-specified user ID is null, then Apptimize creates and uses an anonymous user ID for tracking purposes. If the customerUserId is set to a non-null value, then set back to null, Apptimize will use the same anonymous user ID as before. The initial default value of the customer-specified user ID is null.

Parameters:

customerUserId - the user ID string

getCustomerUserId

public static java.lang.String getCustomerUserId()

Get the current customer-specified userId

User IDs are arbitrary strings. If the customer-specified user ID is null, then Apptimize will create and use an anonymous user ID for tracking purposes. The initial default value of the customer-specified user ID is null.

getApptimizeAnonUserId

public static java.lang.String getApptimizeAnonUserId()

Get the current Apptimize-created anonymous user ID

This anonymous user ID will be used if-and-only-if the customer-specified user ID is null. A single anonymous user ID is created. If the customerUserId is set to a non-null value, then set back to null, Apptimize will use the same anonymous user ID as before.