com.apptimize

Class ApptimizeTestInfo

java.lang.Object

com.apptimize.ApptimizeTestInfo

public class ApptimizeTestInfo
extends java.lang.Object

Information about a single Apptimize A/B test that this device is enrolled in.

Constructor Summary

Constructors

Constructor and Description

ApptimizeTestInfo(java.lang.String testName, java.lang.Long testId, com.apptimize.ApptimizeTestType testType, java.lang.String enrolledVariantName, long enrolledVariantId, java.util.Date testStartedDate, java.util.Date testEnrolledDate, boolean participated, int cycle, int currentPhase, int participationPhase, java.lang.String userId, java.lang.String anonymousUserId) Create a new ApptimizeTestInfo data class.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAnonymousUserId()
com.apptimize.ApptimizeTestType	getApptimizeTestType()
int	getCurrentPhase() Returns the current phase of this test.
java.lang.String	getCustomerUserId()
int	getCycle() Returns the cycle of this test.
long	getEnrolledVariantId()
java.lang.String	getEnrolledVariantName()
int	getParticipationPhase() Returns the phase in which the last participation occurred for this test.
java.util.Date	getTestEnrolledDate() Returns the Date this device was enrolled into this A/B test.
java.lang.Long	getTestId() Returns the Long ID of the Apptimize A/B test.
java.lang.String	getTestName()
java.util.Date	getTestStartedDate() Returns the Date this Apptimize test was started.
boolean	userHasParticipated() Returns whether the user has participated in this test since enrollment.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApptimizeTestInfo

public ApptimizeTestInfo(java.lang.String testName,
                 java.lang.Long testId,
                 com.apptimize.ApptimizeTestType testType,
                 java.lang.String enrolledVariantName,
                 long enrolledVariantId,
                 java.util.Date testStartedDate,
                 java.util.Date testEnrolledDate,
                 boolean participated,
                 int cycle,
                 int currentPhase,
                 int participationPhase,
                 java.lang.String userId,
                 java.lang.String anonymousUserId)

Create a new ApptimizeTestInfo data class.

Parameters:

testName - The name of the test

testId - The unique id of the test

testType - The type of test

enrolledVariantName - The name of the variant the user is enrolled in

enrolledVariantId - The unique id of the varient the user is enrolled in

testStartedDate - The date the test started

testEnrolledDate - The date the user became enrolled

participated - A flag indicating if the user has participated in the test yet

cycle - The current cycle of the test

currentPhase - The current phase of the test

participationPhase - The phase which the user first participated in

userId - The userId of the enrolled user (may be null)

anonymousUserId - The anonymous id of the enrolled user

Method Detail

getTestName

public java.lang.String getTestName()

Returns:

The String name of the Apptimize A/B test.

getTestId

public java.lang.Long getTestId()

Returns the Long ID of the Apptimize A/B test. Note that this value can be null if recently upgrading from an older version of the Apptimize SDK that did not support this method.

Returns:

The Long ID of the Apptimize A/B test.

getApptimizeTestType

public com.apptimize.ApptimizeTestType getApptimizeTestType()

Returns:

the ApptimizeTestType type of the Apptimize test

getEnrolledVariantName

public java.lang.String getEnrolledVariantName()

Returns:

The String name of the variant of this test that this device is enrolled in.

getEnrolledVariantId

public long getEnrolledVariantId()

Returns:

The long ID of the variant of this test that this device is enrolled in.

getTestStartedDate

public java.util.Date getTestStartedDate()

Returns the Date this Apptimize test was started. Note that this is the time as reported by Apptimize's servers and is not affected by changes in the device's clock.

Returns:

The Date this Apptimize test was started.

getTestEnrolledDate

public java.util.Date getTestEnrolledDate()

Returns the Date this device was enrolled into this A/B test. Note that unlike the return value for getTestStartedDate() , this is the time as reported by the device, and not the time as reported by Apptimize's server. This difference is relevant if the device's clock is inaccurate.

Returns:

The Date this device was enrolled into this A/B test.

userHasParticipated

public boolean userHasParticipated()

Returns whether the user has participated in this test since enrollment. For code block tests, this indicates that a codeblock has been executed for this test. For visual tests, this indicates that at least one changed element has been seen. For dynamic variable tests, this indicates that the value of a variable has been queried.

Returns:

the Boolean indicating whether the user has participated in this test

getCycle

public int getCycle()

Returns the cycle of this test. This is 1 if it's the initial test run, and increments by 1 each time the test is restarted.

Returns:

The int ID of the cycle of this test.

getCurrentPhase

public int getCurrentPhase()

Returns the current phase of this test. This is 1 if the test has not been modified since creation, and increments by 1 each time the test is modified (such as when a test's allocations have been changed). The phase does not reset when a test is restarted.

Returns:

The int ID of the current phase of this test.

getParticipationPhase

public int getParticipationPhase()

Returns the phase in which the last participation occurred for this test.

Returns:

The int ID of the participation phase of this test.

getCustomerUserId

public java.lang.String getCustomerUserId()

Returns:

The current customer-specified String ID of the user enrolled in the Apptimize A/B test. This may be null if there is no customer specified ID.

getAnonymousUserId

public java.lang.String getAnonymousUserId()

Returns:

The String anonymous user id of the user enrolled in the Apptimize A/B test.