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

Class GHThread

java.lang.Object
org.kohsuke.github.GHObject
org.kohsuke.github.GHThread
public class GHThread extends GHObject
A conversation in the notification API.
Author:
Kohsuke Kawaguchi
See Also:

  • Method Details

    • getLastReadAt

      public Date getLastReadAt()
      Returns null if the entire thread has never been read.
      Returns:
      the last read at

    • getReason

      public String getReason()
      Gets reason.
      Returns:
      the reason

    • getRepository

      public GHRepository getRepository()
      Gets repository.
      Returns:
      the repository

    • isRead

      public boolean isRead()
      Is read boolean.
      Returns:
      the boolean

    • getTitle

      public String getTitle()
      Gets title.
      Returns:
      the title

    • getType

      public String getType()
      Gets type.
      Returns:
      the type

    • getLastCommentUrl

      public String getLastCommentUrl()
      Gets last comment url.
      Returns:
      the last comment url

    • getBoundIssue

      public GHIssue getBoundIssue() throws IOException
      If this thread is about an issue, return that issue.
      Returns:
      null if this thread is not about an issue.
      Throws:
      IOException - the io exception

    • getBoundPullRequest

      public GHPullRequest getBoundPullRequest() throws IOException
      If this thread is about a pull request, return that pull request.
      Returns:
      null if this thread is not about a pull request.
      Throws:
      IOException - the io exception

    • getBoundCommit

      public GHCommit getBoundCommit() throws IOException
      If this thread is about a commit, return that commit.
      Returns:
      null if this thread is not about a commit.
      Throws:
      IOException - the io exception

    • markAsRead

      public void markAsRead() throws IOException
      Marks this thread as read.
      Throws:
      IOException - the io exception

    • subscribe

      public GHSubscription subscribe(boolean subscribed, boolean ignored) throws IOException
      Subscribes to this conversation to get notifications.
      Parameters:
      subscribed - the subscribed
      ignored - the ignored
      Returns:
      the gh subscription
      Throws:
      IOException - the io exception

    • getSubscription

      public GHSubscription getSubscription() throws IOException
      Returns the current subscription for this thread.
      Returns:
      null if no subscription exists.
      Throws:
      IOException - the io exception