org.kohsuke.github

Class GHMyself

java.lang.Object

org.kohsuke.github.GHObject

org.kohsuke.github.GHPerson

org.kohsuke.github.GHUser

org.kohsuke.github.GHMyself

public class GHMyself
extends GHUser

Represents the account that's logging into GitHub.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GHMyself.RepositoryListFilter Type of repositories returned during listing.

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
GHMyself()

Method Summary

Methods

Modifier and Type	Method and Description
GHPersonSet<GHOrganization>	getAllOrganizations() Gets the organization that this user belongs to.
Map<String,GHRepository>	getAllRepositories() Gets the all repositories this user owns (public and private).
List<String>	getEmails() Deprecated. Use getEmails2()
List<GHEmail>	getEmails2() Returns the read-only list of e-mail addresses configured for you.
List<GHKey>	getPublicKeys() Returns the read-only list of all the pulic keys of the current user.
List<GHVerifiedKey>	getPublicVerifiedKeys() Returns the read-only list of all the public verified keys of the current user.
PagedIterable<GHRepository>	listAllRepositories() Deprecated. Use listRepositories()
PagedIterable<GHRepository>	listRepositories() Lists up all repositories this user owns (public and private).
PagedIterable<GHRepository>	listRepositories(int pageSize) List repositories that are accessible to the authenticated user (public and private) using the specified page size.
PagedIterable<GHRepository>	listRepositories(int pageSize, GHMyself.RepositoryListFilter repoType) List repositories of a certain type that are accessible by current authenticated user using the specified page size.

Methods inherited from class org.kohsuke.github.GHUser

equals, follow, getFollowers, getFollows, getOrganizations, hashCode, isMemberOf, isMemberOf, isPublicMemberOf, listEvents, listFollowers, listFollows, listGists, listStarredRepositories, listSubscriptions, toString, unfollow

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, 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

GHMyself

public GHMyself()

Method Detail

getEmails

public List<String> getEmails()
                       throws IOException

Deprecated. Use getEmails2()

Throws:

IOException

getEmails2

public List<GHEmail> getEmails2()
                         throws IOException

Returns the read-only list of e-mail addresses configured for you. This corresponds to the stuff you configure in https://github.com/settings/emails, and not to be confused with GHPerson.getEmail() that shows your public e-mail address set in https://github.com/settings/profile

Returns:

Always non-null.

Throws:

IOException

getPublicKeys

public List<GHKey> getPublicKeys()
                          throws IOException

Returns the read-only list of all the pulic keys of the current user. NOTE: When using OAuth authenticaiton, the READ/WRITE User scope is required by the GitHub APIs, otherwise you will get a 404 NOT FOUND.

Returns:

Always non-null.

Throws:

IOException

getPublicVerifiedKeys

public List<GHVerifiedKey> getPublicVerifiedKeys()
                                          throws IOException

Returns the read-only list of all the public verified keys of the current user. Differently from the getPublicKeys() method, the retrieval of the user's verified public keys does not require any READ/WRITE OAuth Scope to the user's profile.

Returns:

Always non-null.

Throws:

IOException

getAllOrganizations

public GHPersonSet<GHOrganization> getAllOrganizations()
                                                throws IOException

Gets the organization that this user belongs to.

Throws:

IOException

getAllRepositories

public Map<String,GHRepository> getAllRepositories()
                                            throws IOException

Gets the all repositories this user owns (public and private).

Throws:

IOException

listRepositories

public PagedIterable<GHRepository> listRepositories()

Lists up all repositories this user owns (public and private). Unlike getAllRepositories(), this does not wait until all the repositories are returned. Repositories are returned by GitHub API with a 30 items per page.

Overrides:

listRepositories in class GHPerson

listRepositories

public PagedIterable<GHRepository> listRepositories(int pageSize)

List repositories that are accessible to the authenticated user (public and private) using the specified page size. This includes repositories owned by the authenticated user, repositories that belong to other users where the authenticated user is a collaborator, and other organizations' repositories that the authenticated user has access to through an organization membership.

Overrides:

listRepositories in class GHPerson

Parameters:

pageSize - size for each page of items returned by GitHub. Maximum page size is 100. Unlike GHPerson.getRepositories(), this does not wait until all the repositories are returned.

listRepositories

public PagedIterable<GHRepository> listRepositories(int pageSize,
                                           GHMyself.RepositoryListFilter repoType)

List repositories of a certain type that are accessible by current authenticated user using the specified page size.

Parameters:

pageSize - size for each page of items returned by GitHub. Maximum page size is 100.

repoType - type of repository returned in the listing

listAllRepositories

public PagedIterable<GHRepository> listAllRepositories()

Deprecated. Use listRepositories()