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

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHPullRequestReview()

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.
Date	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.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHPullRequestReviewState	getState()	Gets state.
Date	getSubmittedAt()	When was this resource created?.
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.

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()

Method Details

getParent

public GHPullRequest getParent()

Gets the pull request to which this review is associated.

Returns:

the parent

getBody

public String getBody()

The comment itself.

Returns:

the body

getUser

public GHUser getUser()
               throws IOException

Gets the user who posted this review.

Returns:

the user

Throws:

IOException - the io exception

getCommitId

public String getCommitId()

Gets commit id.

Returns:

the commit id

getState

@CheckForNull
public GHPullRequestReviewState getState()

Gets state.

Returns:

the state

getHtmlUrl

public URL getHtmlUrl()

Gets the html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

getApiRoute

protected String getApiRoute()

Gets api route.

Returns:

the api route

getSubmittedAt

public Date getSubmittedAt()
                    throws IOException

When was this resource created?.

Returns:

the submitted at

Throws:

IOException - the io exception

getCreatedAt

public Date 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.

submit

@Deprecated
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)

Submit.

Parameters:

body - the body

state - the state

Throws:

IOException - the io exception

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

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

listReviewComments

public PagedIterable<GHPullRequestReviewComment> listReviewComments()
                                                             throws IOException

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

Returns:

the paged iterable

Throws:

IOException - the io exception

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance