|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EmailContent
Content token, which is a macro that the user can use like "${FOOBAR,param=arg,param=arg,...}" in the template that expands to a real content.
Nested Class Summary | |
---|---|
static class |
EmailContent.Args
|
Nested classes/interfaces inherited from interface hudson.ExtensionPoint |
---|
hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson |
Method Summary | ||
---|---|---|
List<String> |
getArguments()
These are the arguments accepted when generating the content for this token. |
|
|
getContent(hudson.model.AbstractBuild<P,B> build,
ExtendedEmailPublisher publisher,
EmailType emailType,
Map<String,?> args)
This method returns the generated content that should replace the token. |
|
String |
getHelpText()
This is a string that will be rendered in the help section of the plugin. |
|
String |
getToken()
This is the token that will be replaced by the content when the email is sent. |
|
boolean |
hasNestedContent()
Specifies whether or not the content returned by this object can have nested tokens in it that need to be resolved before sending the email. |
Method Detail |
---|
String getToken()
List<String> getArguments()
String getHelpText()
<P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>> String getContent(hudson.model.AbstractBuild<P,B> build, ExtendedEmailPublisher publisher, EmailType emailType, Map<String,?> args) throws IOException, InterruptedException
publisher
- TODOargs
- the arguments for generating the content
IOException
InterruptedException
boolean hasNestedContent()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |