Package hudson.model

Interface RootAction

All Superinterfaces:
Action, ExtensionPoint, ModelObject
All Known Subinterfaces:
UnprotectedRootAction
All Known Implementing Classes:
AdministrativeMonitorsApi, AssetManager, CLIAction, CloudSet, ConsoleAnnotatorFactory.RootAction, EnvironmentContributor.EnvVarsHtml, GlobalCloudConfiguration, HealthCheckAction, I18n, IdentityRootAction, ManageJenkinsAction, MemoryUsageMonitorAction, MyViewsProperty.GlobalAction, ResourceDomainRootAction, SearchAction, UserAction, WebSocketAgents, WebSocketEcho, WhoAmI
public interface RootAction extends Action, ExtensionPoint
Marker interface for actions that are added to Jenkins.

Extend from this interface and put Extension on your subtype to have them auto-registered to Jenkins.

Since:
1.311
Author:
Kohsuke Kawaguchi

  • Method Details

    • getBadge

      @CheckForNull default Badge getBadge()
      A Badge shown on the button for the action.
      Returns:
      badge or null if no badge should be shown.
      Since:
      2.507

    • isPrimaryAction

      default boolean isPrimaryAction()
      Identifies if the action is a primary action. Primary actions may be handled differently in the UI (for example, by always showing on the header rather than in an actions dropdown). In almost all cases this should return false which is the default. Examples of a Primary action would be where actions would be used regularly or they would need to be prominent to convey some status. As a concrete example, an action that provides a Help action with a submenu containing various different links, would be a prime candidate for this to return true. If your action has the possibility of a badge then this is another indicator that the action should return true (or otherwise restructured).
      Returns:
      true if and only if this action should be considered primary.
      Since:
      2.516