Package org.kohsuke.github
Class GHPullRequestReviewComment
- java.lang.Object
-
- org.kohsuke.github.GHObject
-
- org.kohsuke.github.GHPullRequestReviewComment
-
- All Implemented Interfaces:
Reactable
public class GHPullRequestReviewComment extends GHObject implements Reactable
Review comment to the pull request- Author:
- Julien Henry
- See Also:
GHPullRequest#listReviewComments()
,GHPullRequest#createReviewComment(String, String, String, int)
-
-
Field Summary
-
Fields inherited from class org.kohsuke.github.GHObject
responseHeaderFields
-
-
Constructor Summary
Constructors Constructor Description GHPullRequestReviewComment()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GHReaction
createReaction(ReactionContent content)
Deprecated.void
delete()
Deletes this review comment.static GHPullRequestReviewComment
draft(String body, String path, int position)
Deprecated.You should be usingGHPullRequestReviewBuilder.comment(String, String, int)
protected String
getApiRoute()
Gets api route.String
getBody()
The comment itself.URL
getHtmlUrl()
Gets html url.long
getInReplyToId()
Gets in reply to id.int
getOriginalPosition()
Gets original position.GHPullRequest
getParent()
Gets the pull request to which this review comment is associated.String
getPath()
Gets path.int
getPosition()
Gets position.GHUser
getUser()
Gets the user who posted this comment.PagedIterable<GHReaction>
listReactions()
Deprecated.GHPullRequestReviewComment
reply(String body)
Create a new comment that replies to this comment.void
update(String body)
Updates the comment.-
Methods inherited from class org.kohsuke.github.GHObject
getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString
-
-
-
-
Method Detail
-
draft
@Deprecated public static GHPullRequestReviewComment draft(String body, String path, int position)
Deprecated.You should be usingGHPullRequestReviewBuilder.comment(String, String, int)
Draft gh pull request review comment.- Parameters:
body
- the bodypath
- the pathposition
- the position- Returns:
- the gh pull request review comment
-
getParent
public GHPullRequest getParent()
Gets the pull request to which this review comment 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 comment.- Returns:
- the user
- Throws:
IOException
- the io exception
-
getPath
public String getPath()
Gets path.- Returns:
- the path
-
getPosition
@CheckForNull public int getPosition()
Gets position.- Returns:
- the position
-
getOriginalPosition
public int getOriginalPosition()
Gets original position.- Returns:
- the original position
-
getInReplyToId
@CheckForNull public long getInReplyToId()
Gets in reply to id.- Returns:
- the in reply to id
-
getHtmlUrl
public URL getHtmlUrl()
Description copied from class:GHObject
Gets html url.- Specified by:
getHtmlUrl
in classGHObject
- Returns:
- URL of this object for humans, which renders some HTML.
-
getApiRoute
protected String getApiRoute()
Gets api route.- Returns:
- the api route
-
update
public void update(String body) throws IOException
Updates the comment.- Parameters:
body
- the body- Throws:
IOException
- the io exception
-
delete
public void delete() throws IOException
Deletes this review comment.- Throws:
IOException
- the io exception
-
reply
public GHPullRequestReviewComment reply(String body) throws IOException
Create a new comment that replies to this comment.- Parameters:
body
- the body- Returns:
- the gh pull request review comment
- Throws:
IOException
- the io exception
-
createReaction
@Preview(SQUIRREL_GIRL) @Deprecated public GHReaction createReaction(ReactionContent content) throws IOException
Deprecated.Description copied from interface:Reactable
Leaves a reaction to this object.- Specified by:
createReaction
in interfaceReactable
- Parameters:
content
- the content- Returns:
- the gh reaction
- Throws:
IOException
- the io exception
-
listReactions
@Preview(SQUIRREL_GIRL) @Deprecated public PagedIterable<GHReaction> listReactions()
Deprecated.Description copied from interface:Reactable
List all the reactions left to this object.- Specified by:
listReactions
in interfaceReactable
- Returns:
- the paged iterable
-
-