abstract class Plugin extends AnyRef

Trait for define plugin interface. To provide a plugin, put a Plugin class which extends this class into the package root.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Plugin
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Plugin()

Abstract Value Members

  1. abstract val description: String
  2. abstract val pluginId: String
  3. abstract val pluginName: String
  4. abstract val versions: Seq[Version]

Concrete Value Members

  1. def accountSettingMenus(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) ⇒ Option[Link]]

    Override to add account setting menus.

  2. val accountSettingMenus: Seq[(Context) ⇒ Option[Link]]

    Override to add account setting menus.

  3. def assetsMappings(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, String)]

    Override to add assets mappings.

  4. val assetsMappings: Seq[(String, String)]

    Override to add assets mappings.

  5. def controllers(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, ControllerBase)]

    Override to declare this plug-in provides controllers.

  6. val controllers: Seq[(String, ControllerBase)]

    Override to declare this plug-in provides controllers.

  7. def dashboardTabs(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) ⇒ Option[Link]]

    Override to add dashboard tabs.

  8. val dashboardTabs: Seq[(Context) ⇒ Option[Link]]

    Override to add dashboard tabs.

  9. def globalMenus(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) ⇒ Option[Link]]

    Override to add global menus.

  10. val globalMenus: Seq[(Context) ⇒ Option[Link]]

    Override to add global menus.

  11. def images(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, Array[Byte])]

    Override to declare this plug-in provides images.

  12. val images: Seq[(String, Array[Byte])]

    Override to declare this plug-in provides images.

  13. def initialize(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Unit

    This method is invoked in initialization of plugin system.

    This method is invoked in initialization of plugin system. Register plugin functionality to PluginRegistry.

  14. def javaScripts(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, String)]

    Override to declare this plug-in provides JavaScript.

  15. val javaScripts: Seq[(String, String)]

    Override to declare this plug-in provides JavaScript.

  16. def profileTabs(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Account, Context) ⇒ Option[Link]]

    Override to add profile tabs.

  17. val profileTabs: Seq[(Account, Context) ⇒ Option[Link]]

    Override to add profile tabs.

  18. def receiveHooks(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[ReceiveHook]

    Override to add receive hooks.

  19. val receiveHooks: Seq[ReceiveHook]

    Override to add receive hooks.

  20. def renderers(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, Renderer)]

    Override to declare this plug-in provides renderers.

  21. val renderers: Seq[(String, Renderer)]

    Override to declare this plug-in provides renderers.

  22. def repositoryHooks(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[RepositoryHook]

    Override to add repository hooks.

  23. val repositoryHooks: Seq[RepositoryHook]

    Override to add repository hooks.

  24. def repositoryMenus(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(RepositoryInfo, Context) ⇒ Option[Link]]

    Override to add repository menus.

  25. val repositoryMenus: Seq[(RepositoryInfo, Context) ⇒ Option[Link]]

    Override to add repository menus.

  26. def repositoryRoutings(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[GitRepositoryRouting]

    Override to add git repository routings.

  27. val repositoryRoutings: Seq[GitRepositoryRouting]

    Override to add git repository routings.

  28. def repositorySettingTabs(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(RepositoryInfo, Context) ⇒ Option[Link]]

    Override to add repository setting tabs.

  29. val repositorySettingTabs: Seq[(RepositoryInfo, Context) ⇒ Option[Link]]

    Override to add repository setting tabs.

  30. def shutdown(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Unit

    This method is invoked in shutdown of plugin system.

    This method is invoked in shutdown of plugin system. If the plugin has any resources, release them in this method.

  31. def suggestionProviders(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[SuggestionProvider]

    Override to add suggestion provider.

  32. val suggestionProviders: Seq[SuggestionProvider]

    Override to add suggestion provider.

  33. def systemSettingMenus(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) ⇒ Option[Link]]

    Override to add system setting menus.

  34. val systemSettingMenus: Seq[(Context) ⇒ Option[Link]]

    Override to add system setting menus.

  35. def textDecorators(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[TextDecorator]

    Override to add text decorators.

  36. val textDecorators: Seq[TextDecorator]

    Override to add text decorators.