Package org.kohsuke.github

Class GHIssueComment

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHIssueComment

All Implemented Interfaces:

Reactable

public class GHIssueComment
extends GHObject
implements Reactable

Comment to the issue.

Author:

Kohsuke Kawaguchi

See Also:

• GHIssue#comment(String)
• GHIssue#listComments()

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Constructor Summary

Constructors

Constructor	Description
GHIssueComment()

Method Summary

Modifier and Type	Method	Description
GHReaction	createReaction(ReactionContent content)	Creates the reaction.
void	delete()	Deletes this issue comment.
void	deleteReaction(GHReaction reaction)	Delete reaction.
GHCommentAuthorAssociation	getAuthorAssociation()	Gets author association.
String	getBody()	The comment itself.
URL	getHtmlUrl()	Gets the html url.
GHIssue	getParent()	Gets the issue to which this comment is associated.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHUser	getUser()	Gets the user who posted this comment.
String	getUserName()	Deprecated.
PagedIterable<GHReaction>	listReactions()	List reactions.
void	update(String body)	Updates the body of the issue 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 Details

GHIssueComment

public GHIssueComment()

Method Details

getParent

public GHIssue getParent()

Gets the issue to which this comment is associated.

Returns:

the parent

getBody

public String getBody()

The comment itself.

Returns:

the body

getUserName

@Deprecated
public String getUserName()

Deprecated.

Gets the ID of the user who posted this comment.

Returns:

the user name

getUser

public GHUser getUser()
               throws IOException

Gets the user who posted this comment.

Returns:

the user

Throws:

IOException - the io exception

getHtmlUrl

public URL getHtmlUrl()

Gets the html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

getAuthorAssociation

public GHCommentAuthorAssociation getAuthorAssociation()

Gets author association.

Returns:

the author association

update

public void update(String body)
            throws IOException

Updates the body of the issue comment.

Parameters:

body - the body

Throws:

IOException - the io exception

delete

public void delete()
            throws IOException

Deletes this issue 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