Constructors Constructor Description
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
getCategory()Category for management link, uses
Stringso it can be done with core dependency pre-dating the version this feature was added.
getDescription()Returns a short description of what this link does.
getDisplayName()Gets the string to be displayed.
getIconFileName()Mostly works like
Action.getIconFileName(), except that the expected icon format is SVG.
getRequiredPermission()Returns the permission required for user to see this management link on the "Manage Jenkins" page (
getUrlName()Gets the URL path name.
Methods inherited from class hudson.model.ManagementLink
all, getCategoryName, getRequiresConfirmation, getRequiresPOST
public String getIconFileName()Mostly works like
Action.getIconFileName(), except that the expected icon format is SVG. So if you give just a file name, "/images/svgs" will be assumed.
- Specified by:
- Specified by:
- As a special case, return null to exclude this object from the management link.
This is useful for defining
ManagementLinkthat only shows up under certain circumstances.
- See Also:
- Jenkins Symbols,
public String getUrlName()Gets the URL path name.
For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.
This method should return a string that's unique among other
The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.
If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.
public String getDisplayName()Description copied from interface:
ActionGets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".
- Can be null in case the action is hidden.
public String getDescription()Returns a short description of what this link does. This text is the one that's displayed in grey. This can include HTML, although the use of block tags is highly discouraged. Optional.
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public URL getLicensesURL()
@NonNull public Permission getRequiredPermission()Returns the permission required for user to see this management link on the "Manage Jenkins" page (
ManageJenkinsAction). Historically, this returned null, which amounted to the same behavior, as
Jenkins.ADMINISTERwas required to access the page.