flutter_rustore_review

Documentation RuStore

• flutter_rustore_review
  • Documentation RuStore
    • Conditions for correct SDK operation
    • When to request a rating and review
    • Design recommendations
    • Preparing required parameters
    • Setting up the sample app
  • Integration into the project
  • Requesting a rating

Conditions for correct SDK operation

To ensure proper SDK functionality for ratings and reviews, the following conditions must be met:

• Android OS version 7.0 or higher.
• The RuStore application is installed on the user's device.
• The RuStoreApp version on the user's device is up-to-date.
• The user is logged into the RuStore app.

When to request a rating and review

To determine when to ask a user for an app rating and review, follow these recommendations:

• Start the flow after the user has sufficiently used your app.
• Do not run the flow too frequently — this will degrade the user experience of your app and limit the use of the rating SDK.
• Avoid using calls to action, such as a "Rate App" button — the user may have already reached the flow execution limit.
• Your app should not ask any questions before or during the flow, including opinion-based questions (e.g., "Do you like the app?") or predictive questions (e.g., "Would you give this app 5 stars?").

Design recommendations

To decide how to integrate the flow, follow these recommendations:

• Display the flow as-is, without any interference or changes to the current design, including size, opacity, shape, and other properties.
• Do not add anything over or around the flow.
• The flow must open above all layers. After starting the flow, do not close it manually. The flow will terminate automatically after explicit user action.

Preparing required parameters

To run the example, you need the following parameters:

1. applicationId - from the app you published in the RuStore console, located in your project’s build.gradle file

  android {
     defaultConfig {
     applicationId = "ru.rustore.sdk.reviewexmaple"
     }
  }

2. release.keystore - the signature with which the app published in the RuStore console was signed.

Setting up the sample app

1. Replace applicationId in the example/android/app/build.gradle file with the application ID of the APK you published in the RuStore console:

android {
  defaultConfig {
    applicationId = "ru.rustore.sdk.reviewexmaple" // Often .debug is appended in buildTypes
  }
}

2. Replace the signature with your app's signature. Configure the key_alias, key_password, and store_password parameters:

android{
  signingConfigs {
        release {
            keyAlias keystoreProperties['keyAlias']
            keyPassword keystoreProperties['keyPassword']
            storeFile keystoreProperties['storeFile'] ? file(keystoreProperties['storeFile']) : null
            storePassword keystoreProperties['storePassword']
        }
    }
}

Integration into the project

To add the package to your project, run the command:

flutter pub add flutter_rustore_review

This command will add a line to the pubspec.yaml file:

dependencies:
    flutter_rustore_review: ^10.5.0

Requesting a rating

To display a window with a rating and a review form, initialize the plugin:

RustoreReviewClient.initialize();

After initialization, you can make a request and show the form:

RustoreReviewClient.request().then((value) {
  RustoreReviewClient.review().then((value) {
    print("success review");
  }, onError: (err) {
    print("on err ${err}");
  });
});