org.kohsuke.github

Class GHUser

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHPerson

org.kohsuke.github.GHUser

Direct Known Subclasses:

GHMyself, GHRepository.Contributor

public class GHUser
extends GHPerson

Represents an user of GitHub.

Author:

Kohsuke Kawaguchi

Field Summary

Fields inherited from class org.kohsuke.github.GHPerson

avatar_url, blog, company, email, followers, following, gravatar_id, html_url, location, login, name, public_gists, public_repos

Fields inherited from class org.kohsuke.github.GHObject

created_at, id, updated_at, url

Constructor Summary

Constructors

Constructor and Description
GHUser()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
void	follow() Follow this user.
GHPersonSet<GHUser>	getFollowers() Lists the users who are following this user.
GHPersonSet<GHUser>	getFollows() Lists the users that this user is following
GHPersonSet<GHOrganization>	getOrganizations() Gets the organization that this user belongs to publicly.
int	hashCode()
boolean	isMemberOf(GHOrganization org) Returns true if this user belongs to the specified organization.
boolean	isMemberOf(GHTeam team) Returns true if this user belongs to the specified team.
boolean	isPublicMemberOf(GHOrganization org) Returns true if this user belongs to the specified organization as a public member.
PagedIterable<GHEventInfo>	listEvents() Lists events performed by a user (this includes private events if the caller is authenticated.
PagedIterable<GHUser>	listFollowers() Lists the users who are following this user.
PagedIterable<GHUser>	listFollows() Lists the users that this user is following
PagedIterable<GHGist>	listGists() Lists Gists created by this user.
PagedIterable<GHRepository>	listStarredRepositories() Lists all the repositories that this user has starred.
PagedIterable<GHRepository>	listSubscriptions() Lists all the subscribed (aka watched) repositories.
String	toString()
void	unfollow() Unfollow this user.

Methods inherited from class org.kohsuke.github.GHPerson

getAvatarUrl, getBlog, getCompany, getCreatedAt, getEmail, getFollowersCount, getFollowingCount, getGravatarId, getHtmlUrl, getLocation, getLogin, getName, getPublicGistCount, getPublicRepoCount, getRepositories, getRepository, getUpdatedAt, iterateRepositories, listRepositories, listRepositories, populate

Methods inherited from class org.kohsuke.github.GHObject

getId, getUrl

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GHUser

public GHUser()

Method Detail

follow

public void follow()
            throws IOException

Follow this user.

Throws:

IOException

unfollow

public void unfollow()
              throws IOException

Unfollow this user.

Throws:

IOException

getFollows

@WithBridgeMethods(value=java.util.Set.class)
public GHPersonSet<GHUser> getFollows()
                               throws IOException

Lists the users that this user is following

Throws:

IOException

listFollows

public PagedIterable<GHUser> listFollows()

Lists the users that this user is following

getFollowers

@WithBridgeMethods(value=java.util.Set.class)
public GHPersonSet<GHUser> getFollowers()
                                 throws IOException

Lists the users who are following this user.

Throws:

IOException

listFollowers

public PagedIterable<GHUser> listFollowers()

Lists the users who are following this user.

listSubscriptions

public PagedIterable<GHRepository> listSubscriptions()

Lists all the subscribed (aka watched) repositories. https://developer.github.com/v3/activity/watching/

listStarredRepositories

public PagedIterable<GHRepository> listStarredRepositories()

Lists all the repositories that this user has starred.

isMemberOf

public boolean isMemberOf(GHOrganization org)

Returns true if this user belongs to the specified organization.

isMemberOf

public boolean isMemberOf(GHTeam team)

Returns true if this user belongs to the specified team.

isPublicMemberOf

public boolean isPublicMemberOf(GHOrganization org)

Returns true if this user belongs to the specified organization as a public member.

getOrganizations

@WithBridgeMethods(value=java.util.Set.class)
public GHPersonSet<GHOrganization> getOrganizations()
                                             throws IOException

Gets the organization that this user belongs to publicly.

Throws:

IOException

listEvents

public PagedIterable<GHEventInfo> listEvents()
                                      throws IOException

Lists events performed by a user (this includes private events if the caller is authenticated.

Specified by:

listEvents in class GHPerson

Throws:

IOException

listGists

public PagedIterable<GHGist> listGists()
                                throws IOException

Lists Gists created by this user.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object