Interface NotificationPreferenceFacade
- All Known Implementing Classes:
DefaultNotificationPreferenceFacade
public interface NotificationPreferenceFacade
Facade to get the notification preference and update notification preference
-
Method Summary
Modifier and TypeMethodDescriptiongetChannelValue(NotificationChannel channel) Get the channel value for channelDeprecated, for removal: This API element is subject to removal in a future version.since 6.7.Use getNotificationPreferences()Get the notification preference data listgetNotificationPreferences(List<NotificationPreferenceData> notificationPreferences) Get the notification preference data listgetNotificationPreferences(Set<NotificationChannel> enabledChannels) Get all notification channels according to enabledChannelsGet the valid notification preference data, for example the mail has mail address, the sms has phone numbergetValidNotificationPreferences(Set<NotificationChannel> enabledChannels) Get the valid notification preference data according to the enabledChannelsvoidupdateNotificationPreference(NotificationPreferenceData notificationPreferenceData) Deprecated, for removal: This API element is subject to removal in a future version.since 6.7.voidupdateNotificationPreference(List<NotificationPreferenceData> notificationPreferenceDataList) Update the notification preference to database
-
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(ListnotificationPreferenceDataList) Update the notification preference to database- Parameters:
notificationPreferenceData- The new notification preference to be updated
-
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
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
Get the channel value for channel- Parameters:
channel- the notification channel- Returns:
- return the related channel value for the channel
-