ly.count.sdk.java.internal

Class ModuleRatingCore

java.lang.Object

ly.count.sdk.java.internal.ModuleBase

ly.count.sdk.java.internal.ModuleRatingCore

All Implemented Interfaces:

Module

public class ModuleRatingCore
extends ModuleBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModuleRatingCore.RatingCallback Callbacks for star rating dialog
protected class	ModuleRatingCore.RatingsCore
static class	ModuleRatingCore.StarRatingPreferences Class that handles star rating internal state

Field Summary

Fields

Modifier and Type	Field and Description
protected CtxCore	ctx
protected boolean	disabledModule
protected InternalConfig	internalConfig
protected static Log.Module	L
protected static java.lang.String	STAR_RATING_EVENT_KEY
static java.lang.Long	storableStorageId
static java.lang.String	storableStoragePrefix

Constructor Summary

Constructors

Constructor and Description
ModuleRatingCore()

Method Summary

Modifier and Type	Method and Description
void	clearAutomaticStarRatingSessionCount() Set the automatic star rating session count back to 0
void	disableModule()
int	getAutomaticStarRatingSessionLimit() Returns the session limit set for automatic star rating
int	getCurrentVersionsSessionCount() Returns how many sessions has star rating counted internally
java.lang.Integer	getFeature()
void	init(InternalConfig config) All initialization must be done in this method, not constructor.
protected ModuleRatingCore.StarRatingPreferences	loadStarRatingPreferences() Returns a object with the loaded preferences
void	onContextAcquired(CtxCore ctx) SDK got a first context.
java.lang.Boolean	onRequest(Request request) This method is called only on owning module only if module marks request as owned (Request.own(Class).
void	PurgeRatingInfo()
protected void	saveStarRatingPreferences(ModuleRatingCore.StarRatingPreferences srp) Save the star rating preferences object
void	setIfRatingDialogIsCancellable(boolean isCancellable) Set if the star rating dialog is cancellable
void	setShowDialogAutomatically(boolean shouldShow) Set if the star rating dialog should be shown automatically
void	setStarRatingDisableAskingForEachAppVersion(boolean disableAsking) Set if automatic star rating should be disabled for each new version.
void	setStarRatingInitConfig(int limit, java.lang.String starRatingTextTitle, java.lang.String starRatingTextMessage, java.lang.String starRatingTextDismiss) Setting things that would be provided during initial config

Methods inherited from class ly.count.sdk.java.internal.ModuleBase

isActive, onActivityCreated, onActivityDestroyed, onActivityPaused, onActivityResumed, onActivitySaveInstanceState, onActivityStarted, onActivityStopped, onConfigurationChanged, onDeviceId, onLimitedContextAcquired, onRequestCompleted, onSessionBegan, onSessionEnded, onUserChanged, stop

Methods inherited from class java.lang.Object

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

Field Detail

STAR_RATING_EVENT_KEY

protected static final java.lang.String STAR_RATING_EVENT_KEY

See Also:

Constant Field Values

L

protected static final Log.Module L

disabledModule

protected boolean disabledModule

storableStorageId

public static final java.lang.Long storableStorageId

storableStoragePrefix

public static final java.lang.String storableStoragePrefix

See Also:

Constant Field Values

internalConfig

protected InternalConfig internalConfig

ctx

protected CtxCore ctx

Constructor Detail

ModuleRatingCore

public ModuleRatingCore()

Method Detail

init

public void init(InternalConfig config)

Description copied from interface: Module

All initialization must be done in this method, not constructor. This method is guaranteed to be run right after constructor with no module-related actions in between.

Specified by:

init in interface Module

Overrides:

init in class ModuleBase

Parameters:

config - Countly configuration object: can be stored locally if needed.

onContextAcquired

public void onContextAcquired(CtxCore ctx)

Description copied from interface: Module

SDK got a first context. Called only in main mode (from Application#onCreate())

Specified by:

onContextAcquired in interface Module

Overrides:

onContextAcquired in class ModuleBase

Parameters:

ctx - CtxCore with application instance

getFeature

public java.lang.Integer getFeature()

Returns:

Module feature index if any

onRequest

public java.lang.Boolean onRequest(Request request)

Description copied from interface: Module

This method is called only on owning module only if module marks request as owned (Request.own(Class). Gives a module another chance to modify request before sending. Being run in CountlyService.

Specified by:

onRequest in interface Module

Overrides:

onRequest in class ModuleBase

Parameters:

request - request to check

Returns:

true if ok to send now, false if not ok to (remove request from queue), null if cannot decide yet

disableModule

public void disableModule()

PurgeRatingInfo

public void PurgeRatingInfo()

loadStarRatingPreferences

protected ModuleRatingCore.StarRatingPreferences loadStarRatingPreferences()

Returns a object with the loaded preferences

Returns:

StarRatingPreferences instance

saveStarRatingPreferences

protected void saveStarRatingPreferences(ModuleRatingCore.StarRatingPreferences srp)

Save the star rating preferences object

Parameters:

srp -

setStarRatingInitConfig

public void setStarRatingInitConfig(int limit,
                                    java.lang.String starRatingTextTitle,
                                    java.lang.String starRatingTextMessage,
                                    java.lang.String starRatingTextDismiss)

Setting things that would be provided during initial config

Parameters:

limit - limit for automatic rating

starRatingTextTitle - provided title

starRatingTextMessage - provided message

starRatingTextDismiss - provided dismiss text

setShowDialogAutomatically

public void setShowDialogAutomatically(boolean shouldShow)

Set if the star rating dialog should be shown automatically

Parameters:

shouldShow -

setStarRatingDisableAskingForEachAppVersion

public void setStarRatingDisableAskingForEachAppVersion(boolean disableAsking)

Set if automatic star rating should be disabled for each new version. By default automatic star rating will be shown for every new app version. If this is set to true, star rating will be shown only once over apps lifetime

Parameters:

disableAsking - if set true, will not show star rating for every new app version

getAutomaticStarRatingSessionLimit

public int getAutomaticStarRatingSessionLimit()

Returns the session limit set for automatic star rating

getCurrentVersionsSessionCount

public int getCurrentVersionsSessionCount()

Returns how many sessions has star rating counted internally

Returns:

current session count

clearAutomaticStarRatingSessionCount

public void clearAutomaticStarRatingSessionCount()

Set the automatic star rating session count back to 0

setIfRatingDialogIsCancellable

public void setIfRatingDialogIsCancellable(boolean isCancellable)

Set if the star rating dialog is cancellable

Parameters:

isCancellable -