com.github.kaiwinter.androidremotenotifications.model.UpdatePolicy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of android-remote-notifications Show documentation

Pulls notifications from a remote JSON file and shows them in your app.

There is a newer version: 1.1.5

Show newest version

package com.github.kaiwinter.androidremotenotifications.model;

import com.github.kaiwinter.androidremotenotifications.RemoteNotifications;

import java.util.Date;

/**
 * Defines how often the notifications are updated from the server. Doing this on each start of your app ({@link #NOW})
 * might lead to too many server calls. You can reduce them by using {@link #WEEKLY} or {@link #MONTHLY}.
 */
public enum UpdatePolicy {

    /**
     * The update is made now, regardless when the last one was.
     */
    NOW(0),

    /**
     * The update is made once a week. {@link RemoteNotifications} uses an internal shared preference to track when the last update
     * was.
     */
    WEEKLY(7 * 24 * 60 * 60 * 1000),

    /**
     * The update is made every second week. {@link RemoteNotifications} uses an internal shared preference to track when the last update
     * was.
     */
    BI_WEEKLY(WEEKLY.getInterval() * 2),

    /**
     * The update is made once a month. {@link RemoteNotifications} uses an internal shared preference to track when the last
     * update was.
     */
    MONTHLY(WEEKLY.getInterval() * 4);

    private final long interval;

    UpdatePolicy(long interval) {
        this.interval = interval;
    }

    private long getInterval() {
        return interval;
    }

    /**
     * Checks if the interval of this {@link UpdatePolicy} is over in regard to the lastUpdate.
     *
     * @param lastUpdate The {@link Date} of the last update.
     * @return true if an update should be done, else false.
     */
    public boolean shouldUpdate(Date lastUpdate) {
        if (lastUpdate == null) {
            return true;
        }
        // be robust against small time differences when using NOW
        return System.currentTimeMillis() - interval >= lastUpdate.getTime();
    }
}