Module org.kohsuke.github.api

Package 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHPullRequestReview.ReviewComment	Represents a review comment as returned by the review comments endpoint.

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHPullRequestReview()	Create default GHPullRequestReview instance

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes this review.
void	dismiss(String message)	Dismisses this review.
protected String	getApiRoute()	Gets api route.
String	getBody()	The comment itself.
String	getCommitId()	Gets commit id.
Instant	getCreatedAt()	Since this method does not exist, we forward this value.
URL	getHtmlUrl()	Gets the html url.
GHPullRequest	getParent()	Gets the pull request to which this review is associated.
GHPullRequestReviewState	getState()	Gets state.
Instant	getSubmittedAt()	When was this resource created?.
GHUser	getUser()	Gets the user who posted this review.
PagedIterable<GHPullRequestReview.ReviewComment>	listReviewComments()	Obtains all the review comments associated with this pull request review.
void	submit(String body, GHPullRequestReviewEvent event)	Updates the comment.

Methods inherited from class org.kohsuke.github.GHObject

getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString

Methods inherited from class java.lang.Object

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

Constructor Details

GHPullRequestReview

public GHPullRequestReview()

Create default GHPullRequestReview instance

Method Details

delete

public void delete()
            throws IOException

Deletes this review.

Throws:

IOException - the io exception

dismiss

public void dismiss(String message)
             throws IOException

Dismisses this review.

Parameters:

message - the message

Throws:

IOException - the io exception

getBody

public String getBody()

The comment itself.

Returns:

the body

getCommitId

public String getCommitId()

Gets commit id.

Returns:

the commit id

getCreatedAt

@WithBridgeMethods(value=java.util.Date.class,
                   adapterMethod="instantToDate")
public Instant getCreatedAt()
                     throws IOException

Since this method does not exist, we forward this value.

Overrides:

getCreatedAt in class GHObject

Returns:

the created at

Throws:

IOException - Signals that an I/O exception has occurred.

getHtmlUrl

public URL getHtmlUrl()

Gets the html url.

Returns:

the html url

getParent

public GHPullRequest getParent()

Gets the pull request to which this review is associated.

Returns:

the parent

getState

@CheckForNull
public GHPullRequestReviewState getState()

Gets state.

Returns:

the state

getSubmittedAt

@WithBridgeMethods(value=java.util.Date.class,
                   adapterMethod="instantToDate")
public Instant getSubmittedAt()

When was this resource created?.

Returns:

the submitted at

getUser

public GHUser getUser()
               throws IOException

Gets the user who posted this review.

Returns:

the user

Throws:

IOException - the io exception

listReviewComments

public PagedIterable<GHPullRequestReview.ReviewComment> listReviewComments()

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

The GitHub API endpoint used by this method returns a limited set of fields. To obtain full comment data including line numbers, use GHPullRequestReview.ReviewComment.readPullRequestReviewComment() on individual comments, or use GHPullRequest.listReviewComments() instead.

Returns:

the paged iterable of GHPullRequestReview.ReviewComment objects

See Also:

• GHPullRequest.listReviewComments()
• GHPullRequestReview.ReviewComment.readPullRequestReviewComment()

submit

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

Updates the comment.

Parameters:

body - the body

event - the event

Throws:

IOException - the io exception

getApiRoute

protected String getApiRoute()

Gets api route.

Returns:

the api route