Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.vorlonsoft.android.rate.AppRate Maven / Gradle / Ivy
Library to help you promote your Android app by prompting users to rate the app after using it for a few days.
/*
* Copyright 2017 - 2018 Vorlonsoft LLC
*
* Licensed under The MIT License (MIT)
*/
package com.vorlonsoft.android.rate;
import android.annotation.SuppressLint;
import android.app.Activity;
import android.app.AlertDialog;
import android.app.Dialog;
import android.content.Context;
import android.content.Intent;
import android.os.Build;
import android.util.ArrayMap;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import java.lang.ref.WeakReference;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import static com.vorlonsoft.android.rate.Constants.Utils.TAG;
import static com.vorlonsoft.android.rate.PreferenceHelper.get365DayPeriodDialogLaunchTimes;
import static com.vorlonsoft.android.rate.PreferenceHelper.getCustomEventCount;
import static com.vorlonsoft.android.rate.PreferenceHelper.getInstallDate;
import static com.vorlonsoft.android.rate.PreferenceHelper.getIsAgreeShowDialog;
import static com.vorlonsoft.android.rate.PreferenceHelper.getLaunchTimes;
import static com.vorlonsoft.android.rate.PreferenceHelper.getRemindInterval;
import static com.vorlonsoft.android.rate.PreferenceHelper.getRemindLaunchesNumber;
import static com.vorlonsoft.android.rate.PreferenceHelper.getVersionCode;
import static com.vorlonsoft.android.rate.PreferenceHelper.getVersionName;
import static com.vorlonsoft.android.rate.PreferenceHelper.isFirstLaunch;
import static com.vorlonsoft.android.rate.PreferenceHelper.setCustomEventCount;
import static com.vorlonsoft.android.rate.PreferenceHelper.setFirstLaunchSharedPreferences;
import static com.vorlonsoft.android.rate.PreferenceHelper.setIsAgreeShowDialog;
import static com.vorlonsoft.android.rate.PreferenceHelper.setVersionCode;
import static com.vorlonsoft.android.rate.PreferenceHelper.setVersionName;
import static com.vorlonsoft.android.rate.StoreType.AMAZON;
import static com.vorlonsoft.android.rate.StoreType.APPLE;
import static com.vorlonsoft.android.rate.StoreType.BLACKBERRY;
import static com.vorlonsoft.android.rate.StoreType.INTENT;
import static com.vorlonsoft.android.rate.StoreType.OTHER;
import static com.vorlonsoft.android.rate.StoreType.YANDEX;
/**
* AppRate Class - main class of the AndroidRate library, thread-safe
* and a fast singleton implementation.
*
* @since 0.0.4
* @version 1.2.1
* @author Alexander Savin
* @author Shintaro Katafuchi
*/
public final class AppRate {
/** The {@link AppRate} singleton object.
*/
@SuppressLint("StaticFieldLeak")
private static volatile AppRate singleton = null;
private final Map customEventsCounts;
private final Context context;
private final DialogOptions dialogOptions = new DialogOptions();
private final StoreOptions storeOptions = new StoreOptions();
private boolean isDebug = false;
private boolean isVersionCodeCheck = false;
private boolean isVersionNameCheck = false;
private long installDate = Time.DAY * 10L;
private byte appLaunchTimes = (byte) 10;
private long remindInterval = Time.DAY;
private byte remindLaunchesNumber = (byte) 0;
private byte selectedAppLaunches = (byte) 1;
/** Short.MAX_VALUE means unlimited occurrences of the display of the dialog within a 365-day period */
private short dialogLaunchTimes = Short.MAX_VALUE;
private WeakReference dialog = null;
private DialogManager.Factory dialogManagerFactory = new DefaultDialogManager.Factory();
{
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
customEventsCounts = new ArrayMap<>();
} else {
customEventsCounts = new HashMap<>();
}
}
private AppRate(final Context context) {
this.context = context.getApplicationContext();
}
public static AppRate with(final Context context) {
if (singleton == null) {
synchronized (AppRate.class) {
if (singleton == null) {
singleton = new AppRate(context);
}
}
}
return singleton;
}
/**
* Shows the Rate Dialog when conditions are met.
* Call this method at the end of your onCreate() method to determine whether
* to show the rate dialog or not. It will check if the conditions are met and
* show rate dialog if yes.
*
* @param activity your activity, use "this" in most cases
*/
@SuppressWarnings("UnusedReturnValue")
public static boolean showRateDialogIfMeetsConditions(Activity activity) {
boolean isMeetsConditions = ((singleton != null) && (singleton.isDebug() || singleton.shouldShowRateDialog()));
if (isMeetsConditions) {
singleton.showRateDialog(activity);
}
return isMeetsConditions;
}
private boolean isOverDate(long targetDate, long threshold) {
return new Date().getTime() - targetDate >= threshold;
}
private boolean isBelow365DayPeriodMaxNumberDialogLaunchTimes() {
return ((dialogLaunchTimes == Short.MAX_VALUE) || (get365DayPeriodDialogLaunchTimes(context) < dialogLaunchTimes));
}
/**
* Clears weak reference dialog object. Invoking this method will not cause this
* object to be enqueued.
*
* This method is invoked only by Java code; when the garbage collector
* clears references it does so directly, without invoking this method.
*/
void clearRateDialog() {
if (dialog != null) {
dialog.clear();
}
}
/**
* Sets the max number of occurrences of the display of the Rate Dialog within a 365-day
* period.
*
* @param dialogLaunchTimes the max number of the display of the Rate Dialog within a 365-day
* period, default is {@code Short.MAX_VALUE}, {@code Short.MAX_VALUE}
* means unlimited occurrences
* @return the {@link AppRate} singleton object
*/
@SuppressWarnings({"unused"})
public AppRate set365DayPeriodMaxNumberDialogLaunchTimes(short dialogLaunchTimes) {
this.dialogLaunchTimes = dialogLaunchTimes;
return this;
}
/**
* Sets the minimum number of launches until the rating dialog pops up for
* the first time.
*
* @param appLaunchTimes number of launches, default is 10, 3 means app is launched 3 or
* more times
* @return the {@link AppRate} singleton object
*/
public AppRate setLaunchTimes(@SuppressWarnings("SameParameterValue") byte appLaunchTimes) {
this.appLaunchTimes = appLaunchTimes;
return this;
}
/**
* Sets the minimal number of days until the Rating Dialog pops up for the first time.
*
* @param installDate number of days, default is 10, 0 means install day, 10 means app is
* launched 10 or more days later than installation
* @return the {@link AppRate} singleton object
* @see #setTimeToWait(long, short)
*/
@SuppressWarnings({"WeakerAccess", "unused"})
public AppRate setInstallDays(byte installDate) {
return setTimeToWait(Time.DAY, installDate);
}
/**
* Sets the minimal number of time units until the Rating Dialog pops up for the first time.
* Default is 10 {@link Time#DAY days}, 0 means install millisecond, 10 means app is launched
* 10 or more time units later than installation.
*
* @param timeUnit one of the values defined by {@link Time.TimeUnits}
* @param timeUnitsNumber time units number
* @return the {@link AppRate} singleton object
* @see #setInstallDays(byte)
* @see Time.TimeUnits
*/
@SuppressWarnings("WeakerAccess")
public AppRate setTimeToWait(@Time.TimeUnits long timeUnit, short timeUnitsNumber) {
this.installDate = timeUnit * timeUnitsNumber;
return this;
}
/**
* Sets the minimal number of days until the Rating Dialog pops up for the next time after
* neutral button clicked.
*
* @param remindInterval number of days, default is 1, 1 means app is launched 1 or more days
* after neutral button clicked
* @return the {@link AppRate} singleton object
* @see #setRemindTimeToWait(long, short)
*/
@SuppressWarnings({"WeakerAccess", "unused"})
public AppRate setRemindInterval(byte remindInterval) {
return setRemindTimeToWait(Time.DAY, remindInterval);
}
/**
* Sets the minimal number of time units until the Rating Dialog pops up for the next time
* after neutral button clicked.
* Default is 1 {@link Time#DAY day}, 1 means app is launched 1 or more time units after
* neutral button clicked.
*
* @param timeUnit one of the values defined by {@link Time.TimeUnits}
* @param timeUnitsNumber time units number
* @return the {@link AppRate} singleton object
* @see #setRemindInterval(byte)
* @see Time.TimeUnits
*/
@SuppressWarnings("WeakerAccess")
public AppRate setRemindTimeToWait(@Time.TimeUnits long timeUnit, short timeUnitsNumber) {
this.remindInterval = timeUnit * timeUnitsNumber;
return this;
}
/**
* Sets the minimal number of app's launches after neutral button clicked until the Rating
* Dialog pops up next time.
*
* @param remindLaunchesNumber number of app launches, default is 0, 1 means app is launched 1
* or more times after neutral button clicked
* @return the {@link AppRate} singleton object
*/
public AppRate setRemindLaunchesNumber(@SuppressWarnings("SameParameterValue") byte remindLaunchesNumber) {
this.remindLaunchesNumber = remindLaunchesNumber;
return this;
}
/**
* Clears shared preferences that were set up by clicking the Remind Button.
*
* @return the {@link AppRate} singleton object
*/
@SuppressWarnings("unused")
public AppRate clearRemindButtonClick() {
PreferenceHelper.clearRemindButtonClick(context);
return this;
}
@SuppressWarnings("unused")
public AppRate setMinimumEventCount(String eventName, short minimumCount) {
this.customEventsCounts.put(eventName, minimumCount);
return this;
}
/**
* Selects App launches.
* Method sets divisor for division of app launches with a remainder. This condition is
* satisfied if {@code appLaunches % divisorAppLaunches == 0}
*
* @param selectedAppLaunches default is 1, 1 means each launch, 2 means every 2nd launch,
* 3 means every 3rd launch, etc
* @return the {@link AppRate} singleton object
* @since 1.2.0
*/
public AppRate setSelectedAppLaunches(@SuppressWarnings("SameParameterValue") byte selectedAppLaunches) {
this.selectedAppLaunches = selectedAppLaunches;
return this;
}
/**
* Selects App launches.
* Method sets divisor for division of app launches with a remainder. This condition is
* satisfied if {@code appLaunches % divisorAppLaunches == 0}
*
* @param selectedAppLaunches default is 1, 1 means each launch, 2 means every 2nd launch,
* 3 means every 3rd launch, etc
* @return the {@link AppRate} singleton object
* @deprecated since 1.2.0, use {@link #setSelectedAppLaunches(byte)} with the same {@code param} instead
* @see #setSelectedAppLaunches(byte)
*/
public AppRate setRemindLaunchTimes(@SuppressWarnings("SameParameterValue") byte selectedAppLaunches) {
return setSelectedAppLaunches(selectedAppLaunches);
}
/**
* Decides whether the Neutral button ("Remind me later") appears in the Rating Dialog or
* not.
*
* @param isShowNeutralButton default is true, true means to show the Neutral button
* @return the {@link AppRate} singleton object
*/
public AppRate setShowLaterButton(@SuppressWarnings("SameParameterValue") boolean isShowNeutralButton) {
dialogOptions.setShowNeutralButton(isShowNeutralButton);
return this;
}
/**
* Decides if Never button appear in the rating dialog or not
*
* @param isShowNeverButton default is true
* @return the {@link AppRate} singleton object
*/
@SuppressWarnings("unused")
public AppRate setShowNeverButton(boolean isShowNeverButton) {
dialogOptions.setShowNegativeButton(isShowNeverButton);
return this;
}
@SuppressWarnings("unused")
public AppRate setShowTitle(boolean isShowTitle) {
dialogOptions.setShowTitle(isShowTitle);
return this;
}
@SuppressWarnings("unused")
public AppRate clearAgreeShowDialog() {
setIsAgreeShowDialog(context, true);
return this;
}
@SuppressWarnings("unused")
public AppRate clearSettingsParam() {
PreferenceHelper.clearSharedPreferences(context);
return this;
}
@SuppressWarnings("unused")
public AppRate setAgreeShowDialog(boolean isAgree) {
setIsAgreeShowDialog(context, isAgree);
return this;
}
@SuppressWarnings("unused")
public AppRate setView(View view) {
dialogOptions.setView(view);
return this;
}
/**
* Specifies the callback when the button of Rate Dialog is pressed.
*
* @param listener implemented {@link OnClickButtonListener} Interface
* @return the {@link AppRate} singleton object
*/
public AppRate setOnClickButtonListener(OnClickButtonListener listener) {
dialogOptions.setListener(listener);
return this;
}
@SuppressWarnings("unused")
public AppRate setTitle(@SuppressWarnings("SameParameterValue") int resourceId) {
dialogOptions.setTitleResId(resourceId);
return this;
}
@SuppressWarnings("unused")
public AppRate setTitle(String title) {
dialogOptions.setTitleText(title);
return this;
}
@SuppressWarnings("unused")
public AppRate setMessage(int resourceId) {
dialogOptions.setMessageResId(resourceId);
return this;
}
@SuppressWarnings("unused")
public AppRate setMessage(String message) {
dialogOptions.setMessageText(message);
return this;
}
@SuppressWarnings("unused")
public AppRate setTextRateNow(@SuppressWarnings("SameParameterValue") int resourceId) {
dialogOptions.setTextPositiveResId(resourceId);
return this;
}
@SuppressWarnings("unused")
public AppRate setTextRateNow(String positiveText) {
dialogOptions.setPositiveText(positiveText);
return this;
}
@SuppressWarnings("unused")
public AppRate setTextLater(@SuppressWarnings("SameParameterValue") int resourceId) {
dialogOptions.setTextNeutralResId(resourceId);
return this;
}
@SuppressWarnings("unused")
public AppRate setTextLater(String neutralText) {
dialogOptions.setNeutralText(neutralText);
return this;
}
@SuppressWarnings("unused")
public AppRate setTextNever(@SuppressWarnings("SameParameterValue") int resourceId) {
dialogOptions.setTextNegativeResId(resourceId);
return this;
}
@SuppressWarnings("unused")
public AppRate setTextNever(String negativeText) {
dialogOptions.setNegativeText(negativeText);
return this;
}
/**
* Sets whether the rating dialog is cancelable or not.
*
* @param cancelable default is false
* @return the {@link AppRate} singleton object
*/
public AppRate setCancelable(@SuppressWarnings("SameParameterValue") boolean cancelable) {
dialogOptions.setCancelable(cancelable);
return this;
}
/**
* Sets one of the app stores defined by {@link StoreType.StoreWithoutApplicationId} to
* the Positive button.
*
* @param storeType one of the values defined by {@link StoreType.StoreWithoutApplicationId}
* @return the {@link AppRate} singleton object
* @throws IllegalArgumentException if {@code storeType} isn't defined by {@link StoreType.StoreWithoutApplicationId}
* @see #setStoreType(int, long)
* @see #setStoreType(String...)
* @see #setStoreType(Intent...)
*/
@SuppressWarnings("WeakerAccess")
public AppRate setStoreType(@StoreType.StoreWithoutApplicationId final int storeType) throws IllegalArgumentException {
if ((storeType == APPLE) || (storeType == BLACKBERRY)) {
throw new IllegalArgumentException("For StoreType.APPLE/StoreType.BLACKBERRY you must use setStoreType(StoreType.APPLE/StoreType.BLACKBERRY, long applicationId)");
} else if ((storeType < AMAZON) || (storeType > YANDEX)) {
throw new IllegalArgumentException("StoreType must be one of: AMAZON, APPLE, BAZAAR, BLACKBERRY, CHINESESTORES, GOOGLEPLAY, MI, SAMSUNG, SLIDEME, TENCENT, YANDEX");
}
return setStoreType(storeType, null, null);
}
/**
* Sets one of the app stores defined by {@link StoreType.StoreWithApplicationId} to
* the Positive button.
*
* @param storeType one of the values defined by {@link StoreType.StoreWithApplicationId}
* @param applicationId application ID in the {@code storeType} app store
* @return the {@link AppRate} singleton object
* @throws IllegalArgumentException if {@code storeType} isn't defined by {@link StoreType.StoreWithApplicationId} or by {@link StoreType.StoreWithoutApplicationId}
* @see #setStoreType(int)
* @see #setStoreType(String...)
* @see #setStoreType(Intent...)
*/
@SuppressWarnings({"unused", "WeakerAccess"})
public AppRate setStoreType(@StoreType.StoreWithApplicationId final int storeType, final long applicationId) throws IllegalArgumentException {
if ((storeType < AMAZON) || (storeType > YANDEX)) {
throw new IllegalArgumentException("StoreType must be one of: AMAZON, APPLE, BAZAAR, BLACKBERRY, CHINESESTORES, GOOGLEPLAY, MI, SAMSUNG, SLIDEME, TENCENT, YANDEX");
}
return ((storeType != APPLE) && (storeType != BLACKBERRY)) ? setStoreType(storeType, null, null) : setStoreType(storeType, new String[]{String.valueOf(applicationId)}, null);
}
/**
* Sets any other app store/stores to the Positive button.
*
* @param uris an RFC 2396-compliant URI or array of URIs to your app,
* e. g. {@code https://otherstore.com/app?id=com.yourapp}
* or {@code otherstore://apps/com.yourapp}
* @return the {@link AppRate} singleton object
* @throws IllegalArgumentException if {@code uris} equals null
* @see #setStoreType(int)
* @see #setStoreType(int, long)
* @see #setStoreType(Intent...)
*/
@SuppressWarnings({"ConstantConditions", "WeakerAccess", "unused"})
public AppRate setStoreType(@NonNull final String... uris) throws IllegalArgumentException {
if (uris == null) {
throw new IllegalArgumentException("setStoreType(String... uris): 'uris' must be != null");
}
return setStoreType(OTHER, uris, null);
}
private AppRate setStoreType(final int storeType, final String[] stringParam, final Intent[] intentParaam) {
storeOptions.setStoreType(storeType, stringParam, intentParaam);
return this;
}
/**
* Gets the app store type from library options.
* NOTE: this method doesn't get an app store type from user's device.
*
* @return one of the values defined by {@link StoreType.AnyStoreType}
*/
@StoreType.AnyStoreType
public int getStoreType() {
return storeOptions.getStoreType();
}
/**
* Sets custom action to the Positive button.
* For example, you can open your custom RateActivity when the Positive button clicked.
*
* @param intents any custom intent or array of intents,
* first will be executed ({@code startActivity(intents[0])}), if first fails,
* second will be executed ({@code startActivity(intents[1])}), etc.
* @return the {@link AppRate} singleton object
* @throws IllegalArgumentException if {@code intents} equals null
* @see #setStoreType(int)
* @see #setStoreType(int, long)
* @see #setStoreType(String...)
*/
@SuppressWarnings({"ConstantConditions", "WeakerAccess", "unused"})
public AppRate setStoreType(@NonNull final Intent... intents) throws IllegalArgumentException {
if (intents == null) {
throw new IllegalArgumentException("setStoreType(Intent... intents): 'intents' must be != null");
}
return setStoreType(INTENT, null, intents);
}
@SuppressWarnings("unused")
public AppRate incrementEventCount(String eventName) {
return setEventCountValue(eventName, (short) (getCustomEventCount(context, eventName) + 1));
}
@SuppressWarnings("WeakerAccess")
public AppRate setEventCountValue(String eventName, short countValue) {
setCustomEventCount(context, eventName, countValue);
return this;
}
/**
* Sets dialog theme. You can use a specific theme to inflate the dialog.
*
* @param themeResId theme resource ID, default is 0
* @return the {@link AppRate} singleton object
*/
@SuppressWarnings("unused")
public AppRate setThemeResId(int themeResId) {
dialogOptions.setThemeResId(themeResId);
return this;
}
/**
* Sets {@link DialogManager.Factory} implementation.
* Call {@code AppRate.with(this).setDialogManagerFactory(null)} to set
* {@link DefaultDialogManager.Factory} implementation.
*
* @param dialogManagerFactory object of class that implements {@link DialogManager.Factory},
* default is {@link DefaultDialogManager.Factory} class object
* @return the {@link AppRate} singleton object
*/
@SuppressWarnings({"unused", "WeakerAccess"})
public AppRate setDialogManagerFactory(@Nullable DialogManager.Factory dialogManagerFactory) {
this.dialogManagerFactory.clearDialogManager();
if (dialogManagerFactory == null) {
this.dialogManagerFactory = new DefaultDialogManager.Factory();
} else {
dialogManagerFactory.clearDialogManager();
this.dialogManagerFactory = dialogManagerFactory;
}
return this;
}
/**
* Sets the check whether the version code of the app is changed.
*
* @param isVersionCodeCheck true means to re-enable the Rate Dialog if a new version of app
* with different version code is installed, default is false
* @return the {@link AppRate} singleton object
*/
public AppRate setVersionCodeCheck(boolean isVersionCodeCheck) {
this.isVersionCodeCheck = isVersionCodeCheck;
return this;
}
/**
* Sets the check whether the version name of the app is changed.
*
* @param isVersionNameCheck true means to re-enable the Rate Dialog if a new version of app
* with different version name is installed, default is false
* @return the {@link AppRate} singleton object
*/
public AppRate setVersionNameCheck(boolean isVersionNameCheck) {
this.isVersionNameCheck = isVersionNameCheck;
return this;
}
/**
* Monitors launches of the application.
* Call this method when the {@code onCreate()} of the app's launcher activity is launched.
*
*/
public void monitor() {
if (isFirstLaunch(context)) {
setFirstLaunchSharedPreferences(context);
} else {
PreferenceHelper.setLaunchTimes(context, (short) (getLaunchTimes(context) + 1));
if (AppInformation.getInstance(context).getAppLongVersionCode() != getVersionCode(context)) {
if (isVersionCodeCheck) {
setIsAgreeShowDialog(context, true);
}
setVersionCode(context);
}
if (!AppInformation.getInstance(context).getAppVersionName().equals(getVersionName(context))) {
if (isVersionNameCheck) {
setIsAgreeShowDialog(context, true);
}
setVersionName(context);
}
}
}
/**
* Call this method directly if you want to force display of the Rate Dialog.
* Call it when some button presses on. Method also useful for testing purposes.
*
* @param activity your activity, use "this" in most cases
*/
@SuppressWarnings("WeakerAccess")
public void showRateDialog(Activity activity) {
dismissRateDialog();
dialog = new WeakReference<>(dialogManagerFactory.createDialogManager(activity, dialogOptions, storeOptions).createDialog());
if (dialog.get() != null) {
try {
if (!activity.isFinishing()) {
dialog.get().show();
} else {
Log.w(TAG, "Failed to rate app, can't show rate dialog, because activity is in the process of finishing");
}
} catch(Exception e){
Log.w(TAG, "Failed to rate app, can't show rate dialog, because unpredictable exception", e);
}
} else {
Log.w(TAG, "Failed to rate app, can't create rate dialog");
}
}
/**
* Checks whether the Rate Dialog is currently showing.
*
* @return true if the Rate Dialog is currently showing, false otherwise.
*/
@SuppressWarnings("unused")
public boolean isShowingRateDialog() {
return ((dialog != null) && (dialog.get() != null)) && dialog.get().isShowing();
}
/**
* Dismisses Rate Dialog, removing it from the screen, and
* clears weak reference dialog object.
* This method can be invoked safely from any thread.
*/
@SuppressWarnings("WeakerAccess")
public void dismissRateDialog() {
if ((dialog != null) && (dialog.get() != null)) {
dialog.get().dismiss();
}
clearRateDialog();
}
/**
* Call this method directly if you want to send a user to rate your app right in the app
* store.
*
* @param activity your activity, use "this" in most cases
*/
@SuppressWarnings("unused")
public void rateNow(Activity activity) {
if ((dialog != null) && (dialog.get() != null)) {
Button positiveButton = ((AlertDialog) dialog.get()).getButton(AlertDialog.BUTTON_POSITIVE);
if (positiveButton != null) {
positiveButton.performClick();
dismissRateDialog();
} else {
Log.w(TAG, "Failed to rate app, can't get dialog positive button");
}
} else {
clearRateDialog();
dialog = new WeakReference<>(dialogManagerFactory.createDialogManager(activity, dialogOptions, storeOptions).createDialog());
if (dialog.get() != null) {
Button positiveButton = ((AlertDialog) dialog.get()).getButton(AlertDialog.BUTTON_POSITIVE);
if (positiveButton != null) {
positiveButton.performClick();
} else {
Log.w(TAG, "Failed to rate app, can't get dialog positive button");
}
} else {
Log.w(TAG, "Failed to rate app, can't create rate dialog");
}
clearRateDialog();
}
}
/**
* Call this method to determine whether conditions to show the rate dialog meets or not.
*/
@SuppressWarnings("WeakerAccess")
public boolean shouldShowRateDialog() {
return getIsAgreeShowDialog(context) &&
isOverLaunchTimes() &&
isSelectedAppLaunch() &&
isOverInstallDate() &&
isOverRemindDate() &&
isOverRemindLaunchesNumber() &&
isOverCustomEventsRequirements() &&
isBelow365DayPeriodMaxNumberDialogLaunchTimes();
}
private boolean isOverLaunchTimes() {
return ((appLaunchTimes == 0) || (getLaunchTimes(context) >= appLaunchTimes));
}
private boolean isSelectedAppLaunch() {
return ((selectedAppLaunches == 1) || ((selectedAppLaunches != 0) && ((getLaunchTimes(context) % selectedAppLaunches) == 0)));
}
private boolean isOverInstallDate() {
return ((installDate == 0L) || isOverDate(getInstallDate(context), installDate));
}
private boolean isOverRemindDate() {
return ((remindInterval == 0L) || (getRemindInterval(context) == 0L) || isOverDate(getRemindInterval(context), remindInterval));
}
private boolean isOverRemindLaunchesNumber() {
return ((remindLaunchesNumber == 0) || (getRemindLaunchesNumber(context) == 0) || (getLaunchTimes(context) - getRemindLaunchesNumber(context) >= remindLaunchesNumber));
}
private boolean isOverCustomEventsRequirements() {
if (customEventsCounts.isEmpty()) {
return true;
} else {
Short currentCount;
for (Map.Entry eventRequirement : customEventsCounts.entrySet()) {
currentCount = getCustomEventCount(context, eventRequirement.getKey());
if (currentCount < eventRequirement.getValue()) {
return false;
}
}
return true;
}
}
/**
* Checks if the library is in Debug mode. For development only!
*
* @return true if the library is in Debug mode, false otherwise
*/
@SuppressWarnings({"unused", "WeakerAccess"})
public boolean isDebug() {
return isDebug;
}
/**
* Debug mode. For development only!
* Setting the library to Debug mode ensures that the Rate Dialog will be shown each time
* the app is launched.
*
* @param isDebug default is false, true ensures that the Rate Dialog will be shown each time
* the app is launched
* @return the {@link AppRate} singleton object
*/
public AppRate setDebug(@SuppressWarnings("SameParameterValue") boolean isDebug) {
this.isDebug = isDebug;
return this;
}
}
