Package com.zendesk.sdk.model.settings

Class RateMyAppSettings

  • All Implemented Interfaces:
    java.io.Serializable

    public class RateMyAppSettings
extends java.lang.Object
implements java.io.Serializable
    This model represents all of the settings that can be retrieved from the server for the RateMyAppDialog
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getAndroidStoreUrl()
      Gets the url to this app's android store.
      long getDelay()
      Gets the delay in milliseconds before the dialog will show up after you call its RateMyAppDialog#show(...) method.
      long getDuration()
      Gets the number of milliseconds after the first attempted launch that must elapse before the dialog is eligible to show.
      java.util.List<java.lang.String> getTags()
      Gets a copy of the list of tags that should be added to the ticket by default
      int getVisits()
      Gets the minimum number of visits to the screen that hosts the RateMyAppDialog
      boolean isEnabled()
      Determines whether the dialog can be shown.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RateMyAppSettings

        public RateMyAppSettings()

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Determines whether the dialog can be shown. This has a higher precedence than other checks and if this is enabled then other checks will not be performed like incrementing the launch count.
        Returns:
        true if the server allows the dialog to be shown, false otherwise

      • getVisits

        public int getVisits()
        Gets the minimum number of visits to the screen that hosts the RateMyAppDialog

        For example, if the RateMyAppDialog is hosted on your main activity and this method returns 5 then the RateMyAppDialog will show on the 6th time your main activity shows (assuming that no other checks prevent showing the dialog)

        Returns:
        The number of visits that must be met in order to show the dialog

      • getDuration

        public long getDuration()
        Gets the number of milliseconds after the first attempted launch that must elapse before the dialog is eligible to show.

        The server sends back the value for delay in days. This method converts that to milliseconds.

        Returns:
        The number of milliseconds from the first call of RateMyAppDialog#show(...) that must have elapsed before the dialog may be eligible to be shown. Note that all other checks must also permit the dialog to be shown

      • getDelay

        public long getDelay()
        Gets the delay in milliseconds before the dialog will show up after you call its RateMyAppDialog#show(...) method.

        This assumes that all other checks permit the showing of the dialog. Note that the server sends back this time in seconds. This method converts that into milliseconds.

        Returns:
        The number of milliseconds that will occur before the dialog is shown after a call to its RateMyAppDialog#show(...) show method.

      • getTags

        public java.util.List<java.lang.String> getTags()
        Gets a copy of the list of tags that should be added to the ticket by default
        Returns:
        A copy of the list of tags to add or an empty list if none are to be added.

      • getAndroidStoreUrl

        public java.lang.String getAndroidStoreUrl()
        Gets the url to this app's android store. This will be the URL that is opened when the "yes, rate my app" button is tapped in the RateMyAppDialog
        Returns:
        The url of this app on an android store.