//DEAD CODE FOR NOW
protected virtual bool WillFirstReminderBeRemoved(List <ReminderEntity> remindersToBeRemoved)
{
if (!ElapsedActiveReminders.Any())
{
//it will not be removed because it doesn't exist
return(false);
}
ReminderEntity firstReminder = ElapsedActiveReminders.First();
bool firstReminderWillBeRemoved = remindersToBeRemoved.Any(rem => rem.Name == firstReminder.Name);
return(firstReminderWillBeRemoved);
}
/// <summary>
/// Immediately fires next event if there is any reminder in the list, or goes to NoElapsedReminders state otherwise.
/// </summary>
protected virtual void GoToRingingOrIdleState(DateTime now)
{
if (ElapsedActiveReminders.Any())
{
var nextToRing = ElapsedActiveReminders.First();
GoToRingingState(nextToRing.Name, now);
}
else
{
UserState = UserInteractionState.NoElapsedReminders;
Log.Logger.Information($"No elapsed reminders in the list. GoToRingingOrIdleState method is setting state to NoElapsedReminders");
}
}
//TODO DP->SI: provide functionallity to run immediately all snooze reminders, not to bother user later with them. This will also be useful for IsOkToModifyReminder situation
public virtual bool IsOkToModifyReminder(string reminderName)
{
bool reminderIsInList = ElapsedActiveReminders.Any(rem => rem.Name == reminderName);
DateTime now = DateTime.UtcNow;
//TODO DP->SI: instead of running them now, it would be more polite to ask user if he wants to run the reminder now. It would be even better to just update the reminders immediately, but that is too complex for now (see UpdateReminderList method)
if (reminderIsInList && UserState != UserInteractionState.Disabled)
{
Log.Logger.Information("Change of elapsed but not dismissed reminder was attempted. Running snoozed reminders now.");
SnoozeTimer.Stop();
GoToRingingOrIdleState(now); //TODO: this may be unsafe as maybe we are not in snooze state, but e.g. already waiting user reaction?
}
return(!reminderIsInList);
}
/// <summary>
/// Call this method when a reminder elapses. Robust to adding again elapsed reminders that are not yet dismissed.
/// </summary>
/// <param name="reminder"></param>
public virtual void OnReminderElapsed(ReminderEntity reminder)
{
DateTime now = DateTime.UtcNow;
if (reminder == null)
{
//just a redundant check so that this component has robust interface
Log.Logger.Error($"OnReminderElapsed event fired with null reminder. Ignoring OnReminderElapsed event");
return;
}
//TODO: duplicate reminder could be added as a consequence of change to the reminder entity. This would need to be handled, especially when the first reminder is changed.
if (ElapsedActiveReminders.Any(rem => rem.Name == reminder.Name))
{
Log.Logger.Information($"ElapsedActiveReminders list already contains reminder [name = {reminder.Name}]. Ignoring OnReminderElapsed event.");
return;
}
ElapsedActiveReminders.Add(reminder); //TODO: is some sorting needed or it is safe to always add it at the end? Otherwise, we would maybe need to handle change of first reminder.
Log.Logger.Information($"Processing OnReminderElapsed event [name = {reminder.Name}, current component state = {UserState}].");
switch (UserState)
{
case UserInteractionState.NoElapsedReminders:
//start ringing
GoToRingingState(reminder.Name, now);
break;
case UserInteractionState.WaitingUserResponse:
//ignoring next reminder until previous remidner is handled
//what to do when another event comes but previous is not yet handled by the user - just show them one by one, when handling previous is over, or update this one to show all?
break;
case UserInteractionState.SnoozeTime:
//ignoring next reminder until previous remidner is handled
//TODO: later add feature to force showing of both (or more) reminders in the same form window (forcing showing them one by one would be confusing as we don't respect snooze interval, and user is not aware that behing this reminder is another (potentially with higher priority))
break;
case UserInteractionState.Disabled:
Log.Logger.Information($"OnReminderElapsed event [name = {reminder.Name}] will be handled just by adding reminder to the list because UserInteractionManager is currently not enabled.");
break;
}
}
