README.md

Requirements

• Android 16+

This library is tested to support Android SDK version 16 onwards. Please let us know if you need assistance for lower Android SDK version by emailing [email protected]

Demo

View the Android demo here.

Installation

This library is distributed as Android library project so it can be included by referencing it as a library project.

Using Maven

If you use Maven, you can include this library as a dependency:

<dependency>
    <groupId>com.wootric</groupId>
    <artifactId>wootric-sdk-android</artifactId>
    <version>2.27.0</version>
</dependency>

Using Gradle

implementation 'com.wootric:wootric-sdk-android:2.27.0'

Initializing Wootric

WootricSDK task is to present a fully functional survey view with just a few lines of code.

1. Add permissions:

   Add the internet permissions to the AndroidManifest.xml file:

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

2. Add ProGuard rules:

   Add the following to your ProGuard rules:

   -keepattributes *Annotation*, Signature
   
   ##== Wootric ==
   -keep class com.wootric.** { *; }
   
   ##== Retrofit ==
   -keep class retrofit.** { *; }
   -keepclassmembernames interface * {
       @retrofit.http.* <methods>;
   }
   

3. Import the SDK's header:

   First import the SDK into your Activity of choosing:

   import com.wootric.androidsdk.Wootric;

4. Configure the SDK with your client ID and account token:

   All you need to do is to add this code to your Activity's onCreate method:

   Wootric wootric = Wootric.init(this, CLIENT_ID, ACCOUNT_TOKEN);

5. To display the survey (if user is eligible - this check is built in the method) use:

   wootric.survey();

And that's it! You're good to go and start receiving customer's feedback from your Android app.

For a working implementation of this project see the app/ folder.

Example

// Import Wootric
import com.wootric.androidsdk.Wootric;

// Inside your Activity's onCreate method

Wootric wootric = Wootric.init(this, YOUR_CLIENT_ID, YOUR_ACCOUNT_TOKEN);
wootric.setEndUserEmail("[email protected]");
// Use only for testing
wootric.setSurveyImmediately(true);
// show survey
wootric.survey();

License

The WootricSDK is released under the MIT license. See LICENSE for details.

Contribute

If you want to contribute, report a bug or request a feature, please follow CONTRIBUTING for details.