com.github.kaiwinter.androidremotenotifications.model.impl

Class NotificationConfiguration

java.lang.Object

com.github.kaiwinter.androidremotenotifications.model.impl.NotificationConfiguration

public final class NotificationConfiguration
extends java.lang.Object

Stores configurations for a Notification e.g. when and how often it is shown and on which app versions.

Constructor Summary

Constructors

Constructor and Description
NotificationConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ExecutionPolicy	getExecutionPolicy() Returns when to show the notification.
java.lang.Integer	getNumberOfTotalViews() Returns the number of times the notification is shown in regards to executionPolicy (null=infinite).
java.util.Date	getStartShowingDate()
VersionCodePolicy	getVersionCodePolicy() Returns the app version on which the notification is shown.
int	hashCode()
void	setExecutionPolicy(ExecutionPolicy executionPolicy) Sets the ExecutionPolicy when to show the notification.
void	setNumberOfTotalViews(java.lang.Integer numberOfTotalViews) Sets the number of times the notification is shown in regards to executionPolicy (null=infinite).
void	setStartShowingDate(java.util.Date startShowingDate) Set the date from which the notification will be shown.
void	setVersionCodePolicy(VersionCodePolicy versionCodePolicy) Sets the app version on which the notification is shown.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationConfiguration

public NotificationConfiguration()

Method Detail

getStartShowingDate

public java.util.Date getStartShowingDate()

Returns:

the date to start showing the notification

setStartShowingDate

public void setStartShowingDate(java.util.Date startShowingDate)

Set the date from which the notification will be shown. If null notification will be shown immediately (if ExecutionPolicy strikes).

Parameters:

startShowingDate - the date to start showing the notification

getExecutionPolicy

public ExecutionPolicy getExecutionPolicy()

Returns when to show the notification.

Returns:

when to show the notification

setExecutionPolicy

public void setExecutionPolicy(ExecutionPolicy executionPolicy)

Sets the ExecutionPolicy when to show the notification. If null the notification will be shown ExecutionPolicy.ALWAYS. This will be evaluated only after startShowingDate (if not null).

Parameters:

executionPolicy - when to show the notification

getNumberOfTotalViews

public java.lang.Integer getNumberOfTotalViews()

Returns the number of times the notification is shown in regards to executionPolicy (null=infinite).

Returns:

the number of times the notification is shown.

setNumberOfTotalViews

public void setNumberOfTotalViews(java.lang.Integer numberOfTotalViews)

Sets the number of times the notification is shown in regards to executionPolicy (null=infinite).

Parameters:

numberOfTotalViews - the number of times the notification is shown in regards to executionPolicy (null=infinite).

getVersionCodePolicy

public VersionCodePolicy getVersionCodePolicy()

Returns the app version on which the notification is shown. If null notification will be shown on all versions.

Returns:

the VersionCodePolicy

setVersionCodePolicy

public void setVersionCodePolicy(VersionCodePolicy versionCodePolicy)

Sets the app version on which the notification is shown. If null notification will be shown on all versions.

Parameters:

versionCodePolicy - the VersionCodePolicy to restrict the app versions

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object