userorient_flutter 0.1.5

Discover what your users really want and stop building wrong features.

UserOrient SDK for Flutter

🚀 Introduction

Discover what your users really want and stop building wrong features.

UserOrient is a feature request board that helps you collect feedback from your users and prioritize what to build next.

🤓 Getting Started

🔓 Join closed-beta

Right now, UserOrient is in closed-beta. If you want to join, for which I would be very grateful, please fill out this form and I will get back to you as soon as possible.

Supposing you have been accepted, you will receive an API key which you will use to configure UserOrient.

⛓️ Add the dependency

Add the following to your pubspec.yaml file:

dependencies:
  userorient_flutter: ^0.0.3

📱 Add to your app

Before using, configure UserOrient with your API key and langauge:

import 'package:userorient_flutter/userorient_flutter.dart';

void main() {
  UserOrient.configure(
    apiKey: 'YOUR_API_KEY',
    languageCode: 'en',
  );

🎬 Show the board

Now you can show the board by calling UserOrient.showBoard(context):

import 'package:userorient_flutter/userorient_flutter.dart';

void showBoard() {
  // Call before every launch of the board
  UserOrient.setUser(
    // Any unique identifier for the user
    uniqueIdentifier: '123456',

    // User information
    fullName: 'John Doe',
    email: '[e-mail]',
    phoneNumber: '[phone]',
    language: 'en',

    // Extra dynamic information about the user
    extra: {
      'age': 30,
      'isPremium': true,
    }
  }

  // Show the board
  UserOrient.openBoard(context);
}

We recommend calling UserOrient.setUser before every launch of the board to ensure the user information is up-to-date.

📝 User identification

UserOrient takes a unique identifier (uniqueIdentifier) for each user. This identifier can be anything that uniquely identifies the user, such as an email address, phone number, or a custom ID. When not provided, UserOrient will generate a random identifier for the user.

🚪 Logging out

When the user logs out from the account on your mobile app, you must call UserOrient.clearCache() to avoid issues:

await UserOrient.clearCache();

📧 Contact

If you have any questions, feel free to reach out to us at [e-mail] or on live chat at userorient.com.