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. Protected

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def accountHooks(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[AccountHook]

    Override to add account hooks.

  5. val accountHooks: Seq[AccountHook]

    Override to add account hooks.

  6. def accountSettingMenus(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) => Option[Link]]

    Override to add account setting menus.

  7. val accountSettingMenus: Seq[(Context) => Option[Link]]

    Override to add account setting menus.

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

    Override to declare this plug-in provides anonymous accessible paths.

  9. val anonymousAccessiblePaths: Seq[String]

    Override to declare this plug-in provides anonymous accessible paths.

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def assetsMappings(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, String)]

    Override to add assets mappings.

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

    Override to add assets mappings.

  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. def controllers(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, ControllerBase)]

    Override to declare this plug-in provides controllers.

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

    Override to declare this plug-in provides controllers.

  16. def dashboardTabs(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) => Option[Link]]

    Override to add dashboard tabs.

  17. val dashboardTabs: Seq[(Context) => Option[Link]]

    Override to add dashboard tabs.

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. def fromClassPath(path: String): Array[Byte]

    Helper method to get a resource from classpath.

    Helper method to get a resource from classpath.

    Attributes
    protected
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def globalMenus(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) => Option[Link]]

    Override to add global menus.

  24. val globalMenus: Seq[(Context) => Option[Link]]

    Override to add global menus.

  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def images(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, Array[Byte])]

    Override to declare this plug-in provides images.

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

    Override to declare this plug-in provides images.

  28. 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.

  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def issueHooks(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[IssueHook]

    Override to add issue hooks.

  31. val issueHooks: Seq[IssueHook]

    Override to add issue hooks.

  32. def issueSidebars(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Issue, RepositoryInfo, Context) => Option[Html]]

    Override to add issue sidebars.

  33. val issueSidebars: Seq[(Issue, RepositoryInfo, Context) => Option[Html]]

    Override to add issue sidebars.

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

    Override to declare this plug-in provides JavaScript.

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

    Override to declare this plug-in provides JavaScript.

  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def profileTabs(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Account, Context) => Option[Link]]

    Override to add profile tabs.

  40. val profileTabs: Seq[(Account, Context) => Option[Link]]

    Override to add profile tabs.

  41. def pullRequestHooks(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[PullRequestHook]

    Override to add pull request hooks.

  42. val pullRequestHooks: Seq[PullRequestHook]

    Override to add pull request hooks.

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

    Override to add receive hooks.

  44. val receiveHooks: Seq[ReceiveHook]

    Override to add receive hooks.

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

    Override to declare this plug-in provides renderers.

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

    Override to declare this plug-in provides renderers.

  47. def repositoryHeaders(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(RepositoryInfo, Context) => Option[Html]]

    Override to add repository headers.

  48. val repositoryHeaders: Seq[(RepositoryInfo, Context) => Option[Html]]

    Override to add repository headers.

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

    Override to add repository hooks.

  50. val repositoryHooks: Seq[RepositoryHook]

    Override to add repository hooks.

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

    Override to add repository menus.

  52. val repositoryMenus: Seq[(RepositoryInfo, Context) => Option[Link]]

    Override to add repository menus.

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

    Override to add git repository routings.

  54. val repositoryRoutings: Seq[GitRepositoryRouting]

    Override to add git repository routings.

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

    Override to add repository setting tabs.

  56. val repositorySettingTabs: Seq[(RepositoryInfo, Context) => Option[Link]]

    Override to add repository setting tabs.

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

    This method is invoked when the plugin system is shutting down.

    This method is invoked when the plugin system is shutting down. If the plugin has any resources, release them in this method.

  58. def sshCommandProviders(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[PartialFunction[String, Command]]

    Override to add ssh command providers.

  59. val sshCommandProviders: Seq[PartialFunction[String, Command]]

    Override to add ssh command providers.

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

    Override to add suggestion provider.

  61. val suggestionProviders: Seq[SuggestionProvider]

    Override to add suggestion provider.

  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. def systemSettingMenus(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(Context) => Option[Link]]

    Override to add system setting menus.

  64. val systemSettingMenus: Seq[(Context) => Option[Link]]

    Override to add system setting menus.

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

    Override to add text decorators.

  66. val textDecorators: Seq[TextDecorator]

    Override to add text decorators.

  67. def toString(): String
    Definition Classes
    AnyRef → Any
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped