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)	Leaves a reaction to this object.
void	delete()	Deletes this issue comment.
GHCommentAuthorAssociation	getAuthorAssociation()	Gets author association.
String	getBody()	The comment itself.
URL	getHtmlUrl()	Gets html url.
GHIssue	getParent()	Gets the issue to which this comment is associated.
GHUser	getUser()	Gets the user who posted this comment.
String	getUserName()	Deprecated.
PagedIterable<GHReaction>	listReactions()	List all the reactions left to this object.
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 Detail

GHIssueComment

public GHIssueComment()

Method Detail

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()

Description copied from class: GHObject

Gets html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

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

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

Description copied from interface: Reactable

Leaves a reaction to this object.

Specified by:

createReaction in interface Reactable

Parameters:

content - the content

Returns:

the gh reaction

Throws:

IOException - the io exception

listReactions

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

Description copied from interface: Reactable

List all the reactions left to this object.

Specified by:

listReactions in interface Reactable

Returns:

the paged iterable