de.hybris.platform.notificationfacades.facades

Interface NotificationPreferenceFacade

All Known Implementing Classes:

DefaultNotificationPreferenceFacade

public interface NotificationPreferenceFacade

Facade to get the notification preference and update notification preference

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChannelValue(NotificationChannel channel) Get the channel value for channel
NotificationPreferenceData	getNotificationPreference() Deprecated. since 6.7.Use getNotificationPreferences()
java.util.List<NotificationPreferenceData>	getNotificationPreferences() Get the notification preference data list
NotificationPreferenceDataList	getNotificationPreferences(java.util.List<NotificationPreferenceData> notificationPreferences) Get the notification preference data list
java.util.List<NotificationPreferenceData>	getNotificationPreferences(java.util.Set<NotificationChannel> enabledChannels) Get all notification channels according to enabledChannels
java.util.List<NotificationPreferenceData>	getValidNotificationPreferences() Get the valid notification preference data, for example the mail has mail address, the sms has phone number
java.util.List<NotificationPreferenceData>	getValidNotificationPreferences(java.util.Set<NotificationChannel> enabledChannels) Get the valid notification preference data according to the enabledChannels
void	updateNotificationPreference(java.util.List<NotificationPreferenceData> notificationPreferenceDataList) Update the notification preference to database
void	updateNotificationPreference(NotificationPreferenceData notificationPreferenceData) Deprecated. since 6.7. Use updateNotificationPreference(List notificationPreferenceDataList)

Method Detail

updateNotificationPreference

@Deprecated
void updateNotificationPreference(NotificationPreferenceData notificationPreferenceData)

Deprecated. since 6.7. Use updateNotificationPreference(List notificationPreferenceDataList)

Update the notification preference to database

Parameters:

notificationPreferenceData - The new notification preference to be updated

getNotificationPreference

@Deprecated
NotificationPreferenceData getNotificationPreference()

Deprecated. 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(java.util.List<NotificationPreferenceData> notificationPreferenceDataList)

Update the notification preference to database

Parameters:

notificationPreferenceDataList - The new notification preference to be updated

getNotificationPreferences

NotificationPreferenceDataList getNotificationPreferences(java.util.List<NotificationPreferenceData> notificationPreferences)

Get the notification preference data list

Parameters:

notificationPreferences - the notificationPreference data list

Returns:

The NotificationPreferenceDataList contains all channels info

getNotificationPreferences

java.util.List<NotificationPreferenceData> getNotificationPreferences()

Get the notification preference data list

Returns:

The NotificationPreferenceDataList contains all channels info

getValidNotificationPreferences

java.util.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

java.util.List<NotificationPreferenceData> getValidNotificationPreferences(java.util.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

java.util.List<NotificationPreferenceData> getNotificationPreferences(java.util.Set<NotificationChannel> enabledChannels)

Get all notification channels according to enabledChannels

Parameters:

enabledChannels - the enabled channels

Returns:

return all notification channels according to enabledChannels

getChannelValue

java.lang.String getChannelValue(NotificationChannel channel)

Get the channel value for channel

Parameters:

channel - the notification channel

Returns:

return the related channel value for the channel