Install Gainsight PX Flutter

For iOS

import gainsightpx

override func application(

     _ application: UIApplication,

     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?

  ) -> Bool {
        if let registrar = registrar(forPlugin: "GainsightpxFlutterPlugin") {
            SwiftGainsightpxFlutterPlugin.register(with: registrar)
        }
        ...
        return super.application(application, didFinishLaunchingWithOptions: launchOptions)
    }

Now you can run your application on Xcode.

Integrate Gainsight PX Editor 

Gainsight PX Mobile Editor helps you manage PX engagements and Product Mapper from your mobile application. 

The In-app Editor allows you to:

• Preview engagements in the mobile app
• View the Product Tree
• Create, edit and delete Module/Features 
• Add Tap Rules for Module/Features

To use the in-app editor, copy the Scheme to integrate your mobile application with the your platforms that Gainsight supports.

You can activate the editor using deep linking and forwarding the link to the SDK. While forwarding the information, you as a developer have the ability to implement your own logic and permissions before launching the editor.

The integration procedure is based on Uni Link plugin method, but supported by all deep linking plugins:

<intent-filter>
               <data android:scheme="{SCHEME}" />
               <action android:name="android.intent.action.VIEW" />
               <category android:name="android.intent.category.BROWSABLE" />
               <category android:name="android.intent.category.DEFAULT" />
</intent-filter>               

<array>
       <dict>
             <key>CFBundleTypeRole</key>
             <string>Editor</string>
             <key>CFBundleURLName</key>
             <string>{APP_BUNDLE_ID}</string>
             <key>CFBundleURLSchemes</key>
             <array>
                    <string>{SCHEME}</string>
             </array>
       </dict>
</array>                  

{
  String initialLink = await getInitialLink();
  if (initialLink != null) GainsightPX.instance.enterEditing(initialLink);
} on PlatformException {
         print('Failed to get initial link.');
} on FormatException {
         print('Failed to parse the initial link as Uri.');
}                    

getLinksStream().listen((String link) {
         if (link != null) {
                   GainsightPX.instance.enterEditing(link);
         }
}, onError: (err) {
       print('got err: $err');
});                          

Initialize 

After 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, iOS, or Windows-based mobile applications. 

To track data with Gainsight PX: 

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

import 'package:gainsightpx/gainsightpx.dart';

2. Use the following code to initialize Gainsight PX. You must use the initialization code only once in your entire application. Gainsight PX recommends using this code in the app widget so that tracking can be initialized from the first page of your application. 

  Future<void> _initialiseGainsightPX() async {
    try {
      Configurations configurations = Configurations('<#product-key#>');
      GainsightPX.instance.initialise(configurations);
    } catch (error) {
      print(error.toString());
    }
  }

Note:

All the Gainsight PX methods return a Future<dynamic>. in case of an error the type of the value will be PlatformException.

ExceptionCallback

All exceptions that occur when creating events are passed into catch as error using a Future<dynamic>. If there is an error then the returned type is PlatformException.

For example, you can make the calls using:

GainsightPX.instance.customEvent(eventName, properties)
.then((value) => {
if (value is PlatformException) {
// on Failure ...
} else {
// on Success ...
}
});

Sending Events

This section explains how to create events that can track data from your mobile application. Events are actions associated with your app and that allows you to track various actions performed by users in your app. 

Gainsight PX SDK supports four types of events.

GainsightPX.instance.screen(<#ScreenEvent-object#>[, <#properties-map#>]);

GainsightPX.instance.screenEvent(<#screen-name#>[, <#properties-map#>]);

return MaterialApp(
...
navigatorObservers: [PXRouteObserver()],
...
);

GainsightPX.instance.customEvent(<#custom_event_name#>[, <#properties-map#>]);

@override
  Widget build(BuildContext context) {
    return TouchListener (
      child: MaterialApp(
      …
      );
    );
  }

Future<void> _initialiseGainsightPX() async {
    try {
      Configurations configurations = Configurations('<#product-key#>');
      configurations.shouldTrackTapEvents = true
      GainsightPX.instance.initialise(configurations);
    } catch (error) {
      print(error.toString());
    }
  }

GainsightPX.instance.identify(<#user-id as a string#>);
GainsightPX.instance.identifyUser(<#User-object#>[, <#Account-object#>]);

User user = User("<#user_id#>");
user.email = "david@gmail.com";

final Map<String, dynamic> customAttributes = {'isOwner': true};
customAttributes['counts'] = 20;
user.customAttributes = customAttributes;

General Methods

This section describes the general methods (functions) of Gainsight PX SDK. There are three general methods:

Global Context 

You can set events with a global context after you create all the required events. 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. 

Use the following code snippet to set the global context:

GainsightPX.instance.setGlobalContext(<#properties-map#>);

Use the following code snippet to check if the key is available:

GainsightPX.instance.hasGlobalKey(<#Name of the key#>);

Use the following code snippet to remove the key:

GainsightPX.instance.removeGlobalContextKeys(<#Array Of Keys#>);

EngagementCallBack 

Gainsight PX provides the Engagement Callback feature for mobile engagements that you create for mobile applications. This feature helps in receiving a callback for all button actions and URL clicks that the end-user performs on an engagement. Once you receive the callback, you can decide your next action like helping the user to navigate to a new screen, or perform an API call and so on.

Prerequisite

Ensure that you have installed/configured the Gainsight PX Mobile SDK v1.5.1 or above.

To use the Engagement Callback feature, you need to implement the engagementCallback completion when initializing gainsightPX.

Example:

import 'package:gainsightpx/engagement_meta_data.dart';
import 'utils.dart';
 
class GlobalEngagementCallback {
 static bool onEngagementCompletion(EngagementMetaData engagementMetaData) {
   print(engagementMetaData.toString());
   if (engagementMetaData.actionType == 'link') {
     Utils.displayToast(text: engagementMetaData.toString());
   }
   return true;
 }
}
try {
   final Configurations configurations = Configurations(<##API_KEY##>)
     ..reportTrackingIssues = true
     ..shouldTrackTapEvents = true
     ..enableLogs = true;
 
   await GainsightPX.instance.initialise(
       configurations, GlobalEngagementCallback.onEngagementCompletion);
   print('GPX InitialiseWith: ${settings.host}');
 } on Exception catch (error) {
   print(error.toString());
 }