Interface NotificationPreferenceFacade

All Known Implementing Classes:
DefaultNotificationPreferenceFacade

public interface NotificationPreferenceFacade
Facade to get the notification preference and update notification preference
  • Method Details

    • updateNotificationPreference

      @Deprecated(since="6.7", forRemoval=true) void updateNotificationPreference(NotificationPreferenceData notificationPreferenceData)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 6.7. Use updateNotificationPreference(List notificationPreferenceDataList)
      Update the notification preference to database
      Parameters:
      notificationPreferenceData - The new notification preference to be updated
    • getNotificationPreference

      @Deprecated(since="6.7", forRemoval=true) NotificationPreferenceData getNotificationPreference()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 6.7.Use getNotificationPreferences()
      Get the notification preference
      Returns:
      The NotificationPreferenceData contains the enabled channels,and email address and mobile phone number if exist
    • updateNotificationPreference

      void updateNotificationPreference(List<NotificationPreferenceData> notificationPreferenceDataList)
      Update the notification preference to database
      Parameters:
      notificationPreferenceDataList - The new notification preference to be updated
    • getNotificationPreferences

      NotificationPreferenceDataList getNotificationPreferences(List<NotificationPreferenceData> notificationPreferences)
      Get the notification preference data list
      Parameters:
      notificationPreferences - the notificationPreference data list
      Returns:
      The NotificationPreferenceDataList contains all channels info
    • getNotificationPreferences

      List<NotificationPreferenceData> getNotificationPreferences()
      Get the notification preference data list
      Returns:
      The NotificationPreferenceDataList contains all channels info
    • getValidNotificationPreferences

      List<NotificationPreferenceData> getValidNotificationPreferences()
      Get the valid notification preference data, for example the mail has mail address, the sms has phone number
      Returns:
      The NotificationPreferenceDataList contains the valid channels info
    • getValidNotificationPreferences

      List<NotificationPreferenceData> getValidNotificationPreferences(Set<NotificationChannel> enabledChannels)
      Get the valid notification preference data according to the enabledChannels
      Parameters:
      enabledChannels - the enabled channels
      Returns:
      The NotificationPreferenceDataList contains the valid channels info
    • getNotificationPreferences

      List<NotificationPreferenceData> getNotificationPreferences(Set<NotificationChannel> enabledChannels)
      Get all notification channels according to enabledChannels
      Parameters:
      enabledChannels - the enabled channels
      Returns:
      return all notification channels according to enabledChannels
    • getChannelValue

      String getChannelValue(NotificationChannel channel)
      Get the channel value for channel
      Parameters:
      channel - the notification channel
      Returns:
      return the related channel value for the channel