org.kohsuke.github

Class GHPullRequestReview

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHPullRequestReview

public class GHPullRequestReview
extends GHObject

Review to a pull request.

See Also:

GHPullRequest.listReviews(), GHPullRequestReviewBuilder

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, responseHeaderFields, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHPullRequestReview()

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this review.
void	dismiss(String message) Dismisses this review.
protected String	getApiRoute()
String	getBody() The comment itself.
String	getCommitId()
URL	getHtmlUrl() URL of this object for humans, which renders some HTML.
GHPullRequest	getParent() Gets the pull request to which this review is associated.
GHPullRequestReviewState	getState()
GHUser	getUser() Gets the user who posted this review.
PagedIterable<GHPullRequestReviewComment>	listReviewComments() Obtains all the review comments associated with this pull request review.
void	submit(String body, GHPullRequestReviewEvent event) Updates the comment.
void	submit(String body, GHPullRequestReviewState state) Deprecated. Former preview method that changed when it got public. Left here for backward compatibility. Use submit(String, GHPullRequestReviewEvent)

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getResponseHeaderFields, getUpdatedAt, getUrl, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GHPullRequestReview

public GHPullRequestReview()

Method Detail

getParent

public GHPullRequest getParent()

Gets the pull request to which this review is associated.

getBody

public String getBody()

The comment itself.

getUser

public GHUser getUser()
               throws IOException

Gets the user who posted this review.

Throws:

IOException

getCommitId

public String getCommitId()

getState

@CheckForNull
public GHPullRequestReviewState getState()

getHtmlUrl

public URL getHtmlUrl()

Description copied from class: GHObject

URL of this object for humans, which renders some HTML.

Specified by:

getHtmlUrl in class GHObject

getApiRoute

protected String getApiRoute()

submit

public void submit(String body,
                   GHPullRequestReviewState state)
            throws IOException

Deprecated. Former preview method that changed when it got public. Left here for backward compatibility. Use submit(String, GHPullRequestReviewEvent)

Throws:

IOException

submit

public void submit(String body,
                   GHPullRequestReviewEvent event)
            throws IOException

Updates the comment.

Throws:

IOException

delete

public void delete()
            throws IOException

Deletes this review.

Throws:

IOException

dismiss

public void dismiss(String message)
             throws IOException

Dismisses this review.

Throws:

IOException

listReviewComments

public PagedIterable<GHPullRequestReviewComment> listReviewComments()
                                                             throws IOException

Obtains all the review comments associated with this pull request review.

Throws:

IOException