Package org.xwiki.notifications.preferences.email

Interface NotificationEmailUserPreferenceManager

@Role
public interface NotificationEmailUserPreferenceManager

Configuration for the emails for each user.

Since:

9.11RC1

Version:

$Id: 9a0053274cd8a2d6b94ecca3567cd879d529b214 $

Method Summary

Modifier and Type	Method	Description
NotificationEmailDiffType	getDiffType()
NotificationEmailDiffType	getDiffType(String userId)	Deprecated. since 14.10, use getDiffType(UserReference) instead
default NotificationEmailDiffType	getDiffType(org.xwiki.user.UserReference userReference)
default String	getEmailGroupingStrategy(org.xwiki.user.UserReference userReference, NotificationEmailInterval interval)	Retrieve the preferences related to email grouping strategy for the given user and the given interval.
default NotificationEmailInterval	getInterval()
default NotificationEmailInterval	getInterval(org.xwiki.user.UserReference userReference)

Method Detail

getDiffType

NotificationEmailDiffType getDiffType()

Returns:

the diff type configured for the current user

getDiffType

@Deprecated(since="14.10")
NotificationEmailDiffType getDiffType(String userId)

Deprecated.

since 14.10, use getDiffType(UserReference) instead

Parameters:

userId - id of a user

Returns:

the diff type configured for the given user

getDiffType

@Unstable
default NotificationEmailDiffType getDiffType(org.xwiki.user.UserReference userReference)

Parameters:

userReference - reference of a user

Returns:

the diff type configured for the given user

Since:

14.10

getInterval

@Unstable
default NotificationEmailInterval getInterval()

Returns:

the notification interval configured for the current user

Since:

14.10

getInterval

@Unstable
default NotificationEmailInterval getInterval(org.xwiki.user.UserReference userReference)

Parameters:

userReference - reference of a user

Returns:

the notification interval configured for the given user

Since:

14.10

getEmailGroupingStrategy

@Unstable
default String getEmailGroupingStrategy(org.xwiki.user.UserReference userReference,
                                        NotificationEmailInterval interval)

Retrieve the preferences related to email grouping strategy for the given user and the given interval. This method fallbacks on user's wiki preferences, then main wiki preferences, then global configuration.

Parameters:

userReference - the user for which to take the preferences

interval - the interval strategy for which to find the strategy to use

Returns:

the hint of the strategy to use

Since:

15.6RC1