Package ch.ivyteam.ivy.security

Interface IEMailNotificationSettings

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      EnumSet<Weekday> getSendDailyTaskSummary()
      Gets the weekdays on which a daily task summary should be sent to the user if the user has one or more open tasks in his task list.
      boolean isNotificationDisabled()
      Returns if the whole email notification is disabled or not.
      boolean isSendDailyTaskSummaryOnDay​(Weekday weekday)
      Returns if a daily task summary on the given weekday should be sent if the user has one or more open tasks in his task list.
      boolean isSendOnNewWorkTasks()
      Returns if an email notification should be send immediately if there is a new task for the user or one of his roles.
      void setNotificationDisabled​(boolean notificationDisabled)
      Sets if the whole email notification is disabled or not.
      void setSendDailyTaskSummary​(EnumSet<Weekday> weekdays)
      Sets if a daily task summary on the given weekdays should be sent if the user has one or more open tasks in his task list.
      void setSendDailyTaskSummaryOnDay​(Weekday weekday, boolean sendTaskSummary)
      Sets if a daily task summary on the given weekday should be sent if the user has one or more open tasks in his task list.
      void setSendOnNewWorkTasks​(boolean sendOnNewTasks)
      Sets if an email notification should be send immediately if there is a new task for the user or one of his roles.

    • Method Detail

      • isNotificationDisabled

        boolean isNotificationDisabled()
        Returns if the whole email notification is disabled or not.
        Returns:
        true if the notification is disabled, false if notification is enabled.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • setNotificationDisabled

        void setNotificationDisabled​(boolean notificationDisabled)
        Sets if the whole email notification is disabled or not.
        Parameters:
        notificationDisabled - true if the notification is disabled, false if notification is enabled.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • isSendOnNewWorkTasks

        boolean isSendOnNewWorkTasks()
        Returns if an email notification should be send immediately if there is a new task for the user or one of his roles.
        Returns:
        true if email notification should be send immediately if there is new task for the user or his roles, false if no email should be send for new tasks.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • setSendOnNewWorkTasks

        void setSendOnNewWorkTasks​(boolean sendOnNewTasks)
        Sets if an email notification should be send immediately if there is a new task for the user or one of his roles.
        Parameters:
        sendOnNewTasks - true if email notification should be send immediately if there is new task for the user or his roles, false if no email should be send for new tasks.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • isSendDailyTaskSummaryOnDay

        boolean isSendDailyTaskSummaryOnDay​(Weekday weekday)
        Returns if a daily task summary on the given weekday should be sent if the user has one or more open tasks in his task list.
        Parameters:
        weekday - the day of week for which daily task summaries are sent or not.
        Returns:
        true if daily task summary should be sent on the given weekday, false if no email is sent on the given weekday.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • setSendDailyTaskSummaryOnDay

        void setSendDailyTaskSummaryOnDay​(Weekday weekday,
                                  boolean sendTaskSummary)
        Sets if a daily task summary on the given weekday should be sent if the user has one or more open tasks in his task list.
        Parameters:
        weekday - the day of week for which daily task summaries should be sent or not.
        sendTaskSummary - true if daily task summary should be sent on the given weekday, false if no email is sent on the given weekday.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getSendDailyTaskSummary

        EnumSet<Weekday> getSendDailyTaskSummary()
        Gets the weekdays on which a daily task summary should be sent to the user if the user has one or more open tasks in his task list.
        Returns:
        an EnumSet of Weekday's on which a daily task summary should be sent to the user. On all weekdays not in the set, no email is sent.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • setSendDailyTaskSummary

        void setSendDailyTaskSummary​(EnumSet<Weekday> weekdays)
        Sets if a daily task summary on the given weekdays should be sent if the user has one or more open tasks in his task list.
        Parameters:
        weekdays - an EnumSet of Weekday's on which a daily task summary should be sent to the user. On all weekdays not in the set, no email is sent.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.