Class NotiferStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

io.notifer.jenkins.NotiferStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable

public class NotiferStep
extends org.jenkinsci.plugins.workflow.steps.Step
implements Serializable

Pipeline step for sending notifications to Notifer. Usage in Jenkinsfile:

notifer(
    credentialsId: 'my-topic-token',
    topic: 'ci-notifications',
    message: 'Build completed',
    title: 'Jenkins Build',
    priority: 3,
    tags: ['jenkins', 'build']
)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NotiferStep.DescriptorImpl	Descriptor for the step.

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
NotiferStep(String credentialsId, String topic)	Constructor with required parameters.

Method Summary

Modifier and Type	Method	Description
String	getCredentialsId()
String	getMessage()
int	getPriority()
String	getTags()
String	getTitle()
String	getTopic()
boolean	isFailOnError()
void	setFailOnError(boolean failOnError)
void	setMessage(String message)
void	setPriority(int priority)
void	setTags(Object tags)	Setter that accepts both String and List from Pipeline scripts.
void	setTitle(String title)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class Object

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

Constructor Details

NotiferStep

@DataBoundConstructor
public NotiferStep(@NonNull
 String credentialsId,
 @NonNull
 String topic)

Constructor with required parameters.

Method Details

getCredentialsId

@NonNull
public String getCredentialsId()

getTopic

@NonNull
public String getTopic()

getMessage

public String getMessage()

getTitle

public String getTitle()

getPriority

public int getPriority()

getTags

public String getTags()

isFailOnError

public boolean isFailOnError()

setMessage

@DataBoundSetter
public void setMessage(String message)

setTitle

@DataBoundSetter
public void setTitle(String title)

setPriority

@DataBoundSetter
public void setPriority(int priority)

setTags

@DataBoundSetter
public void setTags(Object tags)

Setter that accepts both String and List from Pipeline scripts. Converts list to comma-separated string.

setFailOnError

@DataBoundSetter
public void setFailOnError(boolean failOnError)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception