Package org.exoplatform.agenda.service

Interface AgendaEventReminderService

public interface AgendaEventReminderService

  • Method Details

    • getEventReminders

      List<EventReminder> getEventReminders(long eventId, long userIdentityId)
      Retrieves list of reminders of an event for a user. If there is no specific reminder, the default user reminders will be used. (Combined between User Settings and default values)
      Parameters:
      eventId - Event technical identifier
      userIdentityId - User technical identifier (Identity.getId())
      Returns:
      List of EventReminder corresponding to user preferences.

    • getEventReminders

      List<EventReminder> getEventReminders(long eventId)
      Retrieves list of reminders of an event. If there is no specific reminder, the default user reminders will be used. (Combined between User Settings and default values)
      Parameters:
      eventId - Event technical identifier
      Returns:
      List of EventReminder.

    • saveEventReminders

      Set<AgendaEventModificationType> saveEventReminders(Event event, List<EventReminder> reminders, long userIdentityId) throws IllegalAccessException, AgendaException
      Updates the list of EventReminder associated to a user on a selected event
      Parameters:
      event - Event on which the reminder will be attached
      reminders - List of EventReminder
      userIdentityId - User technical identifier (Identity.getId()) updating his/her reminders on the event
      Returns:
      Set of AgendaEventModificationType containing modifications made on event reminders
      Throws:
      IllegalAccessException - when user isn't an attendee of the event
      AgendaException - when a reminder datetime can't be computed

    • saveEventReminders

      void saveEventReminders(Event event, List<EventReminder> reminders)
      Saves the List of EventReminder of a chosen Event
      Parameters:
      event - Event for which saving reminders
      reminders - List of EventReminder

    • saveUpcomingEventReminders

      void saveUpcomingEventReminders(long eventId, ZonedDateTime occurrenceId, List<EventReminder> reminders, long userIdentityId) throws AgendaException
      Save reminders for an upcoming of an occurrence of a recurring event for a specific user
      Parameters:
      eventId - technical identifier of Event
      occurrenceId - Event occurrence identifier on which the modification will be applied
      reminders - List of EventReminder
      userIdentityId - User technical identifier (Identity.getId()) updating his/her reminders on the event
      Throws:
      AgendaException - when an error occurs while saving reminders

    • getReminderComputingPeriod

      long getReminderComputingPeriod()
      Returns:
      period used to compute reminder of occurrences of a recurrent event in days

    • setReminderComputingPeriod

      void setReminderComputingPeriod(long reminderComputingPeriod)
      Parameters:
      reminderComputingPeriod - value of period used to compute reminder of occurrences of a recurrent event in days

    • removeUserReminders

      void removeUserReminders(long eventId, long identityId)
      Deletes all reminders of a user on a given event identified by its identifier.
      Parameters:
      eventId - technical identifier of Event
      identityId - technical identifier of Identity

    • removeEventReminders

      void removeEventReminders(long eventId)
      Removes all reminders of a given Event
      Parameters:
      eventId - technical identifier of Event

    • sendReminders

      void sendReminders()
      Send reminders of upcoming events of next minute