Module org.kohsuke.github.api
Package org.kohsuke.github

Class GHCommitComment

java.lang.Object
org.kohsuke.github.GHObject
org.kohsuke.github.GHCommitComment
All Implemented Interfaces:
Reactable
public class GHCommitComment extends GHObject implements Reactable
A comment attached to a commit (or a specific line in a specific file of a commit.)
Author:
Kohsuke Kawaguchi
See Also:

  • Constructor Details

    • GHCommitComment

      public GHCommitComment()
      Create default GHCommitComment instance

  • Method Details

    • createReaction

      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.

    • delete

      public void delete() throws IOException
      Deletes this comment.
      Throws:
      IOException - the io exception

    • 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.

    • getBody

      public String getBody()
      Commit comment in the GitHub flavored markdown format.
      Returns:
      the body

    • getCommit

      public GHCommit getCommit() throws IOException
      Gets the commit to which this comment is associated with.
      Returns:
      the commit
      Throws:
      IOException - the io exception

    • getHtmlUrl

      public URL getHtmlUrl()
      URL like 'https://github.com/kohsuke/sandbox-ant/commit/8ae38db0ea5837313ab5f39d43a6f73de3bd9000#commitcomment-1252827' to show this commit comment in a browser.
      Returns:
      the html url

    • getLine

      public int getLine()
      A commit comment can be on a specific line of a specific file, if so, this field points to the line number in the file. Otherwise -1.
      Returns:
      the line

    • getOwner

      public GHRepository getOwner()
      Gets owner.
      Returns:
      the owner

    • getPath

      public String getPath()
      A commit comment can be on a specific line of a specific file, if so, this field points to a file. Otherwise null.
      Returns:
      the path

    • getSHA1

      public String getSHA1()
      Gets sha 1.
      Returns:
      the sha 1

    • getUser

      public GHUser getUser() throws IOException
      Gets the user who put this comment.
      Returns:
      the user
      Throws:
      IOException - the io exception

    • listReactions

      public PagedIterable<GHReaction> listReactions()
      List reactions.
      Specified by:
      listReactions in interface Reactable
      Returns:
      the paged iterable

    • update

      public void update(String body) throws IOException
      Updates the body of the commit message.
      Parameters:
      body - the body
      Throws:
      IOException - the io exception