Package jenkins.model.menu.event

Class ConfirmationEvent

java.lang.Object

jenkins.model.menu.event.ConfirmationEvent

All Implemented Interfaces:

Event

@ExportedBean
@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public final class ConfirmationEvent
extends Object
implements Event

When clicked, a dialog will pop up for confirmation. e.g. Delete item.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getPostTo()
String	getTitle()
static ConfirmationEvent	of(String title, String postTo)	Create a confirmation event.
static ConfirmationEvent	of(String title, String description, String postTo)	Create a confirmation event.

Methods inherited from class java.lang.Object

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

Method Details

of

public static ConfirmationEvent of(String title,
 String postTo)

Create a confirmation event.

The title is rendered as plain text in the dialog, any HTML in it will be escaped.

Parameters:

title - title of the dialog, rendered as plain text.

postTo - url that the action should be submitted to, e.g. doDelete.

Since:

2.560

of

public static ConfirmationEvent of(String title,
 String description,
 String postTo)

Create a confirmation event.

Both title and description are rendered as plain text in the dialog, any HTML in either will be escaped, not interpreted.

Parameters:

title - title of the dialog, rendered as plain text.

description - additional contextual information about what is being confirmed, rendered as plain text.

postTo - url that the action should be submitted to, e.g. doDelete.

Since:

2.560

getTitle

@Exported
public String getTitle()

getDescription

@Exported
public String getDescription()

getPostTo

@Exported
public String getPostTo()