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:

documentation, GHNotificationStream

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, updated_at

Method Summary

Modifier and Type	Method and Description
GHCommit	getBoundCommit() If this thread is about a commit, return that commit.
GHIssue	getBoundIssue() If this thread is about an issue, return that issue.
GHPullRequest	getBoundPullRequest() If this thread is about a pull request, return that pull request.
java.net.URL	getHtmlUrl() Deprecated. This object has no HTML URL.
java.lang.String	getLastCommentUrl()
java.util.Date	getLastReadAt() Returns null if the entire thread has never been read.
java.lang.String	getReason()
GHRepository	getRepository()
GHSubscription	getSubscription() Returns the current subscription for this thread.
java.lang.String	getTitle()
java.lang.String	getType()
boolean	isRead()
void	markAsRead() Marks this thread as read.
GHSubscription	subscribe(boolean subscribed, boolean ignored) Subscribes to this conversation to get notifications.

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

Method Detail

getLastReadAt

public java.util.Date getLastReadAt()

Returns null if the entire thread has never been read.

getHtmlUrl

public java.net.URL getHtmlUrl()

Deprecated. This object has no HTML URL.

Description copied from class: GHObject

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

Specified by:

getHtmlUrl in class GHObject

getReason

public java.lang.String getReason()

getRepository

public GHRepository getRepository()

isRead

public boolean isRead()

getTitle

public java.lang.String getTitle()

getType

public java.lang.String getType()

getLastCommentUrl

public java.lang.String getLastCommentUrl()

getBoundIssue

public GHIssue getBoundIssue()
                      throws java.io.IOException

If this thread is about an issue, return that issue.

Returns:

null if this thread is not about an issue.

Throws:

java.io.IOException

getBoundPullRequest

public GHPullRequest getBoundPullRequest()
                                  throws java.io.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:

java.io.IOException

getBoundCommit

public GHCommit getBoundCommit()
                        throws java.io.IOException

If this thread is about a commit, return that commit.

Returns:

null if this thread is not about a commit.

Throws:

java.io.IOException

markAsRead

public void markAsRead()
                throws java.io.IOException

Marks this thread as read.

Throws:

java.io.IOException

subscribe

public GHSubscription subscribe(boolean subscribed,
                                boolean ignored)
                         throws java.io.IOException

Subscribes to this conversation to get notifications.

Throws:

java.io.IOException

getSubscription

public GHSubscription getSubscription()
                               throws java.io.IOException

Returns the current subscription for this thread.

Returns:

null if no subscription exists.

Throws:

java.io.IOException