Plugin.XamarinAppRating 1.2.2

Plugin.XamarinAppRating

Plugin.XamarinAppRating gives developers a fast and easy way to ask users to rate the app in the stores.

Installation

Plugin.XamarinAppRating is available via NuGet, grab the latest package and install it in your solution:

Install-Package Plugin.XamarinAppRating

Platforms supported

Version 1.2.2

New Features

• Added support to macOS and tvOS ❗
• Bug fixes and improvement.

API Usage

Call CrossAppRating.Current from any project to gain access to the APIs.

There are two main methods, PerformInAppRateAsync and PerformRatingOnStoreAsync.

Android

/// <summary>
/// Perform rating without leaving the app.
/// </summary>
public Task PerformInAppRateAsync();

This method will open an in-app review dialog, using the packageName declared on the AndroidManifest file.

/// <summary>
/// Perform rating on the current OS store app or open the store page on browser.
/// </summary>
public Task PerformRatingOnStoreAsync()

This method will open Google Play app on the store page of your current application. Otherwise, it will try to open the store page on the browser.

If neither the store page nor the browser store page works, it will display an alert announcing the error.

packageName must be provided as a named argument to open the store page on the store app or browser.

Example

if (CrossAppRating.IsSupported)
    await CrossAppRating.Current.PerformRatingOnStoreAsync(packageName: "com.facebook.katana");

iOS / macOS / tvOS

/// <summary>
/// Perform rating without leaving the app.
/// </summary>
public Task PerformInAppRateAsync();

For iOS: if the device's current OS version is 10.3 or newer, this method will raise an in-app review popup of your current application, otherwise, it will display an alert announcing that it's not supported.

/// <summary>
/// Perform rating on the current OS store app or open the store page on browser.
/// </summary>
public Task PerformRatingOnStoreAsync()

This method will open App Store app on the store page of your current application. Otherwise, it will try to open the store page on the browser.

If the method fails, it will display an alert announcing the error.

applicationId property is the StoreId of your app and it must be provided as a named argument to open the store page on the store app or browser.

Example

if (CrossAppRating.IsSupported)
    await CrossAppRating.Current.PerformRatingOnStoreAsync(applicationId: "id284882215");

UWP

/// <summary>
/// Perform rating without leaving the app.
/// </summary>
public Task PerformInAppRateAsync();

If the target version build is 17763 or above, this method will raise an in-app review dialog of your current application, otherwise, it will display an alert announcing that it's not supported.

/// <summary>
/// Perform rating on the current OS store app or open the store page on browser.
/// </summary>
public Task PerformRatingOnStoreAsync()

This method will open Microsoft Store application with the page of your current app.

If the method fails it will display an alert announcing the error.

productId is the ProductId of your UWP app and it must be provided as a named argument to open the store page app.

Example

if (CrossAppRating.IsSupported)
    await CrossAppRating.Current.PerformRatingOnStoreAsync(productId: "9wzdncrf0083");

Usage

⚠️ Warning - You should be careful about how and when you ask users to rate your app, there may be penalties from stores. As for advice, I recommend using a counter on the app start and storage that count, then when the counter reaches a certain number, display a dialog asking the users if they want to rate the app, if they decline the offer, reset the counter to ask them later, also leave the option to do it themselves.

public partial class MainPage : ContentPage
{
    private const string androidPackageName = "com.facebook.katana";
    private const string iOSApplicationId = "id284882215";
    private const string uwpProductId = "9wzdncrf0083";

    public MainPage()
    {
        InitializeComponent();

        if (!Preferences.Get("application_rated", false))
            Task.Run(() => CheckAppCountAndRate());
    }

    private async Task CheckAppCountAndRate()
    {
        if (Preferences.Get("application_counter", 0) >= 5)
        {
            if (!await DisplayAlert("Rate this App!", "Are you enjoying the app so far? Would you like to leave a review in the store?", "Yes", "No"))
            {
                Preferences.Set("application_counter", 0);

                return;
            }

            await RateApplicationInApp();
        }
    }

    private Task RateApplicationInApp()
    {
        if (CrossAppRating.IsSupported)
        {
            Device.BeginInvokeOnMainThread(async () =>
            {
                // This method will simulate Facebook™ app to in-app rating as example.
                await CrossAppRating.Current.PerformInAppRateAsync();
            });

            Preferences.Set("application_rated", true);
        }

        return Task.CompletedTask;
    }

    private Task RateApplicationOnStore()
    {
        if (CrossAppRating.IsSupported)
        {
            Device.BeginInvokeOnMainThread(async () =>
            {
                // This method use Facebook™'s store apps as example.
                await CrossAppRating.Current.PerformRatingOnStoreAsync(packageName: androidPackageName, applicationId: iOSApplicationId, productId: uwpProductId);
            });

            Preferences.Set("application_rated", true);
        }

        return Task.CompletedTask;
    }

    private void InAppRating_Clicked(object sender, EventArgs e)
    {
        if (!Preferences.Get("application_rated", false))
            Task.Run(() => RateApplicationInApp());
    }

    private void AppRateOnStore_Clicked(object sender, EventArgs e)
    {
        if (!Preferences.Get("application_rated", false))
            Task.Run(() => RateApplicationOnStore());
    }
}

Samples

Take a look at the TestApp sample for Xamarin.Forms or TestAppNative sample for Xamarin native fully detailed implementation of this plugin.

Contributions

Please, feel free to open an Issue if you found any bugs or submit a PR.

License

XamarinAppRating is licensed under MIT.