Review Documentation.

For more information, visit our website @ www.sdkbox.com

Important. Users of SDKBOX IAP pre-v1.3.7

If you have used and installed SDKBOX IAP v1.3.6 or earlier, you must either update to IAP 1.3.7 or delete the Assets/IAP directory, before adding other SDKBOX plugins.

Importing SDKBOX Review

First import the sdkbox_review unity package into your project. This will create two directories in Assets, one for review and one for sdkbox. If you have other SDKBOX plugins installed, they will appear here too. A plugins directory will also be present if you have other SDKBOX plugins. This directory contains files for iOS and Android.

To begin using Review, find the Review prefab in the Assets/SDKBOX/review directory.

Create an instance of the Review prefab in the scene where you want to use the Review package. You should only have a single instance of this prefab at any time.

Select the Review game object in the hierarchy and in your inspector pane you can configure the object to customize the Review dialog.

Configuring the Review Plugin

Description of Fields

IOS App Id

Day Limit

This specifies the number of days the app needs to wait before prompting the user to rate the app.

Launch Limit

This specifies the number of launches to wait before prompting the user to rate the app.

User Event Limit

Specifies the number of user events to wait for until prompting the user. You can tell the Review plugin when user events happen by calling Review.UserDidSignificantEvent

Day For Reminding

Specifies the number of days to wait before reminding again, once the user has pressed the 'remind me later' option.

Launch For Reminding

Specifies the number of launches to wait before reminding again, once the user has pressed the 'remind me later' option.

Try Prompt When Init

If true, will attempt to show the rate dialog when the plugin initializes, i.e. right when the app starts.

Configuring the Review Dialog

You can configure all of the text on the Review dialog, either to customize, or to localize the text.

Handling Review Events

In the Callbacks section of the Review script inspector pane, you can click + to add a subscriber, and specify the object, and method that you would like to have invoked.

Review API

void show(bool force);

void userDidSignificantEvent(bool canPromptForRating);

void setTitle(string title);

void setMessage(string message);

void setCancelButtonTitle(string cancelTitle);

void setRateButtonTitle(string rateTitle);

void setRateLaterButtonTitle(string rateLaterTitle);

Additional iOS Instructions

On some older versions of Unity, the static libraries in Review/Assets/Plugins/iOS do not get included in the XCode project. In this case they need to be moved to Assets/Plugins/iOS or added to the XCode project manually.