Package org.exoplatform.commons.notification.channel

Class WebChannel

  • All Implemented Interfaces:
    org.exoplatform.container.component.ComponentPlugin
    public class WebChannel
extends org.exoplatform.commons.api.notification.channel.AbstractChannel
    Created by The eXo Platform SAS Author : eXoPlatform thanhvc@exoplatform.com Dec 12, 2014

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ID  
      static org.exoplatform.commons.api.notification.model.ArgumentLiteral<org.exoplatform.commons.api.notification.model.MessageInfo> MESSAGE_INFO  

      • Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

        desc, name

    • Constructor Summary

      Constructors 
      Constructor Description
      WebChannel()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void dispatch​(org.exoplatform.commons.api.notification.NotificationContext ctx, String userId)  
      String getId()  
      org.exoplatform.commons.api.notification.model.ChannelKey getKey()  
      protected org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder getTemplateBuilderInChannel​(org.exoplatform.commons.api.notification.model.PluginKey key)  
      String getTemplateFilePath​(org.exoplatform.commons.api.notification.model.PluginKey key)  
      boolean hasTemplateBuilder​(org.exoplatform.commons.api.notification.model.PluginKey key)  
      void registerTemplateProvider​(org.exoplatform.commons.api.notification.channel.template.TemplateProvider provider)  

      • Methods inherited from class org.exoplatform.commons.api.notification.channel.AbstractChannel

        dispatch, end, getLifecycle, getTemplateBuilder, start

      • Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

        getDescription, getName, setDescription, setName

    • Field Detail

      • MESSAGE_INFO

        public static final org.exoplatform.commons.api.notification.model.ArgumentLiteral<org.exoplatform.commons.api.notification.model.MessageInfo> MESSAGE_INFO

    • Constructor Detail

      • WebChannel

        public WebChannel()

    • Method Detail

      • getId

        public String getId()
        Specified by:
        getId in class org.exoplatform.commons.api.notification.channel.AbstractChannel

      • getKey

        public org.exoplatform.commons.api.notification.model.ChannelKey getKey()
        Specified by:
        getKey in class org.exoplatform.commons.api.notification.channel.AbstractChannel

      • registerTemplateProvider

        public void registerTemplateProvider​(org.exoplatform.commons.api.notification.channel.template.TemplateProvider provider)
        Specified by:
        registerTemplateProvider in class org.exoplatform.commons.api.notification.channel.AbstractChannel

      • dispatch

        public void dispatch​(org.exoplatform.commons.api.notification.NotificationContext ctx,
                     String userId)
        Specified by:
        dispatch in class org.exoplatform.commons.api.notification.channel.AbstractChannel

      • getTemplateFilePath

        public String getTemplateFilePath​(org.exoplatform.commons.api.notification.model.PluginKey key)
        Overrides:
        getTemplateFilePath in class org.exoplatform.commons.api.notification.channel.AbstractChannel

      • hasTemplateBuilder

        public boolean hasTemplateBuilder​(org.exoplatform.commons.api.notification.model.PluginKey key)
        Overrides:
        hasTemplateBuilder in class org.exoplatform.commons.api.notification.channel.AbstractChannel

      • getTemplateBuilderInChannel

        protected org.exoplatform.commons.api.notification.channel.template.AbstractTemplateBuilder getTemplateBuilderInChannel​(org.exoplatform.commons.api.notification.model.PluginKey key)
        Specified by:
        getTemplateBuilderInChannel in class org.exoplatform.commons.api.notification.channel.AbstractChannel