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:

documentation, GHNotificationStream

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

responseHeaderFields

Method Summary

Modifier and Type	Method	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.
URL	getHtmlUrl()	Deprecated. This object has no HTML URL.
String	getLastCommentUrl()	Gets last comment url.
Date	getLastReadAt()	Returns null if the entire thread has never been read.
String	getReason()	Gets reason.
GHRepository	getRepository()	Gets repository.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHSubscription	getSubscription()	Returns the current subscription for this thread.
String	getTitle()	Gets title.
String	getType()	Gets type.
boolean	isRead()	Is read boolean.
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, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getLastReadAt

public Date getLastReadAt()

Returns null if the entire thread has never been read.

Returns:

the last read at

getHtmlUrl

public URL getHtmlUrl()

Deprecated.

This object has no HTML URL.

Gets the html url.

Specified by:

getHtmlUrl in class GHObject

Returns:

the html url

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

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