Package jenkins.model

Class PeopleRedirect

java.lang.Object

jenkins.model.PeopleRedirect

All Implemented Interfaces:

Action, ModelObject

Direct Known Subclasses:

PeopleRedirect.AsynchPeople, PeopleRedirect.People

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public abstract class PeopleRedirect
extends Object
implements Action

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PeopleRedirect.AsynchPeople
static class	PeopleRedirect.People
static class	PeopleRedirect.TransientFactory

Constructor Summary

Constructors

Constructor	Description
PeopleRedirect()

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Gets the string to be displayed.
String	getIconFileName()	Gets the name of the icon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.model.Action

getUrlName

Constructor Details

PeopleRedirect

public PeopleRedirect()

Method Details

getIconFileName

public String getIconFileName()

Description copied from interface: Action

Gets the name of the icon.

Specified by:

getIconFileName in interface Action

Returns:

If the icon name is prefixed with "symbol-", a Jenkins Symbol will be used.

If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

See Also:

• Jenkins Symbols
• Functions.isAnonymous()
• Functions.getIconFilePath(Action)

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

Returns:

Can be null in case the action is hidden.