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, HttpExtensionList.ExtensionListRootAction, 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

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method	Description
default Badge	getBadge()	A Badge shown on the button for the action.
default boolean	isPrimaryAction()	Identifies if the action is a primary action.

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

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

Returns:

true iff this action should be considered primary.

Since:

2.516