Install Gainsight PX SDK for Android

Quick Start

You can modify the default settings, to match your specific requirements.

To use the custom setting:

1. Create a subclass of the Android Application class.
2. Declare the subclass in the Android.Manifest file. 
3. Override the onCreate method to start an instance of GainsightPX.Builder, by using the following code.

GainsightPX.Builder builder = new GainsightPX.Builder(Context context, String YOUR_PRODUCT_ID);

4. Configure the Builder with the required custom configurations.
5. Call the Builder.build function to create a new instance of Gainsight PX, by using the following code.

GainsightPX instance = builder.build();

6. Setup Gainsight PX as a singleton instance, by using the following code.

GainsightPX.setSingletonInstance(instance);

IMPORTANT: 

• You can call the above function only once and you cannot reset it.
• You must call the GainsightPX.with(Context), to start collecting data from your application. 

App Events 

App events track general operations performed on your application. App events do not require any configurations. The Gainsight SDK auto collects App events from your application. However, if you disable the App events collection, these events are not collected. The app events collected are as follows:

Gainsight PX is also looking to launch two additional app events in the future; APP_BACKGROUNDED and APP_CRASHED. The former tracks every instance of your application running in the background and the latter tracks every instance of an app crash. However, these events are not auto-enabled, and have to be configured.

Screen Events

Screen events track various screens of your application, traversed by a user. By default, Gainsight PX tracks the screens of your application visited by users (if the user moves from the first screen to the second screen and then returns to the first screen, it is tracked automatically). However, in some situations, you need to explicitly register screen views. To help you in such situations, Gainsight PX has the following functions with PUBLIC access specifier:

GainsightPX.with(Context).screen(@NonNull String screenName);

You can also create a screen event with additional properties (for example, parameters created for starting the page), as a map, by using the following code. 

GainsightPX.with(Context).screen(@NonNull String screenName, @Nullable final Map properties);

You can also create a screen event with fully loaded details like screen class, information from the intent that created the activity and so on. To accomplish this, use the following code.

GainsightPX.with(Context).screen(@NonNull final ScreenEventData eventData);

Screen name is a mandatory argument to use any of the above functions.

Identify Events

These events are used to identify a user uniquely. Gainsight PX SDK provides you with three functions to identify users.

GainsightPX.with(Context).identify(@NonNull String userId);
GainsightPX.with(Context).identify(@NonNull User user);
GainsightPX.with(Context).identify(@NonNull User user, final @Nullable Account account);

User ID is a mandatory argument to use any of the above functions. You can also use the User and Account objects to uniquely identify users. While creating either the User or the Account object, you must provide an ID. You can add more attributes to user information. There are setter methods for common attributes. However, you can add custom attributes using the following code:

user.putCustomAttributes(Map customAttributes);
account.putCustomAttributes(Map customAttributes);

Custom Events

Custom Events are used to track specific events on your app. Currently, every button click is also tracked as a custom event. However, in future releases, button clicks will be tracked automatically. The functions of custom events are:

GainsightPX.with(Context).custom(@NonNull String event);
GainsightPX.with(Context).custom(final @NonNull String event, final @Nullable Map properties);

Event Name is a mandatory argument. You can also add event properties to track further details of the event that occurred.

Global Context 

A global context can be set on the variables. You can set a global context with key-value pairs and send it with the payload. Global context can be set with Date, String, Double, and Boolean data types. Global Context data is stored at the memory level and not disk-level. The key-value pairs are sent with the Payloads. If an application is terminated, all the key-value pairs are erased. 

The following code snippet can be used to set the global context data fields: 

globalContextData = new GlobalContextData();
globalContextData.putString(key, stringValue);
globalContextData.putNumber(key, longValue);
globalContextData.putNumber(key, intValue);
globalContextData.putNumber(key, doubleValue);
globalContextData.putBoolean(key, booleanValue);
globalContextData.putDate(key, dateObject);
globalContextData.putDate(key, <#[String object with ISO8601 format]#>);
globalContextData.putDate(key, <#[long for unix time in millisec]#>);

The following code snippet can be used to set the global context data fields:

GainsightPX.with(Context).setGlobalContext(globalContextData);

The following code snippet can be used to check if the key is available:

if ((GainsightPX.with(Context).getGlobalContext() != null) && (GainsightPX.with(Context).getGlobalContext().hasKey("key"))) {}

The following code snippet can be used to remove the key from the global context:

GainsightPX.with(Context).getGlobalContext().removeKey("key"{, "key2"...});