Install Gainsight PX Native-Script

ExceptionCallback

This section explains how to get exceptions if occurred in the SDK. All the Gainsight PX methods return a Promise<GainsightPXCallBack>. The exceptions are passed into catch as errors using GainsightPXCallback interface.

The properties of GainsightPXCallback are as follows:

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

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 informs about the exception that occurred.

Screen Events

This section explains how to create events that can track data from your mobile application. Events are actions associated with your app and allow you to track various actions performed by users in your app. Currently, the Gainsight PX SDK supports four types of 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:

GainsightPX.getInstance().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.

GainsightPX.getInstance().screen("<#screen-name#>", "<#map#>")

Custom Events 

Custom Events are used to track specific actions in your app.

The syntax to track custom events is:

GainsightPX.getInstance().customEventWithProperties(<#custom_event_name#>, <#map#>);

You can also track custom events without any properties.

The syntax for this is:

GainsightPX.getInstance().customEvent(<#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:

GainsightPX.getInstance().identifyWithUserId(<#user_id#>)
GainsightPX.getInstance().identify(<#user#>, <#account#>)

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

var user = new PXUser("<#user_id#>")
user.usem = "david@gmail.com"

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

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

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 them 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:

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

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

GainsightPX.getInstance().hasGlobalContextKey(<#Name of the key#>)

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

GainsightPX.getInstance().removeGlobalContextKeys(<#Array Of Keys#>)