com.vorlonsoft.android.rate.DialogManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of androidrate Show documentation

Library to help you promote your Android app by prompting users to rate the app after using it for a few days.

The newest version!

/*
 * Copyright 2017 - 2018 Vorlonsoft LLC
 *
 * Licensed under The MIT License (MIT)
 */

package com.vorlonsoft.android.rate;

import android.app.Dialog;
import android.content.Context;

/**
 * DialogManager Interface - dialog manager interface of the AndroidRate library.
 * You can implement DialogManager Interface and use
 * {@link AppRate#setDialogManagerFactory(DialogManager.Factory)} if you want to use fully custom
 * dialog (from v7 AppCompat library etc.).
 *
 * @since    1.0.2
 * @version  1.2.1
 * @author   Alexander Savin
 * @author   Antoine Vianey
 * @see DialogManager.Factory
 */

public interface DialogManager {

    /**
     * Creates Rate Dialog.
     *
     * @return created dialog
     */
    Dialog createDialog();

    /**
     * DialogManager.Factory Interface - dialog manager factory interface of the AndroidRate
     * library.
     * You can implement DialogManager.Factory Interface and use
     * {@link AppRate#setDialogManagerFactory(DialogManager.Factory)} if you want to use fully
     * custom dialog (from v7 AppCompat library etc.).
     *
     * @since    1.0.2
     * @version  1.2.1
     * @author   Alexander Savin
     * @author   Antoine Vianey
     * @see DialogManager
     */

    interface Factory {

        /** Clears {@link DialogManager} implementation singleton. */
        void clearDialogManager();

        /**
         * Creates {@link DialogManager} implementation singleton object.
         *
         * @param context context
         * @param dialogOptions Rate Dialog options
         * @param storeOptions App store options
         * @return {@link DialogManager} implementation singleton object
         */
        DialogManager createDialogManager(final Context context, final DialogOptions dialogOptions, final StoreOptions storeOptions);
    }
}