Event.Type (mParticle Firehose Java SDK Reference)

java.lang.Object
- java.lang.Enum<Event.Type>
- - com.mparticle.sdk.model.eventprocessing.Event.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Event.Type>

Enclosing class:

Event
```
public static enum Event.Type
extends java.lang.Enum<Event.Type>
```
Event types.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPLICATION_STATE_TRANSITION` When a user cold-starts, resumes, leaves, or force-closes an app, an AST event will be generated.
`ATTRIBUTION`
`CUSTOM_EVENT` This is the generic event object used throughout all of mParticle's SDKs, used to log discrete events, associate with a name, an event type, and a map of keys and values.
`ERROR` This type of data represents an error that has occurred in an application, such as an exception, regardless of if it led to an app crash (unhandled) or not (handled).
`IMPRESSION` This is the event used for eCommerce Impression events.
`PRIVACY_SETTING_CHANGE` This represents when a user has chosen to opt-out or opt-in to a service.
`PRODUCT_ACTION` This is the event used for all Product-related eCommerce events.
`PROMOTION_ACTION` This is the event used for eCommerce Promotion events.
`PUSH_MESSAGE_OPEN` This event represents when the users opens a push notification.
`PUSH_MESSAGE_RECEIPT` This event represents when the device receives a push notification.
`PUSH_SUBSCRIPTION` This event represents when a user subscribes to push notifications with Apple's push notification service, or Google's Cloud Messaging service, and will typically contain the associated push token or ID.
`SCREEN_VIEW` This represents when a user views a particular screen or page of an application.
`SESSION_END` This represents when a user session ends.
`SESSION_START` This represents when a user session starts and the app has come into the foreground.
`USER_ATTRIBUTE_CHANGE` The mParticle mobile and Javascript SDKs provide APIs to associate user attributes with the current user.
`USER_IDENTITY_CHANGE` Similar to user attributes, users can have 1 or more associated IDs, such as email.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`toString()`
`static Event.Type`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Event.Type[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SESSION_START
```
public static final Event.Type SESSION_START
```
    This represents when a *user session* starts and the app has come into the foreground.
  - SESSION_END
```
public static final Event.Type SESSION_END
```
    This represents when a *user session* ends. This will occur once the user has left the app, and the app is in the background for an amount of time. Once the session times-out, the session end event will be fired.
  - CUSTOM_EVENT
```
public static final Event.Type CUSTOM_EVENT
```
    This is the generic event object used throughout all of mParticle's SDKs, used to log discrete events, associate with a name, an event type, and a map of keys and values.
  - SCREEN_VIEW
```
public static final Event.Type SCREEN_VIEW
```
    This represents when a user views a particular screen or page of an application.
  - ERROR
```
public static final Event.Type ERROR
```
    This type of data represents an error that has occurred in an application, such as an exception, regardless of if it led to an app crash (unhandled) or not (handled).
  - PRIVACY_SETTING_CHANGE
```
public static final Event.Type PRIVACY_SETTING_CHANGE
```
    This represents when a user has chosen to opt-out or opt-in to a service.
  - USER_ATTRIBUTE_CHANGE
```
public static final Event.Type USER_ATTRIBUTE_CHANGE
```
    The mParticle mobile and Javascript SDKs provide APIs to associate user attributes with the current user. This event represents when a user changes, either by adding, removing, or updated an attribute associated with profile.
  - USER_IDENTITY_CHANGE
```
public static final Event.Type USER_IDENTITY_CHANGE
```
    Similar to user attributes, users can have 1 or more associated IDs, such as email. This event will fire when a user adds, removed, or updates an identity.
  - PUSH_SUBSCRIPTION
```
public static final Event.Type PUSH_SUBSCRIPTION
```
    This event represents when a user subscribes to push notifications with Apple's push notification service, or Google's Cloud Messaging service, and will typically contain the associated push token or ID.
  - APPLICATION_STATE_TRANSITION
```
public static final Event.Type APPLICATION_STATE_TRANSITION
```
    When a user cold-starts, resumes, leaves, or force-closes an app, an AST event will be generated. Note that a user may leave and return to an app several times during a single session.
  - PUSH_MESSAGE_RECEIPT
```
public static final Event.Type PUSH_MESSAGE_RECEIPT
```
    This event represents when the device receives a push notification. NOTE: Integrations registering for PUSH_MESSAGE_RECEIPT must also set a push provider ID within the EventProcessingRegistration. See EventProcessingRegistration.setPushMessagingProviderId(String)
  - PRODUCT_ACTION
```
public static final Event.Type PRODUCT_ACTION
```
    This is the event used for all Product-related eCommerce events. There are several types of product actions, such as purchase and refund.
  - PROMOTION_ACTION
```
public static final Event.Type PROMOTION_ACTION
```
    This is the event used for eCommerce Promotion events. There are two types of promotion events, view and click.
  - IMPRESSION
```
public static final Event.Type IMPRESSION
```
    This is the event used for eCommerce Impression events.
  - ATTRIBUTION
```
public static final Event.Type ATTRIBUTION
```
  - PUSH_MESSAGE_OPEN
```
public static final Event.Type PUSH_MESSAGE_OPEN
```
    This event represents when the users opens a push notification.
- Method Detail
  - values
```
public static Event.Type[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Event.Type c : Event.Type.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Event.Type valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<Event.Type>

Enum Event.Type

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SESSION_START

SESSION_END

CUSTOM_EVENT

SCREEN_VIEW

ERROR

PRIVACY_SETTING_CHANGE

USER_ATTRIBUTE_CHANGE

USER_IDENTITY_CHANGE

PUSH_SUBSCRIPTION

APPLICATION_STATE_TRANSITION

PUSH_MESSAGE_RECEIPT

PRODUCT_ACTION

PROMOTION_ACTION

IMPRESSION

ATTRIBUTION

PUSH_MESSAGE_OPEN

Method Detail

values

valueOf

toString