org.exoplatform.commons.api.notification.service.setting

Interface UserSettingService

public interface UserSettingService

Method Summary

Methods

Modifier and Type	Method and Description
void	addMixin(String userId) Adds the default settings to a user's node.
void	addMixin(org.exoplatform.services.organization.User[] users) Adds the default settings to a list of users.
UserSetting	get(String userId) Gets the notification settings of a user by his remote Id.
List<UserSetting>	getDigestDefaultSettingForAllUser(int offset, int limit) Gets all settings of users registering for default daily notifications.
List<UserSetting>	getDigestSettingForAllUser(NotificationContext context, int offset, int limit) Gets the list of user settings which has at least the plug-in to be configured by weekly or daily.
List<String>	getUserHasSettingPlugin(String channelId, String pluginId) Gets all Ids of users registering for notifications by a given plugin.
List<String>	getUserSettingByPlugin(String pluginId) Deprecated. - Replace by getUserHasSettingPlugin(String, String)
List<UserSetting>	getUserSettingWithDeactivate() Gets all settings of users who deactivated is FALSE
void	save(UserSetting notificationSetting) Saves the notification settings of a user.
void	saveLastReadDate(String userId, Long time) Stores the read time point when user clicks mark all read his/her messages.

Method Detail

save

void save(UserSetting notificationSetting)

Saves the notification settings of a user.

Parameters:

notificationSetting - The notification settings.

get

UserSetting get(String userId)

Gets the notification settings of a user by his remote Id.

Parameters:

userId - The user's remote Id.

Returns:

The notification settings.

getDigestSettingForAllUser

List<UserSetting> getDigestSettingForAllUser(NotificationContext context,
                                           int offset,
                                           int limit)

Gets the list of user settings which has at least the plug-in to be configured by weekly or daily. the weekly or daily condition input by NotificationContext.

Parameters:

context - the weekly or daily condition

offset - The start point from which the user settings are got.

limit - The limited number of user settings.

Returns:

The list of user settings.

getDigestDefaultSettingForAllUser

List<UserSetting> getDigestDefaultSettingForAllUser(int offset,
                                                  int limit)

Gets all settings of users registering for default daily notifications.

Parameters:

offset - The start point from which the user settings are got.

limit - The limited number of user settings.

Returns:

The list of user settings.

getUserSettingWithDeactivate

List<UserSetting> getUserSettingWithDeactivate()

Gets all settings of users who deactivated is FALSE

Returns:

getUserSettingByPlugin

List<String> getUserSettingByPlugin(String pluginId)

Deprecated. - Replace by getUserHasSettingPlugin(String, String)

Gets all Ids of users registering for email notifications by a given plugin.

Parameters:

pluginId - Id of the plugin.

Returns:

The remote Ids of users.

getUserHasSettingPlugin

List<String> getUserHasSettingPlugin(String channelId,
                                   String pluginId)

Gets all Ids of users registering for notifications by a given plugin.

Parameters:

pluginId - Id of the plugin.

Returns:

The remote Ids of users.

addMixin

void addMixin(String userId)

Adds the default settings to a user's node.

Parameters:

userId - The user's remote Id.

addMixin

void addMixin(org.exoplatform.services.organization.User[] users)

Adds the default settings to a list of users.

Parameters:

users - The list of users.

saveLastReadDate

void saveLastReadDate(String userId,
                    Long time)

Stores the read time point when user clicks mark all read his/her messages. This value will be using to decide the read status of message. + If less than the read time point, Read = TRUE + Else depends on the the status of the message

Parameters:

userId - The user's id

time - The time milliseconds

Since:

PLF 4.2