Package com.flurry.android

Enum Class FlurryEvent

java.lang.Object

java.lang.Enum<FlurryEvent>

com.flurry.android.FlurryEvent

All Implemented Interfaces:

Serializable, Comparable<FlurryEvent>, java.lang.constant.Constable

public enum FlurryEvent
extends Enum<FlurryEvent>

The FlurryEvent defines the supported types of Flurry standard events, and their predefined parameters.

See Also:

• Flurry Publisher Support Site

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlurryEvent.BooleanParam
static class	FlurryEvent.DoubleParam
static class	FlurryEvent.IntegerParam
static class	FlurryEvent.Param	The predefined parameters of the standard events.
static class	FlurryEvent.ParamBase
static class	FlurryEvent.Params	The parameters map object for logging the standard events.
static class	FlurryEvent.StringParam

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACHIEVEMENT_UNLOCKED	Log this event when a user unlocks an achievement in the app.
AD_CLICK	Log this event when a user clicks on an Ad.
AD_IMPRESSION	Log this event when a user views an Ad impression.
AD_REWARDED	Log this event when a user is granted a reward for viewing a rewarded Ad.
AD_SKIPPED	Log this event when a user skips an Ad.
ADD_ITEM_TO_CART	Log this event when an item is added to the cart.
ADD_ITEM_TO_WISH_LIST	Log this event when an item is added to the wish list.
APP_ACTIVATED	Log this event when the App is activated.
APPLICATION_SUBMITTED	Log this event when a user submits an application through the App.
CHECKOUT_INITIATED	Log this event when a user starts checkout.
COMMENT	Log this event when a user comments or replies on a social post.
COMPLETED_CHECKOUT	Log this event when checkout is completed or transaction is successfully completed.
CONTENT_RATED	Log this event when a user rates a content in the App.
CONTENT_SAVED	Log this event when a user saves the content in the App.
CONTENT_VIEWED	Log this event when a specific content is viewed by a user.
CREDITS_EARNED	Log this event when a user earns credit in the app.
CREDITS_PURCHASED	Log this event when a user purchases credit in the app.
CREDITS_SPENT	Log this event when a user spends credit in the app.
FUNDS_DONATED	Log this event when a user donates fund to your App or through the App.
GROUP_JOINED	Log this event when user joins a group.
GROUP_LEFT	Log this event when user leaves a group.
INVITE	Log this event when a user invites another user.
ITEM_LIST_VIEWED	Log this event when a list of items is viewed.
ITEM_VIEWED	Log this event when an item is viewed.
KEYWORD_SEARCHED	Log this event when a user searches for a keyword using Search.
LEVEL_COMPLETED	Log this event when an App user completes a level.
LEVEL_FAILED	Log this event when an App user fails a level.
LEVEL_SKIP	Log this event when an App user skips a level.
LEVEL_STARTED	Log this event when an App user starts a level.
LEVEL_UP	Log this event when an App user levels up.
LIKE	Log this event when a user likes a social content.
LOCATION_SEARCHED	Log this event when a user searches for a location using Search.
LOGIN	Log this event when a user login on the App.
LOGOUT	Log this event when a user logout of the App.
MEDIA_CAPTURED	Log this event when an image, audio or a video is captured.
MEDIA_PAUSED	Log this event when an audio or video is paused.
MEDIA_STARTED	Log this event when an audio or video starts.
MEDIA_STOPPED	Log this event when an audio or video is stopped.
OFFER_PRESENTED	Log this event when an offer is presented to the user.
PAYMENT_INFO_ADDED	Log this event when payment information is added during a checkout process.
PRIVACY_OPT_IN	Log this event when a user opts in (on the privacy prompt).
PRIVACY_OPT_OUT	Log this event when a user opts out (on the privacy prompt).
PRIVACY_PROMPT_DISPLAYED	Log this event when a privacy prompt is displayed.
PRODUCT_CUSTOMIZED	Log this event when a user customizes the App/product.
PURCHASE_REFUNDED	Log this event at refund.
PURCHASED	Log this event when a user does a purchase in the App.
REMOVE_ITEM_FROM_CART	Log this event when a user removes an item from the cart.
SCORE_POSTED	Log this event when an App user posts his score.
SEARCH_RESULT_VIEWED	Log this event when user views search results.
SHARE	Log this event when a user shares content with another user in the App.
SUBSCRIPTION_ENDED	Log this event when a user unsubscribes from a paid subscription for a service or product.
SUBSCRIPTION_STARTED	Log this event at the start of a paid subscription for a service or product.
TUTORIAL_COMPLETED	Log this event when a user completes a tutorial.
TUTORIAL_SKIPPED	Log this event when user skips the tutorial.
TUTORIAL_STARTED	Log this event when a user starts a tutorial.
TUTORIAL_STEP_COMPLETED	Log this event when a specific tutorial step is completed.
USER_REGISTERED	Log the event when a user registers (signup).
USER_SCHEDULED	Log this event when user schedules an appointment using the App.

Field Summary

Fields

Modifier and Type	Field	Description
final String	eventName
final FlurryEvent.ParamBase[]	mandatoryParams
final FlurryEvent.ParamBase[]	recommendedParams

Method Summary

Modifier and Type	Method	Description
static FlurryEvent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FlurryEvent[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AD_CLICK

public static final FlurryEvent AD_CLICK

Log this event when a user clicks on an Ad.
mandatory parameters: none
recommended parameters: Param.AD_TYPE

AD_IMPRESSION

public static final FlurryEvent AD_IMPRESSION

Log this event when a user views an Ad impression.
mandatory parameters: none
recommended parameters: Param.AD_TYPE

AD_REWARDED

public static final FlurryEvent AD_REWARDED

Log this event when a user is granted a reward for viewing a rewarded Ad.
mandatory parameters: none
recommended parameters: Param.AD_TYPE

AD_SKIPPED

public static final FlurryEvent AD_SKIPPED

Log this event when a user skips an Ad.
mandatory parameters: none
recommended parameters: Param.AD_TYPE

CREDITS_SPENT

public static final FlurryEvent CREDITS_SPENT

Log this event when a user spends credit in the app.
mandatory parameters: Param.TOTAL_AMOUNT
recommended parameters: Param.LEVEL_NUMBER, Param.IS_CURRENCY_SOFT, Param.CREDIT_TYPE, Param.CREDIT_ID, Param.CREDIT_NAME, Param.CURRENCY_TYPE

CREDITS_PURCHASED

public static final FlurryEvent CREDITS_PURCHASED

Log this event when a user purchases credit in the app.
mandatory parameters: Param.TOTAL_AMOUNT
recommended parameters: Param.LEVEL_NUMBER, Param.IS_CURRENCY_SOFT, Param.CREDIT_TYPE, Param.CREDIT_ID, Param.CREDIT_NAME, Param.CURRENCY_TYPE

CREDITS_EARNED

public static final FlurryEvent CREDITS_EARNED

Log this event when a user earns credit in the app.
mandatory parameters: Param.TOTAL_AMOUNT
recommended parameters: Param.LEVEL_NUMBER, Param.IS_CURRENCY_SOFT, Param.CREDIT_TYPE, Param.CREDIT_ID, Param.CREDIT_NAME, Param.CURRENCY_TYPE

ACHIEVEMENT_UNLOCKED

public static final FlurryEvent ACHIEVEMENT_UNLOCKED

Log this event when a user unlocks an achievement in the app.
mandatory parameters: none
recommended parameters: Param.ACHIEVEMENT_ID

LEVEL_COMPLETED

public static final FlurryEvent LEVEL_COMPLETED

Log this event when an App user completes a level.
mandatory parameters: Param.LEVEL_NUMBEER
recommended parameters: Param.LEVEL_NAME

LEVEL_FAILED

public static final FlurryEvent LEVEL_FAILED

Log this event when an App user fails a level.
mandatory parameters: Param.LEVEL_NUMBEER
recommended parameters: Param.LEVEL_NAME

LEVEL_UP

public static final FlurryEvent LEVEL_UP

Log this event when an App user levels up.
mandatory parameters: Param.LEVEL_NUMBEER
recommended parameters: Param.LEVEL_NAME

LEVEL_STARTED

public static final FlurryEvent LEVEL_STARTED

Log this event when an App user starts a level.
mandatory parameters: Param.LEVEL_NUMBEER
recommended parameters: Param.LEVEL_NAME

LEVEL_SKIP

public static final FlurryEvent LEVEL_SKIP

Log this event when an App user skips a level.
mandatory parameters: Param.LEVEL_NUMBEER
recommended parameters: Param.LEVEL_NAME

SCORE_POSTED

public static final FlurryEvent SCORE_POSTED

Log this event when an App user posts his score.
mandatory parameters: Param.SCORE
recommended parameters: Param.LEVEL_NUMBEER

CONTENT_RATED

public static final FlurryEvent CONTENT_RATED

Log this event when a user rates a content in the App.
mandatory parameters: Param.CONTENT_ID, Param.RATING
recommended parameters: Param.CONTENT_TYPE, Param.CONTENT_NAME

CONTENT_VIEWED

public static final FlurryEvent CONTENT_VIEWED

Log this event when a specific content is viewed by a user.
mandatory parameters: Param.CONTENT_ID
recommended parameters: Param.CONTENT_TYPE, Param.CONTENT_NAME

CONTENT_SAVED

public static final FlurryEvent CONTENT_SAVED

Log this event when a user saves the content in the App.
mandatory parameters: Param.CONTENT_ID
recommended parameters: Param.CONTENT_TYPE, Param.CONTENT_NAME

PRODUCT_CUSTOMIZED

public static final FlurryEvent PRODUCT_CUSTOMIZED

Log this event when a user customizes the App/product.
mandatory parameters: none
recommended parameters: none

APP_ACTIVATED

public static final FlurryEvent APP_ACTIVATED

Log this event when the App is activated.
mandatory parameters: none
recommended parameters: none

APPLICATION_SUBMITTED

public static final FlurryEvent APPLICATION_SUBMITTED

Log this event when a user submits an application through the App.
mandatory parameters: none
recommended parameters: none

ADD_ITEM_TO_CART

public static final FlurryEvent ADD_ITEM_TO_CART

Log this event when an item is added to the cart.
mandatory parameters: Param.ITEM_COUNT, Param.PRICE
recommended parameters: Param.ITEM_ID, Param.ITEM_NAME, Param.ITEM_TYPE

ADD_ITEM_TO_WISH_LIST

public static final FlurryEvent ADD_ITEM_TO_WISH_LIST

Log this event when an item is added to the wish list.
mandatory parameters: Param.ITEM_COUNT, Param.PRICE
recommended parameters: Param.ITEM_ID, Param.ITEM_NAME, Param.ITEM_TYPE

COMPLETED_CHECKOUT

public static final FlurryEvent COMPLETED_CHECKOUT

Log this event when checkout is completed or transaction is successfully completed.
mandatory parameters: Param.ITEM_COUNT, Param.TOTAL_AMOUNT
recommended parameters: Param.CURRENCY_TYPE, Param.TRANSACTION_ID

PAYMENT_INFO_ADDED

public static final FlurryEvent PAYMENT_INFO_ADDED

Log this event when payment information is added during a checkout process.
mandatory parameters: none
recommended parameters: Param.SUCCESS, Param.PAYMENT_TYPE

ITEM_VIEWED

public static final FlurryEvent ITEM_VIEWED

Log this event when an item is viewed.
mandatory parameters: Param.ITEM_ID
recommended parameters: Param.ITEM_NAME, Param.ITEM_TYPE, Param.PRICE

ITEM_LIST_VIEWED

public static final FlurryEvent ITEM_LIST_VIEWED

Log this event when a list of items is viewed.
mandatory parameters: none
recommended parameters: Param.ITEM_LIST_TYPE

PURCHASED

public static final FlurryEvent PURCHASED

Log this event when a user does a purchase in the App.
mandatory parameters: Param.TOTAL_AMOUNT
recommended parameters: Param.ITEM_COUNT, Param.ITEM_ID, Param.SUCCESS, Param.ITEM_NAME, Param.ITEM_TYPE, Param.CURRENCY_TYPE, Param.TRANSACTION_ID

PURCHASE_REFUNDED

public static final FlurryEvent PURCHASE_REFUNDED

Log this event at refund.
mandatory parameters: Param.PRICE
recommended parameters: Param.CURRENCY_TYPE

REMOVE_ITEM_FROM_CART

public static final FlurryEvent REMOVE_ITEM_FROM_CART

Log this event when a user removes an item from the cart.
mandatory parameters: Param.ITEM_ID
recommended parameters: Param.PRICE, Param.ITEM_NAME, Param.ITEM_TYPE

CHECKOUT_INITIATED

public static final FlurryEvent CHECKOUT_INITIATED

Log this event when a user starts checkout.
mandatory parameters: Param.ITEM_COUNT, Param.TOTAL_AMOUNT
recommended parameters: none

FUNDS_DONATED

public static final FlurryEvent FUNDS_DONATED

Log this event when a user donates fund to your App or through the App.
mandatory parameters: Param.PRICE
recommended parameters: Param.CURRENCY_TYPE

USER_SCHEDULED

public static final FlurryEvent USER_SCHEDULED

Log this event when user schedules an appointment using the App.
mandatory parameters: none
recommended parameters: none

OFFER_PRESENTED

public static final FlurryEvent OFFER_PRESENTED

Log this event when an offer is presented to the user.
mandatory parameters: Param.ITEM_ID, Param.PRICE
recommended parameters: Param.ITEM_NAME, Param.ITEM_CATEGORY

SUBSCRIPTION_STARTED

public static final FlurryEvent SUBSCRIPTION_STARTED

Log this event at the start of a paid subscription for a service or product.
mandatory parameters: Param.PRICE, Param.IS_ANNUAL_SUBSCRIPTION
recommended parameters: Param.TRIAL_DAYS, Param.PREDICTED_LTV, Param.CURRENCY_TYPE, Params.SUBSCRIPTION_COUNTRY

SUBSCRIPTION_ENDED

public static final FlurryEvent SUBSCRIPTION_ENDED

Log this event when a user unsubscribes from a paid subscription for a service or product.
mandatory parameters: Param.IS_ANNUAL_SUBSCRIPTION
recommended parameters: Param.CURRENCY_TYPE, Params.SUBSCRIPTION_COUNTRY

GROUP_JOINED

public static final FlurryEvent GROUP_JOINED

Log this event when user joins a group.
mandatory parameters: none
recommended parameters: Param.GROUP_NAME

GROUP_LEFT

public static final FlurryEvent GROUP_LEFT

Log this event when user leaves a group.
mandatory parameters: none
recommended parameters: Param.GROUP_NAME

TUTORIAL_STARTED

public static final FlurryEvent TUTORIAL_STARTED

Log this event when a user starts a tutorial.
mandatory parameters: none
recommended parameters: Param.TUTORIAL_NAME

TUTORIAL_COMPLETED

public static final FlurryEvent TUTORIAL_COMPLETED

Log this event when a user completes a tutorial.
mandatory parameters: none
recommended parameters: Param.TUTORIAL_NAME

TUTORIAL_STEP_COMPLETED

public static final FlurryEvent TUTORIAL_STEP_COMPLETED

Log this event when a specific tutorial step is completed.
mandatory parameters: Param.STEP_NUMBER
recommended parameters: Param.TUTORIAL_NAME

TUTORIAL_SKIPPED

public static final FlurryEvent TUTORIAL_SKIPPED

Log this event when user skips the tutorial.
mandatory parameters: Param.STEP_NUMBER
recommended parameters: Param.TUTORIAL_NAME

LOGIN

public static final FlurryEvent LOGIN

Log this event when a user login on the App.
mandatory parameters: none
recommended parameters: Param.USER_ID, Param.METHOD

LOGOUT

public static final FlurryEvent LOGOUT

Log this event when a user logout of the App.
mandatory parameters: none
recommended parameters: Param.USER_ID, Param.METHOD

USER_REGISTERED

public static final FlurryEvent USER_REGISTERED

Log the event when a user registers (signup). Helps capture the method used to sign-up (sign up with google/apple or emailaddress) .
mandatory parameters: none
recommended parameters: Param.USER_ID, Param.METHOD

SEARCH_RESULT_VIEWED

public static final FlurryEvent SEARCH_RESULT_VIEWED

Log this event when user views search results.
mandatory parameters: none
recommended parameters: Param.QUERY, Param.SEARCH_TYPE

KEYWORD_SEARCHED

public static final FlurryEvent KEYWORD_SEARCHED

Log this event when a user searches for a keyword using Search.
mandatory parameters: none
recommended parameters: Param.QUERY, Param.SEARCH_TYPE

LOCATION_SEARCHED

public static final FlurryEvent LOCATION_SEARCHED

Log this event when a user searches for a location using Search.
mandatory parameters: none
recommended parameters: Param.QUERY

INVITE

public static final FlurryEvent INVITE

Log this event when a user invites another user.
mandatory parameters: none
recommended parameters: Param.USER_ID, Param.METHOD

SHARE

public static final FlurryEvent SHARE

Log this event when a user shares content with another user in the App.
mandatory parameters: Param.SOCIAL_CONTENT_ID
recommended parameters: Param.SOCIAL_CONTENT_NAME, Param.METHOD

LIKE

public static final FlurryEvent LIKE

Log this event when a user likes a social content. e.g. likeType captures what kind of like is logged ("celebrate", "insightful", etc).
mandatory parameters: Param.SOCIAL_CONTENT_ID
recommended parameters: Param.SOCIAL_CONTENT_NAME, Param.LIKE_TYPE

COMMENT

public static final FlurryEvent COMMENT

Log this event when a user comments or replies on a social post.
mandatory parameters: Param.SOCIAL_CONTENT_ID
recommended parameters: Param.SOCIAL_CONTENT_NAME

MEDIA_CAPTURED

public static final FlurryEvent MEDIA_CAPTURED

Log this event when an image, audio or a video is captured.
mandatory parameters: none
recommended parameters: Param.MEDIA_ID, Param.MEDIA_NAME, Param.MEDIA_TYPE

MEDIA_STARTED

public static final FlurryEvent MEDIA_STARTED

Log this event when an audio or video starts.
mandatory parameters: none
recommended parameters: Param.MEDIA_ID, Param.MEDIA_NAME, Param.MEDIA_TYPE

MEDIA_STOPPED

public static final FlurryEvent MEDIA_STOPPED

Log this event when an audio or video is stopped.
mandatory parameters: Param.DURATION
recommended parameters: Param.MEDIA_ID, Param.MEDIA_NAME, Param.MEDIA_TYPE

MEDIA_PAUSED

public static final FlurryEvent MEDIA_PAUSED

Log this event when an audio or video is paused.
mandatory parameters: Param.DURATION
recommended parameters: Param.MEDIA_ID, Param.MEDIA_NAME, Param.MEDIA_TYPE

PRIVACY_PROMPT_DISPLAYED

public static final FlurryEvent PRIVACY_PROMPT_DISPLAYED

Log this event when a privacy prompt is displayed.
mandatory parameters: none
recommended parameters: none

PRIVACY_OPT_IN

public static final FlurryEvent PRIVACY_OPT_IN

Log this event when a user opts in (on the privacy prompt).
mandatory parameters: none
recommended parameters: none

PRIVACY_OPT_OUT

public static final FlurryEvent PRIVACY_OPT_OUT

Log this event when a user opts out (on the privacy prompt).
mandatory parameters: none
recommended parameters: none

Field Details

eventName

public final String eventName

mandatoryParams

public final FlurryEvent.ParamBase[] mandatoryParams

recommendedParams

public final FlurryEvent.ParamBase[] recommendedParams

Method Details

values

public static FlurryEvent[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FlurryEvent valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null