Package org.kohsuke.github
Class GHPullRequestReview
java.lang.Object
org.kohsuke.github.GHObject
org.kohsuke.github.GHPullRequestReview
Review to a pull request.
-
Field Summary
Fields inherited from class org.kohsuke.github.GHObject
responseHeaderFields
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
Deletes this review.void
Dismisses this review.protected String
Gets api route.getBody()
The comment itself.Gets commit id.Since this method does not exist, we forward this value.Gets the html url.Gets the pull request to which this review is associated.getRoot()
Deprecated.getState()
Gets state.When was this resource created?.getUser()
Gets the user who posted this review.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
-
Constructor Details
-
GHPullRequestReview
public GHPullRequestReview()
-
-
Method Details
-
getParent
Gets the pull request to which this review is associated.- Returns:
- the parent
-
getBody
The comment itself.- Returns:
- the body
-
getUser
Gets the user who posted this review.- Returns:
- the user
- Throws:
IOException
- the io exception
-
getCommitId
Gets commit id.- Returns:
- the commit id
-
getState
Gets state.- Returns:
- the state
-
getHtmlUrl
Gets the html url.- Specified by:
getHtmlUrl
in classGHObject
- Returns:
- the html url
-
getApiRoute
Gets api route.- Returns:
- the api route
-
getSubmittedAt
When was this resource created?.- Returns:
- the submitted at
- Throws:
IOException
- the io exception
-
getCreatedAt
Since this method does not exist, we forward this value.- Overrides:
getCreatedAt
in classGHObject
- Returns:
- the created at
- Throws:
IOException
- Signals that an I/O exception has occurred.
-
submit
Deprecated.Former preview method that changed when it got public. Left here for backward compatibility. Usesubmit(String, GHPullRequestReviewEvent)
Submit.- Parameters:
body
- the bodystate
- the state- Throws:
IOException
- the io exception
-
submit
Updates the comment.- Parameters:
body
- the bodyevent
- the event- Throws:
IOException
- the io exception
-
delete
Deletes this review.- Throws:
IOException
- the io exception
-
dismiss
Dismisses this review.- Parameters:
message
- the message- Throws:
IOException
- the io exception
-
listReviewComments
Obtains all the review comments associated with this pull request review.- Returns:
- the paged iterable
- Throws:
IOException
- the io exception
-
getRoot
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.Get the rootGitHub
instance for this object.- Returns:
- the root
GitHub
instance
-
GitHub
instance, use a local copy instead of pulling it out of objects.