Install Gainsight PX Native-Script

ExceptionCallback

All exceptions occurred when creating events are passed into catch as error using GainsightPXCallback interface.

export interface GainsightPXCallback {
  status: GainsightPXCallbackStatus;
  methodName?: string;
  params?: object;
  exceptionMessage?: string;
}
export enum GainsightPXCallbackStatus {
  FAILURE ,
  SUCCESS
}

The properties of GainsightPXCallback are as follows:

• The status property informs if the created event is success/failure. 
• The methodName property informs about the invoked function name.
• The params object gives the event properties that are sent to create an event.
• The exceptionMessage tells about the exception that occurred.

Once you complete the download and installation of Gainsight PX, you can use it in your application to track data. The code used in this section is platform-independent and can be used in Android or iOS mobile applications. 

To track data with Gainsight PX: 

1. Insert the following import code in the header section:

import {Gainsight} from 'nativescript-gainsight-px';

2. Use the following code to initialize Gainsight PX. Gainsight PX recommends using this code in the launch of the application (`onApplication`) as shown so that tracking can be initialized as soon as the application launched.

applicationOn(launchEvent, (args: LaunchEventData) => {
    let configurations: GainsightPXConfiguration = {
        apiKey: " <API KEY> ",
        enableLogs: true
    };
    Gainsight.initialize(configurations)
        .then(() => {
            console.log("GainsightPX is initialized");
        })
        .catch((error) => {
            console.log(error.status);
            console.log(error.exceptionMessage);
        })
});

After the initialization, you can use different code snippets to track different kinds of events in your application.

Note:

All the Gainsight PX methods return a Promise<GainsightPXCallBack>

Screen Events

You can use the Screen event to track each of your screens visited by the user. The syntax to capture screen events is as follows:

Gainsight.screenevent("<#screen-name#>", "<#screen-class#>");

You can also create a screen event to just capture the name of the screen and exclude all of the other details.

Gainsight.screen("<#screen-name#>", "<#map#>");

Custom Events 

Custom Events are used to track specific actions in your app. The syntax to track custom events is:

Gainsight.customEventWithProperties(<#custom_event_name#>, <#map#>);

You can also track custom events without any properties. The syntax for this is:

Gainsight.custom(<#custom_event_name#>);

Identify Events

These events are used to identify a user or an Account uniquely. Gainsight PX provides you with the following syntax:

Gainsight.identifyUserId(<#user_id#>);
Gainsight.identifyUser(<#GainsightPXUser#>);
Gainsight.identify(<#GainsightPXUser#>, <#GainsightPXAccount#>);

The following line of code can be used to track a user: 

let user: GainsightPXUser = {
ide: this.userId,
usem: "david@gmail.com"
};

The above line of code identifies the user since you have added used the usem property to define the user. 

The list of properties supported for User tracking is given in the table below:

Property	Data type
ide	String
usem	String (Email)
userHash	String
gender	String
lastName	String
firstName	String
signUpDate	Date
title	String
role	String
subscriptionId	String
phone	String
countryCode	String
countryName	String
stateCode	String
stateName	String
city	String
street	String
continent	String
postalCode	String
regionName	String
timezone	String
longitude	Double
latitude	Double
organization	String
organizationEmployees	String
organizationRevenue	String
organizationIndustry	String
organizationSicCode	String
organizationDuns	Int
accountID	String
firstVisitDate	Date
score	Int
sfdcContactId	String
customAttributes	Map<String, Any>

The list of Attributes for Account Object are given in the table below:

Property	Data Type
name	String
trackedSubscriptionId	String
industry	String
numberOfEmployees	int
sicCode	String
website	String
naicsCode	String
plan	String
countryCode	String
countryName	String
stateCode	String
stateName	String
city	String
street	String
continent	String
postalCode	String
regionName	String
timezone	String
latitude	Double
longitude	Double
sfdcId	String
customAttributes	Map<String, Any>

Set Global Context 

Once you create all the required events, you can set events with a global context. You can set a global context with key-value pairs and send it with the payload. Global context can be set on 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:

Gainsight.setGlobalContext(<#[String: GlobalContextValue]#>);

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

Gainsight.hasGlobalContextKey(<#Name of the key#>)

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

Gainsight.removeGlobalContextKeys(<#Array Of Keys#>)