Flutter

Latest Version: 1.2.2

Below are the various processes involved in setting up Spotcheck in Flutter. Kindly refer example applications here

Installation

To install the SurveySparrowSdk, make sure you are in the root folder of your Flutter project in the terminal and run the following command.

flutter pub add surveysparrow_flutter_sdk

Initialization

Declare and initialize the spotcheck variable using the Spotcheck().

Anonymous users

If you wish not to keep track of users' data, you can follow the below syntax for initialization.

final SpotCheck spotCheck = SpotCheck(
  domainName: "<your_domain>",
  targetToken: "<target_token>",
  // Should Not Pass userDetails as const
  userDetails: {},
  variables: {},
  customProperties: {},
  sparrowLang: "ta" // Eg: ta, en, 
);

Known Users

If you wish to keep track of users' data and perform conditional Survey triggers, you can follow the below syntax for initialization.

final SpotCheck spotCheck = SpotCheck(
  domainName: "<your_domain>",
  targetToken: "<target_token>",
  // Should Not Pass userDetails as const
  userDetails: {
       email:"<user_email>",
       mobile:"<user_mobile>",
       uuid: '<uuid_value>' // Optional
  },
  variables: {
        sparrowLang: "ta" // Eg: ta, en, 
       <api_identifier_of_variable>:"<variable_value>",
  },
  customProperties: {
       <custom_property_name>: "<custom_property_value>"
  }
);

Then, add the SpotCheck initialized variable to your app screen. Add it only once in the builder of your Material App.

MaterialApp(
  <Your-Code>
  builder: (context, child) {
    return Stack(
      children: [
        child ?? const SizedBox(),
        spotCheck,
      ],
    );
  }
  <Your-Code>
  )

Screen Track

It provides the ability to keep track of screens the users are visiting and to enable the survey trigger on that screen.

Syntax:

spotCheck.trackScreen("ScreenName");

Example:

If a survey needs to be triggered on the payment page, the name of the ScreenName should be specified in the TrackScreen function.

spotCheck.trackScreen("paymentScreen");

Event Track

It provides the ability to keep track of events which when triggered, will enable the survey to be popped.

Syntax:

spotCheck.trackEvent("ScreenName", {"EventName": {}});

Example:

If a survey needs to be triggered when the user completes a payment, then the TrackEvent function should be called with the respective ScreenName and optional custom properties.

spotCheck.trackEvent("paymentScreen", {"paymentComplete": {
    "email":"[e-mail]",
    "paymentStatus":true
}});

Make sure to have the eventName configured in the Checks section of the configure panel