com.mparticle.kits

Interface KitIntegration.AttributeListener

Enclosing class:

KitIntegration

public static interface KitIntegration.AttributeListener

Kits should implement this interface when their underlying service has the notion of a user with attributes.

Method Summary

Modifier and Type	Method and Description
java.util.List<ReportingMessage>	logout() The mParticle SDK exposes a logout API, allowing developers to track an event when a user logs out of their app/platform.
void	removeUserAttribute(java.lang.String key)
void	removeUserIdentity(MParticle.IdentityType identityType)
void	setAllUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes, java.util.Map<java.lang.String,java.util.List<java.lang.String>> userAttributeLists)
void	setUserAttribute(java.lang.String attributeKey, java.lang.String attributeValue)
void	setUserAttributeList(java.lang.String attributeKey, java.util.List<java.lang.String> attributeValueList)
void	setUserIdentity(MParticle.IdentityType identityType, java.lang.String identity)
boolean	supportsAttributeLists() Indicate to the mParticle Kit framework if this AttributeListener supports attribute-values as lists.

Method Detail

setUserAttribute

void setUserAttribute(java.lang.String attributeKey,
                      java.lang.String attributeValue)

setUserAttributeList

void setUserAttributeList(java.lang.String attributeKey,
                          java.util.List<java.lang.String> attributeValueList)

supportsAttributeLists

boolean supportsAttributeLists()

Indicate to the mParticle Kit framework if this AttributeListener supports attribute-values as lists. If an AttributeListener returns false, the setUserAttributeList method will never be called. Instead, setUserAttribute will be called with the attribute-value lists combined as a csv.

Returns:

true if this AttributeListener supports attribute values as lists.

setAllUserAttributes

void setAllUserAttributes(java.util.Map<java.lang.String,java.lang.String> userAttributes,
                          java.util.Map<java.lang.String,java.util.List<java.lang.String>> userAttributeLists)

removeUserAttribute

void removeUserAttribute(java.lang.String key)

setUserIdentity

void setUserIdentity(MParticle.IdentityType identityType,
                     java.lang.String identity)

removeUserIdentity

void removeUserIdentity(MParticle.IdentityType identityType)

logout

java.util.List<ReportingMessage> logout()

The mParticle SDK exposes a logout API, allowing developers to track an event when a user logs out of their app/platform. Use this opportunity to perform the appropriate logic as per your platforms logout paradigm, such as clearing user attributes.

Returns:

Kits should return a List of ReportingMessages indicating that the logout was processed one or more times, or null if it was not processed