io.puremetrics.sdk

Class PureMetrics

java.lang.Object

io.puremetrics.sdk.PureMetrics

public final class PureMetrics
extends java.lang.Object

A helper class to interface with PureMetrics

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PureMetrics.Builder A Builder class for PureMetrics.
static class	PureMetrics.FailedTransaction A Class that represents a single complete transaction
static class	PureMetrics.LOG_LEVEL Available logging levels for the SDK
static class	PureMetrics.Order A Class that represents a single complete Order
static class	PureMetrics.Revenue A Class that represents a single complete transaction

Method Summary

Modifier and Type	Method and Description
static boolean	isActivityInForground() Check to see if the app is running in foreground or background
static void	resetUserInfo() To be called when a user signs out.
static void	setExistingUser() Set the current user an existing user.
static void	setUserBirthDate(java.util.Date birthDate) Set User Birthdate
static void	setUserEmailAddress(java.lang.String emailAddress) Set user primary email id
static void	setUserGender(java.lang.String gender) Set user gender
static void	setUserId(java.lang.String userId) Set user User Id.
static void	setUserName(java.lang.String firstName, java.lang.String lastName) Set the user name
static void	setUserPhoneNumber(java.lang.String phoneNumber) Set User phone number
static void	trackCrash(java.util.HashMap<java.lang.String,java.lang.Object> meta) To be called from a Crash listener like the one in CrashlyticsListener#crashlyticsDidDetectCrashDuringPreviousExecution
static void	trackDeeplinkAttribution(java.lang.String source, java.lang.String medium, java.lang.String campaign, java.lang.String deeplink, java.util.HashMap<java.lang.String,java.lang.Object> extras) Track Deeplink attribution for app open or install
static void	trackDeviceProperties(java.lang.String deviceProperty, boolean propertyValue) Track a device property/trait.
static void	trackDeviceProperties(java.lang.String deviceProperty, double propertyValue) Track a device property/trait.
static void	trackDeviceProperties(java.lang.String deviceProperty, int propertyValue) Track a device property/trait.
static void	trackDeviceProperties(java.lang.String deviceProperty, java.lang.String propertyValue) Track a user property/trait.
static void	trackEvent(java.lang.String eventName, java.util.HashMap attributes) Track an event and its associated event attribute.
static void	trackSessionStart(java.util.HashMap<java.lang.String,java.lang.Object> extras) Explicitly track Session start.
static void	trackSessionStart(java.lang.String type) Explicitly track Session start.
static void	trackUserProperties(java.lang.String userProperty, boolean propertyValue) Track a user property/trait.
static void	trackUserProperties(java.lang.String userProperty, double propertyValue) Track a user property/trait.
static void	trackUserProperties(java.lang.String userProperty, int propertyValue) Track a user property/trait.
static void	trackUserProperties(java.lang.String userProperty, java.lang.String propertyValue) Track a user property/trait.
static void	transactionFailed(PureMetrics.FailedTransaction transaction) Track a failed transaction
static void	transactionStarted(PureMetrics.Order order) Track start of a transaction
static void	transactionSuccessful(PureMetrics.Revenue revenue) Track start of a transaction
static PureMetrics.Builder	withBuilder() Helper method to get an instance of the PureMetrics.Builder to configure the SDK

Methods inherited from class java.lang.Object

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

Method Detail

trackDeeplinkAttribution

public static void trackDeeplinkAttribution(java.lang.String source,
                                            java.lang.String medium,
                                            java.lang.String campaign,
                                            java.lang.String deeplink,
                                            java.util.HashMap<java.lang.String,java.lang.Object> extras)

Track Deeplink attribution for app open or install

Parameters:

source - Source of any campaign if the app was opened from a campaign

medium - Medium of the campaign: email/notification/ads

campaign - Campaign name if any

deeplink - Deeplink of the app launch if it was launched from a deeplink

extras - HashMap of meta data related to app start. These are custom extras

withBuilder

public static PureMetrics.Builder withBuilder()

Helper method to get an instance of the PureMetrics.Builder to configure the SDK

Returns:

an instance of the PureMetrics.Builder class

isActivityInForground

public static boolean isActivityInForground()

Check to see if the app is running in foreground or background

Returns:

true if the application is in foreground else returns false

resetUserInfo

public static void resetUserInfo()

To be called when a user signs out. This moves the user back to an anonymous state.

trackEvent

public static void trackEvent(java.lang.String eventName,
                              java.util.HashMap attributes)

Track an event and its associated event attribute. Event attributes are additional information which define an event

Parameters:

eventName - The name of the event

attributes - A HashMap of the event attributes

trackCrash

public static void trackCrash(java.util.HashMap<java.lang.String,java.lang.Object> meta)

To be called from a Crash listener like the one in CrashlyticsListener#crashlyticsDidDetectCrashDuringPreviousExecution

Parameters:

meta - any additional metadata that you would like to track.

trackUserProperties

public static void trackUserProperties(java.lang.String userProperty,
                                       java.lang.String propertyValue)

Track a user property/trait. These are user level identifiers

Parameters:

userProperty - Name of the user property

propertyValue - String Value associated with the user property

trackUserProperties

public static void trackUserProperties(java.lang.String userProperty,
                                       int propertyValue)

Track a user property/trait. These are user level identifiers

Parameters:

userProperty - Name of the user property

propertyValue - int Value associated with the user property

trackUserProperties

public static void trackUserProperties(java.lang.String userProperty,
                                       double propertyValue)

Track a user property/trait. These are user level identifiers

Parameters:

userProperty - Name of the user property

propertyValue - double Value associated with the user property

trackUserProperties

public static void trackUserProperties(java.lang.String userProperty,
                                       boolean propertyValue)

Track a user property/trait. These are user level identifiers

Parameters:

userProperty - Name of the user property

propertyValue - boolean Value associated with the user property

trackDeviceProperties

public static void trackDeviceProperties(java.lang.String deviceProperty,
                                         java.lang.String propertyValue)

Track a user property/trait. These are user level identifiers

Parameters:

deviceProperty - Name of the device property

propertyValue - String Value associated with the user property

trackDeviceProperties

public static void trackDeviceProperties(java.lang.String deviceProperty,
                                         int propertyValue)

Track a device property/trait. These are user level identifiers

Parameters:

deviceProperty - Name of the device property

propertyValue - Integer Value associated with the user property

trackDeviceProperties

public static void trackDeviceProperties(java.lang.String deviceProperty,
                                         double propertyValue)

Track a device property/trait. These are user level identifiers

Parameters:

deviceProperty - Name of the device property

propertyValue - Double Value associated with the user property

trackDeviceProperties

public static void trackDeviceProperties(java.lang.String deviceProperty,
                                         boolean propertyValue)

Track a device property/trait. These are user level identifiers

Parameters:

deviceProperty - Name of the device property

propertyValue - Boolean Value associated with the user property

trackSessionStart

public static void trackSessionStart(java.util.HashMap<java.lang.String,java.lang.Object> extras)

Explicitly track Session start. Call this only when you have set PureMetrics.Builder.disableAutoTracking(boolean) as true

Parameters:

extras - An extras which need to be tracked which gives more insight regarding the source of launch

trackSessionStart

public static void trackSessionStart(java.lang.String type)

Explicitly track Session start. Call this only when you have set PureMetrics.Builder.disableAutoTracking(boolean) as true

Parameters:

type - The type of usage, like within app, external etc.

transactionStarted

public static void transactionStarted(PureMetrics.Order order)

Track start of a transaction

Parameters:

order - The PureMetrics.Order for which the transaction started

transactionSuccessful

public static void transactionSuccessful(PureMetrics.Revenue revenue)

Track start of a transaction

Parameters:

revenue - The PureMetrics.Revenue generated from a successful transaction

transactionFailed

public static void transactionFailed(PureMetrics.FailedTransaction transaction)

Track a failed transaction

Parameters:

transaction - A populated PureMetrics.FailedTransaction object

setExistingUser

public static void setExistingUser()

Set the current user an existing user.

setUserName

public static void setUserName(java.lang.String firstName,
                               java.lang.String lastName)

Set the user name

Parameters:

firstName - First Name of the user

lastName - Last Name of the user

setUserBirthDate

public static void setUserBirthDate(java.util.Date birthDate)

Set User Birthdate

Parameters:

birthDate - Set User Birthdate

setUserGender

public static void setUserGender(java.lang.String gender)

Set user gender

Parameters:

gender - gender value.

setUserId

public static void setUserId(java.lang.String userId)

Set user User Id. This is the ID using which the user can be uniquely identified on your system

Parameters:

userId - The user id of the user

setUserEmailAddress

public static void setUserEmailAddress(java.lang.String emailAddress)

Set user primary email id

Parameters:

emailAddress - The primary email address of the user

setUserPhoneNumber

public static void setUserPhoneNumber(java.lang.String phoneNumber)

Set User phone number

Parameters:

phoneNumber - The phone number of the user