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

created_at, id, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHPullRequestReviewComment()

Method Summary

Modifier and Type	Method and Description
GHReaction	createReaction(ReactionContent content) Deprecated.
void	delete() Deletes this review comment.
static GHPullRequestReviewComment	draft(String body, String path, int position)
protected String	getApiRoute()
String	getBody() The comment itself.
URL	getHtmlUrl() URL of this object for humans, which renders some HTML.
int	getOriginalPosition()
GHPullRequest	getParent() Gets the pull request to which this review comment is associated.
String	getPath()
int	getPosition()
GHUser	getUser() Gets the user who posted this comment.
PagedIterable<GHReaction>	listReactions() Deprecated.
void	update(String body) Updates the comment.

Methods inherited from class org.kohsuke.github.GHObject

getCreatedAt, getId, getUpdatedAt, getUrl, 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

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

getParent

public GHPullRequest getParent()

Gets the pull request to which this review comment is associated.

getBody

public String getBody()

The comment itself.

getUser

public GHUser getUser()
               throws IOException

Gets the user who posted this comment.

Throws:

IOException

getPath

public String getPath()

getPosition

public int getPosition()

getOriginalPosition

public int getOriginalPosition()

getHtmlUrl

public URL getHtmlUrl()

Description copied from class: GHObject

URL of this object for humans, which renders some HTML.

Specified by:

getHtmlUrl in class GHObject

getApiRoute

protected String getApiRoute()

update

public void update(String body)
            throws IOException

Updates the comment.

Throws:

IOException

delete

public void delete()
            throws IOException

Deletes this review comment.

Throws:

IOException

createReaction

@Preview
 @Deprecated
public GHReaction createReaction(ReactionContent content)
                                                throws IOException

Deprecated.

Description copied from interface: Reactable

Leaves a reaction to this object.

Specified by:

createReaction in interface Reactable

Throws:

IOException

listReactions

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

Deprecated.

Description copied from interface: Reactable

List all the reactions left to this object.

Specified by:

listReactions in interface Reactable