com.vorlonsoft.android.rate

Class AppRate

java.lang.Object

com.vorlonsoft.android.rate.AppRate

public final class AppRate
extends Object

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, Shintaro Katafuchi

Method Summary

Modifier and Type	Method and Description
AppRate	clearAgreeShowDialog()
AppRate	clearRemindButtonClick() Clears shared preferences that were set up by clicking the Remind Button.
AppRate	clearSettingsParam()
void	dismissRateDialog() Dismisses Rate Dialog, removing it from the screen, and clears weak reference dialog object.
int	getStoreType() Gets the app store type from library options.
AppRate	incrementEventCount(String eventName)
boolean	isDebug() Checks if the library is in Debug mode.
boolean	isShowingRateDialog() Checks whether the Rate Dialog is currently showing.
void	monitor() Monitors launches of the application.
void	rateNow(Activity activity) Call this method directly if you want to send a user to rate your app right in the app store.
AppRate	set365DayPeriodMaxNumberDialogLaunchTimes(short dialogLaunchTimes) Sets the max number of occurrences of the display of the Rate Dialog within a 365-day period.
AppRate	setAgreeShowDialog(boolean isAgree)
AppRate	setCancelable(boolean cancelable) Sets whether the rating dialog is cancelable or not.
AppRate	setDebug(boolean isDebug) Debug mode.
AppRate	setDialogManagerFactory(DialogManager.Factory dialogManagerFactory) Sets DialogManager.Factory implementation.
AppRate	setEventCountValue(String eventName, short countValue)
AppRate	setInstallDays(byte installDate) Sets the minimal number of days until the Rating Dialog pops up for the first time.
AppRate	setLaunchTimes(byte appLaunchTimes) Sets the minimum number of launches until the rating dialog pops up for the first time.
AppRate	setMessage(int resourceId)
AppRate	setMessage(String message)
AppRate	setMinimumEventCount(String eventName, short minimumCount)
AppRate	setOnClickButtonListener(OnClickButtonListener listener) Specifies the callback when the button of Rate Dialog is pressed.
AppRate	setRemindInterval(byte remindInterval) Sets the minimal number of days until the Rating Dialog pops up for the next time after neutral button clicked.
AppRate	setRemindLaunchesNumber(byte remindLaunchesNumber) Sets the minimal number of app's launches after neutral button clicked until the Rating Dialog pops up next time.
AppRate	setRemindLaunchTimes(byte selectedAppLaunches) Deprecated. since 1.2.0, use setSelectedAppLaunches(byte) with the same param instead
AppRate	setRemindTimeToWait(long timeUnit, short timeUnitsNumber) Sets the minimal number of time units until the Rating Dialog pops up for the next time after neutral button clicked.
AppRate	setSelectedAppLaunches(byte selectedAppLaunches) Selects App launches.
AppRate	setShowLaterButton(boolean isShowNeutralButton) Decides whether the Neutral button ("Remind me later") appears in the Rating Dialog or not.
AppRate	setShowNeverButton(boolean isShowNeverButton) Decides if Never button appear in the rating dialog or not
AppRate	setShowTitle(boolean isShowTitle)
AppRate	setStoreType(int storeType) Sets one of the app stores defined by StoreType.StoreWithoutApplicationId to the Positive button.
AppRate	setStoreType(Intent... intents) Sets custom action to the Positive button.
AppRate	setStoreType(int storeType, long applicationId) Sets one of the app stores defined by StoreType.StoreWithApplicationId to the Positive button.
AppRate	setStoreType(String... uris) Sets any other app store/stores to the Positive button.
AppRate	setTextLater(int resourceId)
AppRate	setTextLater(String neutralText)
AppRate	setTextNever(int resourceId)
AppRate	setTextNever(String negativeText)
AppRate	setTextRateNow(int resourceId)
AppRate	setTextRateNow(String positiveText)
AppRate	setThemeResId(int themeResId) Sets dialog theme.
AppRate	setTimeToWait(long timeUnit, short timeUnitsNumber) Sets the minimal number of time units until the Rating Dialog pops up for the first time.
AppRate	setTitle(int resourceId)
AppRate	setTitle(String title)
AppRate	setVersionCodeCheck(boolean isVersionCodeCheck) Sets the check whether the version code of the app is changed.
AppRate	setVersionNameCheck(boolean isVersionNameCheck) Sets the check whether the version name of the app is changed.
AppRate	setView(View view)
boolean	shouldShowRateDialog() Call this method to determine whether conditions to show the rate dialog meets or not.
void	showRateDialog(Activity activity) Call this method directly if you want to force display of the Rate Dialog.
static boolean	showRateDialogIfMeetsConditions(Activity activity) Shows the Rate Dialog when conditions are met.
static AppRate	with(Context context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

with

public static AppRate with(Context context)

showRateDialogIfMeetsConditions

public static boolean showRateDialogIfMeetsConditions(Activity activity)

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.

Parameters:

activity - your activity, use "this" in most cases

set365DayPeriodMaxNumberDialogLaunchTimes

public AppRate set365DayPeriodMaxNumberDialogLaunchTimes(short dialogLaunchTimes)

Sets the max number of occurrences of the display of the Rate Dialog within a 365-day period.

Parameters:

dialogLaunchTimes - the max number of the display of the Rate Dialog within a 365-day period, default is Short.MAX_VALUE, Short.MAX_VALUE means unlimited occurrences

Returns:

the AppRate singleton object

setLaunchTimes

public AppRate setLaunchTimes(byte appLaunchTimes)

Sets the minimum number of launches until the rating dialog pops up for the first time.

Parameters:

appLaunchTimes - number of launches, default is 10, 3 means app is launched 3 or more times

Returns:

the AppRate singleton object

setInstallDays

public AppRate setInstallDays(byte installDate)

Sets the minimal number of days until the Rating Dialog pops up for the first time.

Parameters:

installDate - number of days, default is 10, 0 means install day, 10 means app is launched 10 or more days later than installation

Returns:

the AppRate singleton object

See Also:

setTimeToWait(long, short)

setTimeToWait

public AppRate setTimeToWait(@Time.TimeUnits
                             long timeUnit,
                             short timeUnitsNumber)

Sets the minimal number of time units until the Rating Dialog pops up for the first time.

Default is 10 days, 0 means install millisecond, 10 means app is launched 10 or more time units later than installation.

Parameters:

timeUnit - one of the values defined by Time.TimeUnits

timeUnitsNumber - time units number

Returns:

the AppRate singleton object

See Also:

setInstallDays(byte), Time.TimeUnits

setRemindInterval

public AppRate setRemindInterval(byte remindInterval)

Sets the minimal number of days until the Rating Dialog pops up for the next time after neutral button clicked.

Parameters:

remindInterval - number of days, default is 1, 1 means app is launched 1 or more days after neutral button clicked

Returns:

the AppRate singleton object

See Also:

setRemindTimeToWait(long, short)

setRemindTimeToWait

public AppRate setRemindTimeToWait(@Time.TimeUnits
                                   long timeUnit,
                                   short timeUnitsNumber)

Sets the minimal number of time units until the Rating Dialog pops up for the next time after neutral button clicked.

Default is 1 day, 1 means app is launched 1 or more time units after neutral button clicked.

Parameters:

timeUnit - one of the values defined by Time.TimeUnits

timeUnitsNumber - time units number

Returns:

the AppRate singleton object

See Also:

setRemindInterval(byte), Time.TimeUnits

setRemindLaunchesNumber

public AppRate setRemindLaunchesNumber(byte remindLaunchesNumber)

Sets the minimal number of app's launches after neutral button clicked until the Rating Dialog pops up next time.

Parameters:

remindLaunchesNumber - number of app launches, default is 0, 1 means app is launched 1 or more times after neutral button clicked

Returns:

the AppRate singleton object

clearRemindButtonClick

public AppRate clearRemindButtonClick()

Clears shared preferences that were set up by clicking the Remind Button.

Returns:

the AppRate singleton object

setMinimumEventCount

public AppRate setMinimumEventCount(String eventName,
                                    short minimumCount)

setSelectedAppLaunches

public AppRate setSelectedAppLaunches(byte selectedAppLaunches)

Selects App launches.

Method sets divisor for division of app launches with a remainder. This condition is satisfied if appLaunches % divisorAppLaunches == 0

Parameters:

selectedAppLaunches - default is 1, 1 means each launch, 2 means every 2nd launch, 3 means every 3rd launch, etc

Returns:

the AppRate singleton object

Since:

1.2.0

setRemindLaunchTimes

public AppRate setRemindLaunchTimes(byte selectedAppLaunches)

Deprecated. since 1.2.0, use setSelectedAppLaunches(byte) with the same param instead

Selects App launches.

Method sets divisor for division of app launches with a remainder. This condition is satisfied if appLaunches % divisorAppLaunches == 0

Parameters:

selectedAppLaunches - default is 1, 1 means each launch, 2 means every 2nd launch, 3 means every 3rd launch, etc

Returns:

the AppRate singleton object

See Also:

setSelectedAppLaunches(byte)

setShowLaterButton

public AppRate setShowLaterButton(boolean isShowNeutralButton)

Decides whether the Neutral button ("Remind me later") appears in the Rating Dialog or not.

Parameters:

isShowNeutralButton - default is true, true means to show the Neutral button

Returns:

the AppRate singleton object

setShowNeverButton

public AppRate setShowNeverButton(boolean isShowNeverButton)

Decides if Never button appear in the rating dialog or not

Parameters:

isShowNeverButton - default is true

Returns:

the AppRate singleton object

setShowTitle

public AppRate setShowTitle(boolean isShowTitle)

clearAgreeShowDialog

public AppRate clearAgreeShowDialog()

clearSettingsParam

public AppRate clearSettingsParam()

setAgreeShowDialog

public AppRate setAgreeShowDialog(boolean isAgree)

setView

public AppRate setView(View view)

setOnClickButtonListener

public AppRate setOnClickButtonListener(OnClickButtonListener listener)

Specifies the callback when the button of Rate Dialog is pressed.

Parameters:

listener - implemented OnClickButtonListener Interface

Returns:

the AppRate singleton object

setTitle

public AppRate setTitle(int resourceId)

setTitle

public AppRate setTitle(String title)

setMessage

public AppRate setMessage(int resourceId)

setMessage

public AppRate setMessage(String message)

setTextRateNow

public AppRate setTextRateNow(int resourceId)

setTextRateNow

public AppRate setTextRateNow(String positiveText)

setTextLater

public AppRate setTextLater(int resourceId)

setTextLater

public AppRate setTextLater(String neutralText)

setTextNever

public AppRate setTextNever(int resourceId)

setTextNever

public AppRate setTextNever(String negativeText)

setCancelable

public AppRate setCancelable(boolean cancelable)

Sets whether the rating dialog is cancelable or not.

Parameters:

cancelable - default is false

Returns:

the AppRate singleton object

setStoreType

public AppRate setStoreType(@StoreType.StoreWithoutApplicationId
                            int storeType)
                     throws IllegalArgumentException

Sets one of the app stores defined by StoreType.StoreWithoutApplicationId to the Positive button.

Parameters:

storeType - one of the values defined by StoreType.StoreWithoutApplicationId

Returns:

the AppRate singleton object

Throws:

IllegalArgumentException - if storeType isn't defined by StoreType.StoreWithoutApplicationId

See Also:

setStoreType(int, long), setStoreType(String...), setStoreType(Intent...)

setStoreType

public AppRate setStoreType(@StoreType.StoreWithApplicationId
                            int storeType,
                            long applicationId)
                     throws IllegalArgumentException

Sets one of the app stores defined by StoreType.StoreWithApplicationId to the Positive button.

Parameters:

storeType - one of the values defined by StoreType.StoreWithApplicationId

applicationId - application ID in the storeType app store

Returns:

the AppRate singleton object

Throws:

IllegalArgumentException - if storeType isn't defined by StoreType.StoreWithApplicationId or by StoreType.StoreWithoutApplicationId

See Also:

setStoreType(int), setStoreType(String...), setStoreType(Intent...)

setStoreType

public AppRate setStoreType(@NonNull
                            String... uris)
                     throws IllegalArgumentException

Sets any other app store/stores to the Positive button.

Parameters:

uris - an RFC 2396-compliant URI or array of URIs to your app, e. g. https://otherstore.com/app?id=com.yourapp or otherstore://apps/com.yourapp

Returns:

the AppRate singleton object

Throws:

IllegalArgumentException - if uris equals null

See Also:

setStoreType(int), setStoreType(int, long), setStoreType(Intent...)

getStoreType

@StoreType.AnyStoreType
public int getStoreType()

Gets the app store type from library options.

NOTE: this method doesn't get an app store type from user's device.

Returns:

one of the values defined by StoreType.AnyStoreType

setStoreType

public AppRate setStoreType(@NonNull
                            Intent... intents)
                     throws IllegalArgumentException

Sets custom action to the Positive button.

For example, you can open your custom RateActivity when the Positive button clicked.

Parameters:

intents - any custom intent or array of intents, first will be executed (startActivity(intents[0])), if first fails, second will be executed (startActivity(intents[1])), etc.

Returns:

the AppRate singleton object

Throws:

IllegalArgumentException - if intents equals null

See Also:

setStoreType(int), setStoreType(int, long), setStoreType(String...)

incrementEventCount

public AppRate incrementEventCount(String eventName)

setEventCountValue

public AppRate setEventCountValue(String eventName,
                                  short countValue)

setThemeResId

public AppRate setThemeResId(int themeResId)

Sets dialog theme. You can use a specific theme to inflate the dialog.

Parameters:

themeResId - theme resource ID, default is 0

Returns:

the AppRate singleton object

setDialogManagerFactory

public AppRate setDialogManagerFactory(@Nullable
                                       DialogManager.Factory dialogManagerFactory)

Sets DialogManager.Factory implementation.

Call AppRate.with(this).setDialogManagerFactory(null) to set DefaultDialogManager.Factory implementation.

Parameters:

dialogManagerFactory - object of class that implements DialogManager.Factory, default is DefaultDialogManager.Factory class object

Returns:

the AppRate singleton object

setVersionCodeCheck

public AppRate setVersionCodeCheck(boolean isVersionCodeCheck)

Sets the check whether the version code of the app is changed.

Parameters:

isVersionCodeCheck - true means to re-enable the Rate Dialog if a new version of app with different version code is installed, default is false

Returns:

the AppRate singleton object

setVersionNameCheck

public AppRate setVersionNameCheck(boolean isVersionNameCheck)

Sets the check whether the version name of the app is changed.

Parameters:

isVersionNameCheck - true means to re-enable the Rate Dialog if a new version of app with different version name is installed, default is false

Returns:

the AppRate singleton object

monitor

public void monitor()

Monitors launches of the application.

Call this method when the onCreate() of the app's launcher activity is launched.

*

showRateDialog

public void showRateDialog(Activity activity)

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.

Parameters:

activity - your activity, use "this" in most cases

isShowingRateDialog

public boolean isShowingRateDialog()

Checks whether the Rate Dialog is currently showing.

Returns:

true if the Rate Dialog is currently showing, false otherwise.

dismissRateDialog

public void dismissRateDialog()

Dismisses Rate Dialog, removing it from the screen, and clears weak reference dialog object.

This method can be invoked safely from any thread.

rateNow

public void rateNow(Activity activity)

Call this method directly if you want to send a user to rate your app right in the app store.

Parameters:

activity - your activity, use "this" in most cases

shouldShowRateDialog

public boolean shouldShowRateDialog()

Call this method to determine whether conditions to show the rate dialog meets or not.

isDebug

public boolean isDebug()

Checks if the library is in Debug mode. For development only!

Returns:

true if the library is in Debug mode, false otherwise

setDebug

public AppRate setDebug(boolean 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.

Parameters:

isDebug - default is false, true ensures that the Rate Dialog will be shown each time the app is launched

Returns:

the AppRate singleton object