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)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHPullRequestReviewComment.Side	The side of the diff to which the comment applies

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHPullRequestReviewComment()

Method Summary

Modifier and Type	Method	Description
GHReaction	createReaction(ReactionContent content)	Creates the reaction.
void	delete()	Deletes this review comment.
void	deleteReaction(GHReaction reaction)	Delete reaction.
static GHPullRequestReviewComment	draft(String body, String path, int position)	Deprecated. You should be using GHPullRequestReviewBuilder.comment(String, String, int)
protected String	getApiRoute()	Gets api route.
protected String	getApiRoute(boolean includePullNumber)	Gets api route.
GHCommentAuthorAssociation	getAuthorAssociation()	Gets the author association to the project.
String	getBody()	The comment itself.
String	getBodyHtml()	Gets The body in html format.
String	getBodyText()	Gets The body text.
String	getCommitId()	Gets commit id.
String	getDiffHunk()	Gets diff hunk.
URL	getHtmlUrl()	Gets the html url.
long	getInReplyToId()	Gets in reply to id.
int	getLine()	Gets The line of the blob to which the comment applies.
String	getOriginalCommitId()	Gets commit id.
int	getOriginalLine()	Gets The line of the blob to which the comment applies.
int	getOriginalPosition()	Gets original position.
int	getOriginalStartLine()	Gets The first line of the range for a multi-line comment.
GHPullRequest	getParent()	Gets the pull request to which this review comment is associated.
String	getPath()	Gets path.
int	getPosition()	Gets position.
Long	getPullRequestReviewId()	Gets The ID of the pull request review to which the comment belongs.
URL	getPullRequestUrl()	Gets URL for the pull request that the review comment belongs to.
GHPullRequestReviewCommentReactions	getReactions()	Gets the Reaction Rollup
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHPullRequestReviewComment.Side	getSide()	Gets The side of the diff to which the comment applies.
int	getStartLine()	Gets The first line of the range for a multi-line comment.
GHPullRequestReviewComment.Side	getStartSide()	Gets The side of the first line of the range for a multi-line comment.
GHUser	getUser()	Gets the user who posted this comment.
PagedIterable<GHReaction>	listReactions()	List reactions.
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

Methods inherited from class java.lang.Object

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

Constructor Detail

GHPullRequestReviewComment

public GHPullRequestReviewComment()

Method Detail

draft

@Deprecated
public static GHPullRequestReviewComment draft(String body,
                                               String path,
                                               int position)

Deprecated.

You should be using GHPullRequestReviewBuilder.comment(String, String, int)

Draft gh pull request review comment.

Parameters:

body - the body

path - the path

position - 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

getDiffHunk

public String getDiffHunk()

Gets diff hunk.

Returns:

the diff hunk

getCommitId

public String getCommitId()

Gets commit id.

Returns:

the commit id

getOriginalCommitId

public String getOriginalCommitId()

Gets commit id.

Returns:

the commit id

getAuthorAssociation

public GHCommentAuthorAssociation getAuthorAssociation()

Gets the author association to the project.

Returns:

the author association to the project

getInReplyToId

@CheckForNull
public long getInReplyToId()

Gets in reply to id.

Returns:

the in reply to id

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

getApiRoute

protected String getApiRoute(boolean includePullNumber)

Gets api route.

Parameters:

includePullNumber - if true, includes the owning pull request's number in the route.

Returns:

the api route

getStartLine

public int getStartLine()

Gets The first line of the range for a multi-line comment.

Returns:

the start line

getOriginalStartLine

public int getOriginalStartLine()

Gets The first line of the range for a multi-line comment.

Returns:

the original start line

getStartSide

public GHPullRequestReviewComment.Side getStartSide()

Gets The side of the first line of the range for a multi-line comment.

Returns:

GHPullRequestReviewComment.Side the side of the first line

getLine

public int getLine()

Gets The line of the blob to which the comment applies. The last line of the range for a multi-line comment.

Returns:

the line to which the comment applies

getOriginalLine

public int getOriginalLine()

Gets The line of the blob to which the comment applies. The last line of the range for a multi-line comment.

Returns:

the line to which the comment applies

getSide

public GHPullRequestReviewComment.Side getSide()

Gets The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment

Returns:

GHPullRequestReviewComment.Side the side if the diff to which the comment applies

getPullRequestReviewId

public Long getPullRequestReviewId()

Gets The ID of the pull request review to which the comment belongs.

Returns:

Long the ID of the pull request review

getPullRequestUrl

public URL getPullRequestUrl()

Gets URL for the pull request that the review comment belongs to.

Returns:

URL the URL of the pull request

getBodyHtml

public String getBodyHtml()

Gets The body in html format.

Returns:

String the body in html format

getBodyText

public String getBodyText()

Gets The body text.

Returns:

String the body text

getReactions

public GHPullRequestReviewCommentReactions getReactions()

Gets the Reaction Rollup

Returns:

GHPullRequestReviewCommentReactions the reaction rollup

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)
public GHReaction createReaction(ReactionContent content)
                          throws IOException

Creates the reaction.

Specified by:

createReaction in interface Reactable

Parameters:

content - the content

Returns:

the GH reaction

Throws:

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

deleteReaction

public void deleteReaction(GHReaction reaction)
                    throws IOException

Delete reaction.

Specified by:

deleteReaction in interface Reactable

Parameters:

reaction - the reaction

Throws:

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

listReactions

@Preview(SQUIRREL_GIRL)
public PagedIterable<GHReaction> listReactions()

List reactions.

Specified by:

listReactions in interface Reactable

Returns:

the paged iterable

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