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:

  • Constructor Details

    • GHPullRequestReview

      public GHPullRequestReview()
      Create default GHPullRequestReview instance

  • 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.
      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

      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