surveysparrow-ionic-plugin

SurveySparrow SDK enables you to collect feedback from your mobile app. Embed the Classic, Chat & NPS surveys in your Ionic application seamlessly with few lines of code.

Install

npm install surveysparrow-ionic-plugin
npx cap sync

Permissions Required

To use this plugin, ensure the following permissions are added to your app:

Android

Add this in your root build.gradle at the end of repositories:

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Add these permissions to your AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

iOS

Add the necessary permissions to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>We need camera access to capture photos and videos.</string>
<key>NSMicrophoneUsageDescription</key>
<string>We need microphone access to record audio.</string>

General Note

Based on the survey type being used, ensure the necessary permissions (e.g., for photos, videos, audio, or storage) are added to your app's configuration.

API

loadFullScreenSurvey(...)

loadFullScreenSurveyWithValidation(...)

loadFullScreenSurvey(...)

loadFullScreenSurvey(options: { domain: String; token: String; params: Object; properties: Object; }) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | options | { domain: String; token: String; params: Object; properties: Object; } |

loadFullScreenSurveyWithValidation(...)

loadFullScreenSurveyWithValidation(options: { domain: String; token: String; params: Object; properties: Object; }) => Promise<void>

| Param | Type | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | options | { domain: String; token: String; params: Object; properties: Object; } |

Validations

Validations include Limit Submission Per User and Survey Throttling.

To achieve this, the emailaddress of the user must be passed in the params object.

Params

The params object allows passing survey variables, which can be accessed in the survey's end-user interface. Ensure that the spelling of survey variables matches the configured values. Additionally, make sure to include the emailaddress field for validations.

Properties

The properties object includes the following parameters:

1. isCloseButtonEnabled (default: true)

   • If set to false, the close button will be removed.
   • Note: Disabling this option will also disable the survey validation.

2. langCode (default: en)

   • To load the survey in a specific language, pass the corresponding language code.
   • Ensure that the language is configured in the SurveySparrow app.
   • A list of supported language codes can be found here.

Support

For questions or issues, contact us at [email protected].