org.jenkinsci.plugins.pipeline.github

Class PullRequestGroovyObject

java.lang.Object

groovy.lang.GroovyObjectSupport

org.jenkinsci.plugins.pipeline.github.PullRequestGroovyObject

All Implemented Interfaces:

groovy.lang.GroovyObject, Serializable

public class PullRequestGroovyObject
extends groovy.lang.GroovyObjectSupport
implements Serializable

Groovy object that represents a GitHub PullRequest. TODO: better javadoc

Author:

Aaron Whiteside

See Also:

ExtendedPullRequest, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PullRequestGroovyObject(org.jenkinsci.plugins.workflow.cps.CpsScript script)

Method Summary

Modifier and Type	Method and Description
void	addAssignees(String... assignees)
void	addLabels(String... labels)
IssueCommentGroovyObject	comment(String body)
void	createReviewRequests(String... reviewers)
CommitStatusGroovyObject	createStatus(Map<String,String> params)
CommitStatusGroovyObject	createStatus(String status, String context, String description, String targetUrl)
void	deleteComment(long commentId)
void	deleteReviewComment(long commentId)
void	deleteReviewRequests(String... reviewers)
IssueCommentGroovyObject	editComment(long commentId, String body)
ReviewCommentGroovyObject	editReviewComment(long commentId, String body)
Object	getProperty(String property)
String	merge(Map<String,String> params)
String	merge(String commitTitle, String commitMessage, String sha, String mergeMethod)
void	refresh()
void	removeAssignees(String... assignees)
void	removeLabel(String label)
ReviewCommentGroovyObject	replyToReviewComment(long commentId, String body)
ReviewCommentGroovyObject	reviewComment(String commitId, String path, int position, String body)
void	setCredentials(String userName, String password)
void	setProperty(String property, Object newValue)

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, invokeMethod, setMetaClass

Methods inherited from class java.lang.Object

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

Constructor Detail

PullRequestGroovyObject

public PullRequestGroovyObject(@Nonnull
                               org.jenkinsci.plugins.workflow.cps.CpsScript script)
                        throws Exception

Throws:

Exception

Method Detail

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class groovy.lang.GroovyObjectSupport

setProperty

public void setProperty(String property,
                        Object newValue)

Specified by:

setProperty in interface groovy.lang.GroovyObject

Overrides:

setProperty in class groovy.lang.GroovyObjectSupport

createReviewRequests

public void createReviewRequests(String... reviewers)

deleteReviewRequests

public void deleteReviewRequests(String... reviewers)

addLabels

public void addLabels(String... labels)

removeLabel

public void removeLabel(String label)

addAssignees

public void addAssignees(String... assignees)

removeAssignees

public void removeAssignees(String... assignees)

createStatus

public CommitStatusGroovyObject createStatus(Map<String,String> params)

createStatus

public CommitStatusGroovyObject createStatus(String status,
                                             String context,
                                             String description,
                                             String targetUrl)

reviewComment

public ReviewCommentGroovyObject reviewComment(String commitId,
                                               String path,
                                               int position,
                                               String body)

replyToReviewComment

public ReviewCommentGroovyObject replyToReviewComment(long commentId,
                                                      String body)

deleteReviewComment

public void deleteReviewComment(long commentId)

editReviewComment

public ReviewCommentGroovyObject editReviewComment(long commentId,
                                                   String body)

comment

public IssueCommentGroovyObject comment(String body)

editComment

public IssueCommentGroovyObject editComment(long commentId,
                                            String body)

deleteComment

public void deleteComment(long commentId)

merge

public String merge(Map<String,String> params)

merge

public String merge(String commitTitle,
                    String commitMessage,
                    String sha,
                    String mergeMethod)

refresh

public void refresh()

setCredentials

public void setCredentials(String userName,
                           String password)