Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractChannel - Class in org.exoplatform.commons.api.notification.channel
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014
- AbstractChannel() - Constructor for class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Using the default life-cycle
- AbstractChannel(AbstractNotificationLifecycle) - Constructor for class org.exoplatform.commons.api.notification.channel.AbstractChannel
- AbstractNotificationChildPlugin - Class in org.exoplatform.commons.api.notification.plugin
- AbstractNotificationChildPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
- AbstractNotificationLifecycle - Class in org.exoplatform.commons.api.notification.lifecycle
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014
- AbstractNotificationLifecycle() - Constructor for class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
- AbstractNotificationPlugin - Class in org.exoplatform.commons.api.notification.plugin
- AbstractNotificationPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
- AbstractTemplateBuilder - Class in org.exoplatform.commons.api.notification.channel.template
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 13, 2014
- AbstractTemplateBuilder() - Constructor for class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
- accept(ElementVisitor) - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Accept the visitor to visit the element
- ActionContext - Class in org.exoplatform.commons.api.ui
- ActionContext(String, String) - Constructor for class org.exoplatform.commons.api.ui.ActionContext
- addAdditionalChannel(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- addAttachment(Attachment) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- addChannelPlugin(String, String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
-
Add the pluginId by channel
- addChildPlugin(AbstractNotificationChildPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer
-
Register child plugin in Container
- addKeyMapping(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- addKeyMapping(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- addMutedSpace(long) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- addNewLine(boolean) - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Set the value isNewLine for the case digest
- addPlugin(String, UserSetting.FREQUENCY) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- addPlugin(BaseNotificationPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer
-
Register plugin in Container
- addPlugin(BaseUIPlugin) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService
- addPlugin(BaseUIPlugin) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl
- addPluginInfo(PluginInfo) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- addProvider(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- addTask(Callable) - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService
- append(ArgumentLiteral<T>, Object) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Append the argument literal.
- ArgumentLiteral<T> - Class in org.exoplatform.commons.api.notification.model
- ArgumentLiteral(Class<T>) - Constructor for class org.exoplatform.commons.api.notification.model.ArgumentLiteral
- ArgumentLiteral(Class<T>, String) - Constructor for class org.exoplatform.commons.api.notification.model.ArgumentLiteral
B
- BaseContext - Class in org.exoplatform.commons.api.ui
- BaseContext(String) - Constructor for class org.exoplatform.commons.api.ui.BaseContext
- BaseNotificationLifecycle - Class in org.exoplatform.commons.api.notification.lifecycle
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014
- BaseNotificationLifecycle() - Constructor for class org.exoplatform.commons.api.notification.lifecycle.BaseNotificationLifecycle
- BaseNotificationPlugin - Class in org.exoplatform.commons.api.notification.plugin
- BaseNotificationPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
- BaseUIPlugin - Class in org.exoplatform.commons.api.ui
- BaseUIPlugin() - Constructor for class org.exoplatform.commons.api.ui.BaseUIPlugin
- body(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- BRANDING_COMPANY_NAME_SETTING_KEY - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- BRANDING_PORTAL_NAME - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- buildDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
-
Makes digest message
- buildDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
-
Makes digest message
- buildMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
-
Makes massage
- buildMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
-
Makes massage
- buildMessage(NotificationContext, Map<PluginKey, List<NotificationInfo>>, UserSetting) - Method in interface org.exoplatform.commons.api.notification.service.template.DigestorService
-
Builds information of a message from a list of notification messages.
- buildNotification(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Makes notification
C
- CALENDAR_ACTIVITY - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
-
This value must be the same with CalendarSpaceActivityPublisher.CALENDAR_APP_ID
- CHANNEL_ID_KEY - Static variable in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider
- ChannelConfig - Annotation Interface in org.exoplatform.commons.api.notification.annotation
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014
- channelKey(ChannelKey) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- ChannelKey - Class in org.exoplatform.commons.api.notification.model
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 14, 2014
- ChannelKey(String) - Constructor for class org.exoplatform.commons.api.notification.model.ChannelKey
- ChannelKey(AbstractChannel) - Constructor for class org.exoplatform.commons.api.notification.model.ChannelKey
- ChannelManager - Interface in org.exoplatform.commons.api.notification.channel
- clear() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Clear all of filter optional
- clear() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Reset all statistics
- clearDefaultSetting() - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Reset computed default setting for users
- clone() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral
- clone() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- clone() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- clone() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Creates and returns a copy of this object If class extends NotificationContextImpl and implements method clone(), then must use supper.clone();
- clone(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- compare(Object, Object) - Method in class org.exoplatform.commons.api.notification.model.OrderComparatorASC
- config(PluginConfig) - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Sets the template configure for the element
- countUnreadByPlugin(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
- countUnreadByPlugin(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
- createDigestCount(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback about a digest message being created.
- createMessageInfoCount(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback about a message info being created.
- createNotificationInfoCount(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback about a notification info being created.
D
- DAILY - Enum constant in enum class org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY
- DEFAULT_DIGEST_MORE_KEY - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- DEFAULT_DIGEST_ONE_KEY - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- DEFAULT_DIGEST_THREE_KEY - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- DEFAULT_SIMPLE_DIGEST_KEY - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- DEFAULT_SRC_RESOURCE_BUNDLE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- DEFAULT_SRC_RESOURCE_BUNDLE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- DEFAULT_SRC_RESOURCE_TEMPLATE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- DEFAULT_SUBJECT_KEY - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- DefaultLifecycle - Class in org.exoplatform.commons.api.notification.lifecycle
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Jan 19, 2015
- DefaultLifecycle() - Constructor for class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle
- deleteAllDigests() - Method in interface org.exoplatform.commons.api.notification.service.storage.MailNotificationStorage
-
Removes all digest messages.
- deleteEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback about a entity being deleted
- digest(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationService
-
Collects information of a digest message and sends it daily or weekly.
- DIGEST_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- DIGEST_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- DIGEST_MORE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- DIGEST_MORE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- DIGEST_ONE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- DIGEST_ONE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- DIGEST_THREE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- DIGEST_THREE_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- DigestorService - Interface in org.exoplatform.commons.api.notification.service.template
- digestType(int) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- dispatch(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Process the notification info
- dispatch(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Process the notification information for the specified user.
- doView(RenderRequest, RenderResponse) - Method in class org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet
E
- Element - Interface in org.exoplatform.commons.api.notification.template
- ElementVisitor - Interface in org.exoplatform.commons.api.notification.template
- EMAIL_CHANNEL - Static variable in class org.exoplatform.commons.api.notification.model.UserSetting
- EMAIL_PATTERN - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- enable(boolean) - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage
-
Enable/Disable sending mail message
- end() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
- end() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Finishes to assign states to current MessageInfo instance
- end() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- end() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- end() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- end(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
End the plug in
- EntityStatistics - Interface in org.exoplatform.commons.api.notification.stat
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013
- equals(Object) - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral
- equals(Object) - Method in class org.exoplatform.commons.api.notification.model.ChannelKey
- equals(Object) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- equals(Object) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- equals(Object) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- equals(Object) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- equals(Object) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- exclude(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- exclude(List<String>) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- execute(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.command.NotificationExecutor
- executed(long, long) - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics
- EXO_IS_ACTIVE - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
F
- FEATURE_NAME - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- footer(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- FOOTER_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- FOOTER_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- FOR_ALL_INTERNAL_USER - Static variable in class org.exoplatform.commons.api.notification.model.NotificationInfo
- FOR_ALL_USER - Static variable in class org.exoplatform.commons.api.notification.model.NotificationInfo
- from(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- from(String) - Method in interface org.exoplatform.commons.api.notification.template.TemplateTransformer
-
The template what needs to transform to Value
G
- GenericDispatchedViewPortlet - Class in org.exoplatform.commons.api.portlet
-
This is a generic and simple Portlet class that dispatches the view to a JSP/HTML file.
- GenericDispatchedViewPortlet() - Constructor for class org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet
- get(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Gets the notification settings of a user by his remote Id.
- get(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Gets the notification by the Id
- get(WebNotificationFilter, int, int) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Gets the notification list by the given filter.
- get(WebNotificationFilter, int, int) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Gets the notification list by the given filter.
- getActionUrl() - Method in class org.exoplatform.commons.api.ui.RenderContext
- getActivePluginIds(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Gets all Ids of active plugins by channel.
- getActivePlugins(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Gets information of all active plugins by channel.
- getAdditionalChannels() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getAllChannelPlugins() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getAllPlugins() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Gets information of all plugins.
- getArrayOwnerParameter() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getAttachment() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- getBody() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- getBrandingPortalName() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
-
Get branding Portal Name
- getBrandingService() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getBundlePath() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- getBundlePath() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getBundlePath() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- getByUser(NotificationContext, UserSetting) - Method in interface org.exoplatform.commons.api.notification.service.storage.MailNotificationStorage
-
Gets information of all notifications of a user.
- getChannel() - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
-
Gets the channel
- getChannel(ChannelKey) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Gets the channel by the specified key
- getChannelActives() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getChannelKey() - Method in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider
-
Gets channelId
- getChannelKey() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
-
Gets the channel key of the notification
- getChannelKey() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- getChannelManager() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets the channel manager what contains all channel on Notification
- getChannels() - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Gets list of the channels
- getChildPluginKeys(PluginKey) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer
-
Gets all children plugin keys in plugin
- getCreateDigestCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics
- getCreatedTime() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Gets time to create MessageInfo and use it as node name
- getCreateMessageInfoCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics
- getCreateNotificationInfoCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics
- getDailyPlugins() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getData() - Method in class org.exoplatform.commons.api.ui.Response
- getDateCreated() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getDefaultActivePlugins() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer
- getDefaultChannels() - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
This will use
AbstractChannel.isDefaultChannel()to determine whether the channel will be enabled for plugins by default or not - getDefaultConfig() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- getDefaultConfig() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getDefaultSettings() - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Returns the default settings of an user
- getDeleteCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- getDigestCreatedCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of entity insert
- getDigestDefaultSettingForAllUser(int, int) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Gets all settings of users registering for default daily notifications.
- getDigestSettingForAllUser(NotificationContext, int, int) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Gets the list of user settings which has at least the plug-in to be configured by weekly or daily.
- getDigestSize() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- getEmailSenderEmail() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
- getEmailSenderName() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
- getEntityDeleteCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of entity deletes
- getEntityInsertCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of entity insert
- getEntityLoadCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of entity load
- getEntityStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Gets EntityStatistics by nodeType
- getException() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets the exception if have any when the done processing
- getException() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- getException(Class<T>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets the exception if have any when the done processing
- getExcludedUsersIds() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getExecutionAvgTime() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics
- getExecutionCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics
- getExecutionMaxTime() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics
- getExecutionMinTime() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics
- getExecutionRowCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueryStatistics
- getFirstName(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getFooter() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- getFrequecy(String) - Static method in enum class org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY
- getFrom() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- getFrom() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getFrom(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getFullName(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getGroupConfig() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getGroupId() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- getGroupId() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getGroupPlugins() - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Gets a list of groups containing plugins.
- getGroupProviders() - Method in class org.exoplatform.commons.api.notification.plugin.GroupProviderPlugin
- getId() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Gets ChannelId
- getId() - Method in class org.exoplatform.commons.api.notification.model.ChannelKey
- getId() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Gets the uuid of messageInfo node
- getId() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getId() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Gets Notification Plug in key
- getId() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- getInsertCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- getInstance() - Static method in class org.exoplatform.commons.api.notification.model.UserSetting
- getKey() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Gets Channel Key
- getKey() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral
- getKey() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getKey() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
-
Creates the key for NotificationPlugin
- getKey() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Creates the key for NotificationPlugin
- getKeyMapping() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getKeyMapping() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- getKeyValue(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getKeyValue(String, String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- getLanguage() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- getLanguage() - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Gets the language what belongs to the template
- getLanguage(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getLanguage(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
- getLanguage(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
- getLanguage(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
- getLastModifiedDate() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
-
Get the last modified date
- getLastReadDate() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getLastUpdateTime() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getLifecycle() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Gets the lifecycle what assigned to the channel
- getLifecycle(ChannelKey) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Gets the lifecycle by the ChannelKey
- getLoadCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- getMessageCreatedCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of entity deletes
- getMimeType() - Method in class org.exoplatform.commons.api.ui.Response
- getMutedSpaces() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getName() - Method in class org.exoplatform.commons.api.ui.ActionContext
- getNotificationCreatedCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of entity load
- getNotificationExecutor() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets the NotificationExceutor service
- getNotificationInfo() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets notification information
- getNotificationInfo(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Get the notificationInfo for the provided id
- getNotificationInfos() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets notification message list
- getNotificationInfos(WebNotificationFilter, int, int) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Gets the NotificationInfo list by the given filter.
- getNotificationKey() - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand
-
Gets a notification key associated with the notification command.
- getNotificationMessage(NotificationInfo, boolean) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Deprecated, for removal: This API element is subject to removal in a future version.replaced by Frontend UI building instead of Server end message building
- getNotificationToStore(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
- getNumberOnBadge() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Gets the badge number of the user
- getNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Gets the number on the badge by the specified user
- getNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Gets the number on the badge by the specified user
- getOrder() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- getOrder() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getOrder() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- getOrder() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- getOrder() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getOrganizationService() - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
- getOrganizationService() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
- getOrganizationService() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
- getOrganizationService() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getOwnerParameter() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getParams() - Method in class org.exoplatform.commons.api.ui.BaseContext
- getParentPluginIds() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
-
Gets the parents's id
- getPlugin() - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand
-
Gets a plugin associated with the notification command.
- getPlugin(PluginKey) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer
-
Gets plugin by NotificationKey
- getPluginChannels(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
- getPluginConfig() - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Gets template configure for the element uses it in the case when we need to get the groovy template.
- getPluginConfig(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Gets configuration of a plugin from its Id.
- getPluginConfigs() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
- getPluginContainer() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets the plugin container what contains all plugins on Notification
- getPluginId() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- getPluginId() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getPluginId() - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- getPluginInfos() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- getPluginNames() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get the names of all entities
- getPlugins(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getPlugins(String) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService
- getPlugins(String) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl
- getPluginSettingService() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets the PluginSettingService service
- getPluginStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Gets PluginStatistics by Id
- getPluginType() - Method in class org.exoplatform.commons.api.ui.BaseContext
- getPollCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics
- getPortalName() - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getProviderId() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- getProviders() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- getPutCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics
- getQueries() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get all executed query strings
- getQueryExecutionCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of executed queries
- getQueryExecutionMaxTime() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get the time in milliseconds of the slowest query.
- getQueryExecutionMaxTimeQueryString() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get the query string for the slowest query.
- getQueryStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Gets QueryStatistics by queryString
- getQueuePollCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of poll queue
- getQueuePutCount() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Get global number of put queue
- getQueueStatistics(String) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Gets QueueStatistics by Id
- getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- getResourceBundleKey() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getRsBundle() - Method in class org.exoplatform.commons.api.ui.RenderContext
- getSendToDaily() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getSendToUserIds() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getSendToWeekly() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getSpaceId() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getSpecificChannels() - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
This will use
AbstractChannel.isDefaultChannel()to determine whether the channel is specific for some plugins or not - getStartTime() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Gets the start time of statistics process
- getSubject() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- getTemplate() - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Gets the template of specified element
- getTemplateBuilder() - Method in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider
-
Gets all of the template builder what assigned the channel
- getTemplateBuilder(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Gets the template builder by the specified PluginKey
- getTemplateBuilderInChannel(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
- getTemplateConfig() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- getTemplateContext() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor
-
Gets the template context
- getTemplateEngine() - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
-
Get TemplateEngine of plugin
- getTemplateEngine() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
-
Get TemplateEngine of plugin
- getTemplateEngine() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
-
Get TemplateEngine of plugin
- getTemplateFilePath(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Gets the template by the specified pluginId
- getTemplateFilePathConfigs() - Method in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider
-
Gets all of the template files
- getTemplatePath() - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
- getTemplatePath() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- getTitle() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
-
Gets the title of the notification
- getTo() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- getTo() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getTo(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- getType() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral
- getType() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- getType() - Method in class org.exoplatform.commons.api.ui.BaseUIPlugin
- getUnreadNotification(String, String, String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Gets the notification by the given conditions
- getUpdateCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- getUserId() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getValueOwnerParameter(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- getWeeklyPlugins() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- getWriter() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor
-
Gets the writer.
- GroupConfig - Class in org.exoplatform.commons.api.notification.plugin.config
- GroupConfig() - Constructor for class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- GroupProvider - Class in org.exoplatform.commons.api.notification.model
- GroupProvider(String) - Constructor for class org.exoplatform.commons.api.notification.model.GroupProvider
- GroupProviderPlugin - Class in org.exoplatform.commons.api.notification.plugin
- GroupProviderPlugin(InitParams) - Constructor for class org.exoplatform.commons.api.notification.plugin.GroupProviderPlugin
H
- hashCode() - Method in class org.exoplatform.commons.api.notification.model.ArgumentLiteral
- hashCode() - Method in class org.exoplatform.commons.api.notification.model.ChannelKey
- hashCode() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- hashCode() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- hashCode() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- hashCode() - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- hashCode() - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- hasTemplateBuilder(PluginKey) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Has the template builder of the plugin and the channel
- hidePopover(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Updates the notification's popover status to be FALSE value However it's still showing on View All page.
- hidePopover(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Updates the notification's popover list status to be FALSE value However it's still showing on View All page.
I
- incrementCreateDigestCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics
- incrementCreateMessageCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics
- incrementCreateNotificationCount() - Method in interface org.exoplatform.commons.api.notification.stat.PluginStatistics
- incrementDeleteCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- incrementInsertCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- incrementLoadCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- incrementPollCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics
- incrementPutCount() - Method in interface org.exoplatform.commons.api.notification.stat.QueueStatistics
- incrementUpdateCount() - Method in interface org.exoplatform.commons.api.notification.stat.EntityStatistics
- init(PortletConfig) - Method in class org.exoplatform.commons.api.portlet.GenericDispatchedViewPortlet
- initDefaultSettings(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Adds the default settings to a user's node.
- initDefaultSettings(User[]) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Adds the default settings to a list of users.
- insertEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback about a entity being inserted
- instance() - Static method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- INSTANTLY - Enum constant in enum class org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY
- isActive(String, String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
-
Checks the user's setting for the channel and the plugin if it's active, it's instantly including the email channel.
- isActive(String, String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Checks if a plugin is active or inactive.
- isAllowed(String, String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Checks whether the channel is allowed on designated plugin or not
- isAsync() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService
- isChannelActive(String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Checks if a notification channel is active or inactive.
- isChannelActive(String, String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- isChannelGloballyActive(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- isChildPlugin() - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- isChildPlugin(boolean) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- isDefaultChannel() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
- isEnabled() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- isExcluded(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- isFailed() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
The signal lets you know the processing is successfully or not
- isInDaily(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- isInWeekly(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- isMoveTop() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Gets the the move top value
- isMutable() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- isNewLine() - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Get the value of isNewLine
- isOldPlugin() - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Determines the plugin is old or new mechanism The target adapts the old plugin from PLF 4.1 to work well new mechanism
- isOnPopOver() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- isRead() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- isResetOnBadge() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- isSendAll() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- isSendAllInternals() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- isSpaceMuted(long) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- isStatisticsEnabled() - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Are statistics logged
- isUpdate() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- isValid(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Check, for each plugin, if we will send notification
- isValidEmail(String) - Static method in class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- isWritingProcess() - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Determines the writing processing or NOT
K
- key(String) - Static method in class org.exoplatform.commons.api.notification.model.ChannelKey
- key(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- key(String) - Static method in class org.exoplatform.commons.api.notification.model.PluginKey
- key(AbstractChannel) - Static method in class org.exoplatform.commons.api.notification.model.ChannelKey
- key(PluginKey) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- key(BaseNotificationPlugin) - Static method in class org.exoplatform.commons.api.notification.model.PluginKey
L
- language(String) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- language(String) - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Assigns the language to
- lifecycle() - Element in annotation interface org.exoplatform.commons.api.notification.annotation.ChannelConfig
- LINK_PATTERN - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- loadEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback about a entity being loaded
- LOG - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils
M
- MailNotificationStorage - Interface in org.exoplatform.commons.api.notification.service.storage
- makeCommand(PluginKey) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Makes the NotificationCommand by the NotificationKey
- makeContent(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
- makeDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
-
Makes the Digest message from given NotificationMessage what keep inside NotificationContext
- makeDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.channel.template.PluginTemplateBuilderAdapter
- makeDigest(NotificationContext, Writer) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
-
Makes the Digest message from given NotificationMessage what keep inside NotificationContext
- makeEmailNotification() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- makeMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
-
Makes the MessageInfor from given NotificationMessage what keep inside NotificationContext
- makeMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.channel.template.PluginTemplateBuilderAdapter
- makeMessage(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
-
Makes the MessageInfor from given NotificationMessage what keep inside NotificationContext
- makeNotification() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- makeNotification(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
- makeNotification(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Makes MessageInfo from given information what keep inside NotificationContext
- markAllRead(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Marks all notifications what belong to the user to be read.
- markAllRead(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Marks all notifications what belong to the user to be read.
- markAllRead(List<String>, String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
- markAllRead(List<String>, String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Marks all notifications of the user as read for the designated notification types.
- markRead(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Marks the notification to be read by the userId
- markRead(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Marks the notification to be read by the userId
- MESSAGE_ADDED_IN_QUEUE - Static variable in interface org.exoplatform.commons.api.notification.service.QueueMessage
- MESSAGE_DELETED_FROM_QUEUE - Static variable in interface org.exoplatform.commons.api.notification.service.QueueMessage
- MESSAGE_SENT_FROM_QUEUE - Static variable in interface org.exoplatform.commons.api.notification.service.QueueMessage
- MessageInfo - Class in org.exoplatform.commons.api.notification.model
- MessageInfo() - Constructor for class org.exoplatform.commons.api.notification.model.MessageInfo
N
- newChannelInstance(ChannelKey, String, String) - Static method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- NOT_HIGHLIGHT_COMMENT_PORPERTY - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils
- NOTIFICATION_SENDER_NAME_PATTERN - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- NotificationCommand - Interface in org.exoplatform.commons.api.notification.command
- NotificationCompletionService - Class in org.exoplatform.commons.api.notification.service
- NotificationCompletionService(InitParams) - Constructor for class org.exoplatform.commons.api.notification.service.NotificationCompletionService
- NotificationConstants - Class in org.exoplatform.commons.api.notification
- NotificationConstants() - Constructor for class org.exoplatform.commons.api.notification.NotificationConstants
- NotificationContext - Interface in org.exoplatform.commons.api.notification
- NotificationExecutor - Interface in org.exoplatform.commons.api.notification.command
- NotificationInfo - Class in org.exoplatform.commons.api.notification.model
- NotificationInfo() - Constructor for class org.exoplatform.commons.api.notification.model.NotificationInfo
- NotificationMessageUtils - Class in org.exoplatform.commons.api.notification
-
Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com Dec 30, 2014
- NotificationMessageUtils() - Constructor for class org.exoplatform.commons.api.notification.NotificationMessageUtils
- NotificationPluginUtils - Class in org.exoplatform.commons.api.notification.plugin
- NotificationPluginUtils() - Constructor for class org.exoplatform.commons.api.notification.plugin.NotificationPluginUtils
- NotificationService - Interface in org.exoplatform.commons.api.notification.service.storage
O
- OrderComparatorASC - Class in org.exoplatform.commons.api.notification.model
- OrderComparatorASC() - Constructor for class org.exoplatform.commons.api.notification.model.OrderComparatorASC
- org.exoplatform.commons.api.notification - package org.exoplatform.commons.api.notification
- org.exoplatform.commons.api.notification.annotation - package org.exoplatform.commons.api.notification.annotation
- org.exoplatform.commons.api.notification.channel - package org.exoplatform.commons.api.notification.channel
- org.exoplatform.commons.api.notification.channel.template - package org.exoplatform.commons.api.notification.channel.template
- org.exoplatform.commons.api.notification.command - package org.exoplatform.commons.api.notification.command
- org.exoplatform.commons.api.notification.lifecycle - package org.exoplatform.commons.api.notification.lifecycle
- org.exoplatform.commons.api.notification.model - package org.exoplatform.commons.api.notification.model
- org.exoplatform.commons.api.notification.plugin - package org.exoplatform.commons.api.notification.plugin
- org.exoplatform.commons.api.notification.plugin.config - package org.exoplatform.commons.api.notification.plugin.config
- org.exoplatform.commons.api.notification.service - package org.exoplatform.commons.api.notification.service
- org.exoplatform.commons.api.notification.service.setting - package org.exoplatform.commons.api.notification.service.setting
- org.exoplatform.commons.api.notification.service.storage - package org.exoplatform.commons.api.notification.service.storage
- org.exoplatform.commons.api.notification.service.template - package org.exoplatform.commons.api.notification.service.template
- org.exoplatform.commons.api.notification.stat - package org.exoplatform.commons.api.notification.stat
- org.exoplatform.commons.api.notification.template - package org.exoplatform.commons.api.notification.template
- org.exoplatform.commons.api.portlet - package org.exoplatform.commons.api.portlet
- org.exoplatform.commons.api.ui - package org.exoplatform.commons.api.ui
- out() - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor
-
Gets the content of template after generates.
P
- PlugableUIService - Interface in org.exoplatform.commons.api.ui
- PlugableUIServiceImpl - Class in org.exoplatform.commons.api.ui
- PlugableUIServiceImpl() - Constructor for class org.exoplatform.commons.api.ui.PlugableUIServiceImpl
- PluginConfig - Class in org.exoplatform.commons.api.notification.plugin.config
- PluginConfig() - Constructor for class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- PluginContainer - Interface in org.exoplatform.commons.api.notification.service.setting
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Aug 18, 2013
- pluginId() - Element in annotation interface org.exoplatform.commons.api.notification.annotation.TemplateConfig
- pluginId(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- pluginId(String) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
- PluginInfo - Class in org.exoplatform.commons.api.notification.model
- PluginInfo() - Constructor for class org.exoplatform.commons.api.notification.model.PluginInfo
- PluginKey - Class in org.exoplatform.commons.api.notification.model
- PluginKey(String) - Constructor for class org.exoplatform.commons.api.notification.model.PluginKey
- PluginKey(BaseNotificationPlugin) - Constructor for class org.exoplatform.commons.api.notification.model.PluginKey
- PluginSettingService - Interface in org.exoplatform.commons.api.notification.service.setting
- PluginStatistics - Interface in org.exoplatform.commons.api.notification.stat
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013
- PluginTemplateBuilderAdapter - Class in org.exoplatform.commons.api.notification.channel.template
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 23, 2014
- PluginTemplateBuilderAdapter() - Constructor for class org.exoplatform.commons.api.notification.channel.template.PluginTemplateBuilderAdapter
- pollQueue(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback indicating execution of poll queue
- POPUP_OVER - Static variable in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Define the argument parameter for popup over context
- PREFIX_ID - Static variable in class org.exoplatform.commons.api.notification.model.NotificationInfo
- process(Collection<NotificationInfo>) - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationService
-
Processes information when a list of notification messages are created.
- process(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.storage.NotificationService
-
Processes information when a notification message is created.
- process(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
-
Process the notification for the user
- process(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.lifecycle.BaseNotificationLifecycle
- process(NotificationContext, String) - Method in class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle
- process(NotificationContext, String...) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
-
Process the notification for multi-users
- process(NotificationContext, String...) - Method in class org.exoplatform.commons.api.notification.lifecycle.BaseNotificationLifecycle
- process(NotificationContext, String...) - Method in class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle
- processAction(ActionContext) - Method in class org.exoplatform.commons.api.ui.BaseUIPlugin
- processAction(ActionContext) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService
- processAction(ActionContext) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl
- processNotification(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.command.NotificationCommand
-
Builds information of a notification from the notification context.
- put(MessageInfo) - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage
-
Puts the message into the queue
- putQueue(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback indicating execution of put queue
Q
- queryExecuted(String, long, long) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback indicating execution of a query statement
- QueryStatistics - Interface in org.exoplatform.commons.api.notification.stat
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013
- QueueMessage - Interface in org.exoplatform.commons.api.notification.service
- QueueStatistics - Interface in org.exoplatform.commons.api.notification.stat
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 11, 2013
R
- READ_PORPERTY - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils
-
Deprecated, for removal: This API element is subject to removal in a future version.Use
NotificationInfo.isRead()instead - register(AbstractChannel) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Register new channel
- registerGroupConfig(GroupProviderPlugin) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Registers the plugin configuration of a group.
- registerOverrideTemplateProvider(TemplateProvider) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Register and override the Template provider
- registerPluginConfig(PluginConfig) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Registers configuration of a plugin.
- registerTemplateProvider(TemplateProvider) - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Register the template provider to the channel.
- registerTemplateProvider(TemplateProvider) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Register the Template provider
- remove(long) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Remove the NotificationInfo live after X days
- remove(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Removes the notification by given Id
- remove(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Removes the notification by the notificationId
- remove(String, long) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Remove the NotificationInfo live after X days
- remove(ArgumentLiteral<T>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Removes the query parameter.
- remove(PluginKey) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginContainer
-
Removes plugin in Container
- removeAll() - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage
-
Removes all queue elements
- removeChannelActive(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- removeChannelPlugin(String, String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
-
remove the pluginId on channel
- removeMessageAfterSent(NotificationContext) - Method in interface org.exoplatform.commons.api.notification.service.storage.MailNotificationStorage
-
Removes all messages after they have been sent.
- removeMutedSpace(long) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- removeOnSendToDaily(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- removeOnSendToWeekly(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- removePlugin(String, UserSetting.FREQUENCY) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- render(RenderContext) - Method in class org.exoplatform.commons.api.ui.BaseUIPlugin
- render(RenderContext) - Method in interface org.exoplatform.commons.api.ui.PlugableUIService
- render(RenderContext) - Method in class org.exoplatform.commons.api.ui.PlugableUIServiceImpl
- RenderContext - Class in org.exoplatform.commons.api.ui
- RenderContext(String) - Constructor for class org.exoplatform.commons.api.ui.RenderContext
- resetNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Reset the number on badge of the specified user
- resetNumberOnBadge(String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
- resetNumberOnBadge(List<String>, String) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
- resetNumberOnBadge(List<String>, String) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Reset badge on notifications of the user for the designated notification types.
- resolve(String) - Method in class org.exoplatform.commons.api.ui.RenderContext
- Response - Class in org.exoplatform.commons.api.ui
- Response(byte[], String) - Constructor for class org.exoplatform.commons.api.ui.Response
S
- save(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.storage.MailNotificationStorage
-
Saves information of a notification.
- save(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Creates the new notification message to the specified user.
- save(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.service.WebNotificationService
-
Creates the new notification message to the specified user.
- save(UserSetting) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Saves the notification settings of a user.
- saveActivePlugin(String, String, boolean) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Saves a plugin.
- saveChannelStatus(String, boolean) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Saves a status for a given Channel
- saveEmailSender(String, String) - Method in interface org.exoplatform.commons.api.notification.service.setting.PluginSettingService
-
Saves email notification sender settings
- saveLastReadDate(String, Long) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Stores the read time point when user clicks mark all read his/her messages.
- send() - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage
-
Peek the message from queue and send
- send(NotificationContext) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
-
Sends the message by Mail, UI or any the configured channel
- send(NotificationContext) - Method in class org.exoplatform.commons.api.notification.lifecycle.DefaultLifecycle
- sendMessage(MessageInfo) - Method in interface org.exoplatform.commons.api.notification.service.QueueMessage
-
Sends mail instantly without passing by queue (use directly the mail service).
- setActionUrl(String) - Method in class org.exoplatform.commons.api.ui.RenderContext
- setAdditionalChannels(List<String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setAllChannelPlugins(Map<String, List<String>>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setBundlePath(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- setBundlePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setBundlePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- setChannel(AbstractChannel) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
-
Sets the channel to the lifecycle
- setChannelActive(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setChannelActives(Set<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setChannelKey(ChannelKey) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
-
Sets the channel of the notification
- setChannelPlugins(String, List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setCreatedTime(long) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- setDailyPlugins(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setData(byte[]) - Method in class org.exoplatform.commons.api.ui.Response
- setDateCreated(Calendar) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setDefaultConfig(List<String>) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- setDefaultConfig(List<String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setEnabled(boolean) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setException(Throwable) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Sets the exception if have any when the done processing
- setException(Throwable) - Method in class org.exoplatform.commons.api.notification.service.template.TemplateContext
-
Holds the exception if have any on transform processing.
- setFrom(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setGroupConfig(GroupConfig) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setGroupId(String) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- setGroupId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setId(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Sets the uuid of messageInfo node
- setId(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- setKeyMapping(Map<String, String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setKeyMapping(Map<String, String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- setLastModifiedDate(long) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setLastModifiedDate(Calendar) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setLastReadDate(long) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setLastUpdateTime(Calendar) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setMimeType(String) - Method in class org.exoplatform.commons.api.ui.Response
- setMoveTop(boolean) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Sets the the move top value
- setMutable(boolean) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- setMutedSpaces(List<Long>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setName(String) - Method in class org.exoplatform.commons.api.ui.ActionContext
- setNotificationInfo(NotificationInfo) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Sets notification infomation
- setNotificationInfos(List<NotificationInfo>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Sets notification information list
- setNumberOnBadge(int) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
-
Sets the badge number of the user
- setOldPlugin(boolean) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Sets the flag value TRUE/FALSE The target adapts the old plugin on PLF 4.1 to work well new mechanism
- setOnPopOver(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setOrder(int) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- setOrder(int) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setOrder(int) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- setOrder(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- setOrder(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setOwnerParameter(Map<String, String>) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setParameter(String, String) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter
- setParams(Map<String, List<String>>) - Method in class org.exoplatform.commons.api.ui.BaseContext
- setPluginId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setPluginInfos(List<PluginInfo>) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- setPluginKey(PluginKey) - Method in class org.exoplatform.commons.api.notification.model.WebNotificationFilter
- setProviderId(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- setProviders(List<String>) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- setRead(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setResetOnBadge(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.model.GroupProvider
- setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.GroupConfig
- setResourceBundleKey(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setRsBundle(ResourceBundle) - Method in class org.exoplatform.commons.api.ui.RenderContext
- setSendAll(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setSendAllInternals(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setSendToDaily(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setSendToDaily(String[]) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setSendToWeekly(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setSendToWeekly(String[]) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setSpaceId(long) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setStatisticsEnabled(boolean) - Method in interface org.exoplatform.commons.api.notification.stat.Statistics
-
Sets is running on statistic mode.
- setTemplateConfig(TemplateConfig) - Method in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- setTemplateEngine(Template) - Method in class org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder
-
Set TemplateEngine for plugin
- setTemplateEngine(Template) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
-
Set TemplateEngine for plugin
- setTemplateEngine(Template) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationPlugin
-
Set TemplateEngine for plugin
- setTemplatePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.AbstractNotificationChildPlugin
- setTemplatePath(String) - Method in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- setTitle(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
-
Sets the title of the notification
- setTo(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setType(String) - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- setUpdate(boolean) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- setUserEnabled(String, boolean) - Method in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
-
Enables user settings
- setUserId(String) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setWeeklyPlugins(List<String>) - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- setWritingProcess(boolean) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Sets the writing status to the context
- SHOW_POPOVER_PROPERTY - Static variable in class org.exoplatform.commons.api.notification.NotificationMessageUtils
-
Deprecated, for removal: This API element is subject to removal in a future version.Use
NotificationInfo.isOnPopOver()instead - sizeChannels() - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Gets size of channels has been registered
- start() - Method in class org.exoplatform.commons.api.notification.channel.AbstractChannel
-
Initialize something when starts to work the channel
- start() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService
- start(NotificationContext) - Method in class org.exoplatform.commons.api.notification.plugin.BaseNotificationPlugin
-
Start the plug in
- Statistics - Interface in org.exoplatform.commons.api.notification.stat
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013
- StatisticsCollector - Interface in org.exoplatform.commons.api.notification.stat
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Oct 10, 2013
- stop() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService
- store(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
-
Storage the notification into the db
- styleCSS - Static variable in class org.exoplatform.commons.api.notification.NotificationConstants
- subject(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- SUBJECT_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.PluginConfig
- SUBJECT_KEY - Static variable in class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
T
- template() - Element in annotation interface org.exoplatform.commons.api.notification.annotation.TemplateConfig
- template(String) - Method in interface org.exoplatform.commons.api.notification.template.Element
-
Assigns the template to the element
- templateBuilders - Variable in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider
- TemplateConfig - Class in org.exoplatform.commons.api.notification.plugin.config
- TemplateConfig - Annotation Interface in org.exoplatform.commons.api.notification.annotation
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014
- TemplateConfig() - Constructor for class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- TemplateConfig(String) - Constructor for class org.exoplatform.commons.api.notification.plugin.config.TemplateConfig
- TemplateConfigs - Annotation Interface in org.exoplatform.commons.api.notification.annotation
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014
- TemplateContext - Class in org.exoplatform.commons.api.notification.service.template
- TemplateContext() - Constructor for class org.exoplatform.commons.api.notification.service.template.TemplateContext
- TemplateContext(String, String) - Constructor for class org.exoplatform.commons.api.notification.service.template.TemplateContext
- templateFilePaths - Variable in class org.exoplatform.commons.api.notification.channel.template.TemplateProvider
- templateHandler() - Element in annotation interface org.exoplatform.commons.api.notification.annotation.ChannelConfig
- TemplateProvider - Class in org.exoplatform.commons.api.notification.channel.template
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014
- TemplateProvider(InitParams) - Constructor for class org.exoplatform.commons.api.notification.channel.template.TemplateProvider
- templates() - Element in annotation interface org.exoplatform.commons.api.notification.annotation.TemplateConfigs
- TemplateTransformer - Interface in org.exoplatform.commons.api.notification.template
-
Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Aug 1, 2013
- to(String) - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- to(String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- to(List<String>) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- toJSON() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- toString() - Method in class org.exoplatform.commons.api.notification.model.ChannelKey
- toString() - Method in class org.exoplatform.commons.api.notification.model.MessageInfo
- toString() - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- toString() - Method in class org.exoplatform.commons.api.notification.model.PluginInfo
- toString() - Method in class org.exoplatform.commons.api.notification.model.UserSetting
- transform(TemplateContext) - Method in interface org.exoplatform.commons.api.notification.template.TemplateTransformer
-
The execution transform from template to value base on the TemplateContext.
U
- unregister(AbstractChannel) - Method in interface org.exoplatform.commons.api.notification.channel.ChannelManager
-
Unregister the specified channel
- update(NotificationInfo) - Method in class org.exoplatform.commons.api.notification.lifecycle.AbstractNotificationLifecycle
-
Update an existing notification
- update(NotificationInfo, boolean) - Method in interface org.exoplatform.commons.api.notification.service.storage.WebNotificationStorage
-
Update an existing notification message.
- updateEntity(String) - Method in interface org.exoplatform.commons.api.notification.stat.StatisticsCollector
-
Callback about a entity being updated
- USER_NOTIFICATION_MODIFIED_EVENT - Static variable in interface org.exoplatform.commons.api.notification.service.setting.UserSettingService
- UserSetting - Class in org.exoplatform.commons.api.notification.model
-
User setting notification
- UserSetting() - Constructor for class org.exoplatform.commons.api.notification.model.UserSetting
- UserSetting.FREQUENCY - Enum Class in org.exoplatform.commons.api.notification.model
- UserSettingService - Interface in org.exoplatform.commons.api.notification.service.setting
V
- value(ArgumentLiteral<T>) - Method in interface org.exoplatform.commons.api.notification.NotificationContext
-
Gets FilterOption which was existing.
- valueOf(String) - Static method in enum class org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY
-
Returns an array containing the constants of this enum class, in the order they are declared.
- visit(Element) - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor
-
To visit the element and generate
W
- waitCompletionFinished() - Method in class org.exoplatform.commons.api.notification.service.NotificationCompletionService
- WebNotificationFilter - Class in org.exoplatform.commons.api.notification.model
- WebNotificationFilter(String) - Constructor for class org.exoplatform.commons.api.notification.model.WebNotificationFilter
- WebNotificationFilter(String, boolean) - Constructor for class org.exoplatform.commons.api.notification.model.WebNotificationFilter
- WebNotificationFilter(String, List<PluginKey>, boolean) - Constructor for class org.exoplatform.commons.api.notification.model.WebNotificationFilter
- WebNotificationService - Interface in org.exoplatform.commons.api.notification.service
- WebNotificationStorage - Interface in org.exoplatform.commons.api.notification.service.storage
- WEEKLY - Enum constant in enum class org.exoplatform.commons.api.notification.model.UserSetting.FREQUENCY
- with(String, String) - Method in class org.exoplatform.commons.api.notification.model.NotificationInfo
- with(List<NotificationCommand>) - Method in interface org.exoplatform.commons.api.notification.command.NotificationExecutor
- with(NotificationCommand) - Method in interface org.exoplatform.commons.api.notification.command.NotificationExecutor
- with(TemplateContext) - Method in interface org.exoplatform.commons.api.notification.template.ElementVisitor
-
Attaches the Template Context for Template generate.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form