org.kohsuke.github

Class GHIssue

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHIssue

All Implemented Interfaces:

Reactable

Direct Known Subclasses:

GHPullRequest

public class GHIssue
extends GHObject
implements Reactable

Represents an issue on GitHub.

Author:

Eric Maupin, Kohsuke Kawaguchi

See Also:

GHRepository.getIssue(int), GitHub.searchIssues(), GHIssueSearchBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHIssue.Label Deprecated. use GHLabel
static class	GHIssue.PullRequest

Field Summary

Fields

Modifier and Type	Field and Description
protected GHUser	assignee
protected GHUser[]	assignees
protected String	body
protected String	closed_at
protected GHUser	closed_by
protected int	comments
protected String	html_url
protected List<GHIssue.Label>	labels
protected GHMilestone	milestone
protected int	number
protected GHIssue.PullRequest	pull_request
protected String	state
protected String	title
protected GHUser	user

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHIssue()

Method Summary

Modifier and Type	Method and Description
void	addAssignees(Collection<GHUser> assignees)
void	addAssignees(GHUser... assignees)
void	assignTo(GHUser user)
void	close() Closes this issue.
GHIssueComment	comment(String message) Updates the issue by adding a comment.
GHReaction	createReaction(ReactionContent content) Deprecated.
protected String	getApiRoute()
URL	getApiURL()
GHUser	getAssignee()
List<GHUser>	getAssignees()
String	getBody() The description of this pull request.
Date	getClosedAt()
GHUser	getClosedBy() Reports who has closed the issue.
List<GHIssueComment>	getComments() Obtains all the comments associated with this issue.
int	getCommentsCount()
URL	getHtmlUrl() The HTML page of this issue, like https://github.com/jenkinsci/jenkins/issues/100
protected String	getIssuesApiRoute()
Collection<GHLabel>	getLabels()
GHMilestone	getMilestone()
int	getNumber() ID.
GHIssue.PullRequest	getPullRequest() Returns non-null if this issue is a shadow of a pull request.
GHRepository	getRepository() Repository to which the issue belongs.
GHIssueState	getState()
String	getTitle()
GHUser	getUser() User who submitted the issue.
boolean	isPullRequest()
PagedIterable<GHIssueComment>	listComments() Obtains all the comments associated with this issue.
PagedIterable<GHReaction>	listReactions() Deprecated.
void	removeAssignees(Collection<GHUser> assignees)
void	removeAssignees(GHUser... assignees)
void	reopen() Reopens this issue.
void	setAssignees(Collection<GHUser> assignees)
void	setAssignees(GHUser... assignees)
void	setBody(String body)
void	setLabels(String... labels)
void	setTitle(String title)

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

Field Detail

assignee

protected GHUser assignee

assignees

protected GHUser[] assignees

state

protected String state

number

protected int number

closed_at

protected String closed_at

comments

protected int comments

body

protected String body

labels

protected List<GHIssue.Label> labels

user

protected GHUser user

title

protected String title

html_url

protected String html_url

pull_request

protected GHIssue.PullRequest pull_request

milestone

protected GHMilestone milestone

closed_by

protected GHUser closed_by

Constructor Detail

GHIssue

public GHIssue()

Method Detail

getRepository

public GHRepository getRepository()

Repository to which the issue belongs.

getBody

public String getBody()

The description of this pull request.

getNumber

public int getNumber()

ID.

getHtmlUrl

public URL getHtmlUrl()

The HTML page of this issue, like https://github.com/jenkinsci/jenkins/issues/100

Specified by:

getHtmlUrl in class GHObject

getTitle

public String getTitle()

getState

public GHIssueState getState()

getLabels

public Collection<GHLabel> getLabels()
                              throws IOException

Throws:

IOException

getClosedAt

public Date getClosedAt()

getApiURL

public URL getApiURL()

comment

@WithBridgeMethods(value=void.class)
public GHIssueComment comment(String message)
                                                            throws IOException

Updates the issue by adding a comment.

Returns:

Newly posted comment.

Throws:

IOException

close

public void close()
           throws IOException

Closes this issue.

Throws:

IOException

reopen

public void reopen()
            throws IOException

Reopens this issue.

Throws:

IOException

setTitle

public void setTitle(String title)
              throws IOException

Throws:

IOException

setBody

public void setBody(String body)
             throws IOException

Throws:

IOException

assignTo

public void assignTo(GHUser user)
              throws IOException

Throws:

IOException

setLabels

public void setLabels(String... labels)
               throws IOException

Throws:

IOException

getComments

public List<GHIssueComment> getComments()
                                 throws IOException

Obtains all the comments associated with this issue.

Throws:

IOException

See Also:

listComments()

listComments

public PagedIterable<GHIssueComment> listComments()
                                           throws IOException

Obtains all the comments associated with this issue.

Throws:

IOException

createReaction

@Preview
 @Deprecated
public GHReaction createReaction(ReactionContent content)
                                                throws IOException

Deprecated.

Description copied from interface: Reactable

Leaves a reaction to this object.

Specified by:

createReaction in interface Reactable

Throws:

IOException

listReactions

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

Deprecated.

Description copied from interface: Reactable

List all the reactions left to this object.

Specified by:

listReactions in interface Reactable

addAssignees

public void addAssignees(GHUser... assignees)
                  throws IOException

Throws:

IOException

addAssignees

public void addAssignees(Collection<GHUser> assignees)
                  throws IOException

Throws:

IOException

setAssignees

public void setAssignees(GHUser... assignees)
                  throws IOException

Throws:

IOException

setAssignees

public void setAssignees(Collection<GHUser> assignees)
                  throws IOException

Throws:

IOException

removeAssignees

public void removeAssignees(GHUser... assignees)
                     throws IOException

Throws:

IOException

removeAssignees

public void removeAssignees(Collection<GHUser> assignees)
                     throws IOException

Throws:

IOException

getApiRoute

protected String getApiRoute()

getIssuesApiRoute

protected String getIssuesApiRoute()

getAssignee

public GHUser getAssignee()

getAssignees

public List<GHUser> getAssignees()

getUser

public GHUser getUser()

User who submitted the issue.

getClosedBy

public GHUser getClosedBy()

Reports who has closed the issue.

Note that GitHub doesn't always seem to report this information even for an issue that's already closed. See https://github.com/kohsuke/github-api/issues/60.

getCommentsCount

public int getCommentsCount()

getPullRequest

public GHIssue.PullRequest getPullRequest()

Returns non-null if this issue is a shadow of a pull request.

isPullRequest

public boolean isPullRequest()

getMilestone

public GHMilestone getMilestone()