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.GENDER User Gender identifier
static class	PureMetrics.LOG_LEVEL Available logging levels for the SDK

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	setAppOpenExtras(java.lang.String source, java.lang.String medium, java.lang.String type, java.lang.String campaign, java.lang.String deeplink, java.util.HashMap<java.lang.String,java.lang.Object> extras) Add meta data to the session stating details of the app launch like, whether it was launched from a deep link present in a campaign, notification etc
static void	setExistingUser() Set the current user an existing user.
static void	setUserAge(int age) Set the user age
static void	setUserEmailAddress(java.lang.String emailAddress) Set user primary email id
static void	setUserGender(PureMetrics.GENDER 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	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	trackRevenue(float amount, java.lang.String currency, java.lang.String paymentMode, float discountValue, java.lang.String discountCode, float currencyConversion, java.util.HashMap<java.lang.String,java.lang.Object> attributes) Track revenue
static void	trackSessionStart() Explicitly track Session start.
static void	trackSessionStart(java.util.HashMap extras) Explicitly track Session start.
static void	trackSessionStart(java.lang.String referrer, 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 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

setAppOpenExtras

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

Add meta data to the session stating details of the app launch like, whether it was launched from a deep link present in a campaign, notification etc

Parameters:

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

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

type - Type of session like if this is from the app or a floating bubble on screen

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

trackRevenue

public static void trackRevenue(float amount,
                                java.lang.String currency,
                                java.lang.String paymentMode,
                                float discountValue,
                                java.lang.String discountCode,
                                float currencyConversion,
                                java.util.HashMap<java.lang.String,java.lang.Object> attributes)

Track revenue

Parameters:

amount - The revenue amount

currency - Currency value

paymentMode - Payment mode

discountValue - Discount amount if any

discountCode - Discount code used

currencyConversion - The currency conversion value or 1 if no conversion is required

attributes - Meta data associated with the revenue event. Example: name, product, category, location etc

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()

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

trackSessionStart

public static void trackSessionStart(java.util.HashMap 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 referrer,
                                     java.lang.String type)

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

Parameters:

referrer - The referrer for the session. This can be a notification, launcher, default

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

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

setUserAge

public static void setUserAge(int age)

Set the user age

Parameters:

age - Age of the user

setUserGender

public static void setUserGender(PureMetrics.GENDER gender)

Set user gender

Parameters:

gender - gender value. Possible values PureMetrics.GENDER.MALE and PureMetrics.GENDER.FEMALE

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