GHPerson (GitHub API for Java 1.102 API)

java.lang.Object
- org.kohsuke.github.GHObject
- - org.kohsuke.github.GHPerson

Direct Known Subclasses:

GHOrganization, GHUser
```
public abstract class GHPerson
extends GHObject
```
Common part of GHUser and GHOrganization.

Author:

Kohsuke Kawaguchi

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`avatar_url`
`protected String`	`blog`
`protected String`	`company`
`protected String`	`email`
`protected int`	`followers`
`protected int`	`following`
`protected String`	`gravatar_id`
`protected String`	`html_url`
`protected String`	`location`
`protected String`	`login`
`protected String`	`name`
`protected int`	`public_gists`
`protected int`	`public_repos`
`protected boolean`	`site_admin`
`protected String`	`type`

Fields inherited from class org.kohsuke.github.GHObject
created_at, id, responseHeaderFields, updated_at, url

Constructor Summary

Constructors
Constructor and Description

GHPerson()

Constructors
Constructor and Description
`GHPerson()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAvatarUrl()` Returns a string like 'https://secure.gravatar.com/avatar/0cb9832a01c22c083390f3c5dcb64105' that indicates the avatar image URL.
`String`	`getBlog()` Gets the blog URL of this user.
`String`	`getCompany()` Gets the company name of this user, like "Sun Microsystems, Inc."
`Date`	`getCreatedAt()` When was this resource created?
`String`	`getEmail()` Gets the e-mail address of the user.
`int`	`getFollowersCount()` Gets followers count.
`int`	`getFollowingCount()` Gets following count.
`String`	`getGravatarId()` Deprecated. No longer available in the v3 API.
`URL`	`getHtmlUrl()` Gets html url.
`String`	`getLocation()` Gets the location of this user, like "Santa Clara, California"
`String`	`getLogin()` Gets the login ID of this user, like 'kohsuke'
`String`	`getName()` Gets the human-readable name of the user, like "Kohsuke Kawaguchi"
`int`	`getPublicGistCount()` Gets public gist count.
`int`	`getPublicRepoCount()` Gets public repo count.
`Map<String,GHRepository>`	`getRepositories()` Gets the public repositories this user owns.
`GHRepository`	`getRepository(String name)` Gets repository.
`String`	`getType()` Gets the type.
`Date`	`getUpdatedAt()` When was this resource last updated?
`boolean`	`isSiteAdmin()` Gets the site_admin field
`Iterable<List<GHRepository>>`	`iterateRepositories(int pageSize)` Deprecated. Use `listRepositories()`
`abstract PagedIterable<GHEventInfo>`	`listEvents()` Lists events for an organization or an user.
`PagedIterable<GHRepository>`	`listRepositories()` Lists up all the repositories using a 30 items page size.
`PagedIterable<GHRepository>`	`listRepositories(int pageSize)` Lists up all the repositories using the specified page size.
`protected void`	`populate()` Fully populate the data by retrieving missing data.

Methods inherited from class org.kohsuke.github.GHObject
getId, getResponseHeaderFields, getUrl, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - login
```
protected String login
```
  - avatar_url
```
protected String avatar_url
```
  - gravatar_id
```
protected String gravatar_id
```
  - location
```
protected String location
```
  - blog
```
protected String blog
```
  - email
```
protected String email
```
  - name
```
protected String name
```
  - company
```
protected String company
```
  - type
```
protected String type
```
  - html_url
```
protected String html_url
```
  - followers
```
protected int followers
```
  - following
```
protected int following
```
  - public_repos
```
protected int public_repos
```
  - public_gists
```
protected int public_gists
```
  - site_admin
```
protected boolean site_admin
```
- Constructor Detail
  - GHPerson
```
public GHPerson()
```
- Method Detail
  - populate
```
protected void populate()
                 throws IOException
```
    Fully populate the data by retrieving missing data.
    Depending on the original API call where this object is created, it may not contain everything.
    
    Throws:
    
    IOException - the io exception
  - getRepositories
```
public Map<String,GHRepository> getRepositories()
                                         throws IOException
```
    Gets the public repositories this user owns.
    To list your own repositories, including private repositories, use GHMyself.listRepositories()
    
    Returns:
    
    the repositories
    
    Throws:
    
    IOException - the io exception
  - listRepositories
```
public PagedIterable<GHRepository> listRepositories()
```
    Lists up all the repositories using a 30 items page size.
    Unlike getRepositories(), this does not wait until all the repositories are returned.
    
    Returns:
    
    the paged iterable
  - listRepositories
```
public PagedIterable<GHRepository> listRepositories(int pageSize)
```
    Lists up all the repositories using the specified page size.
    
    Parameters:
    
    pageSize - size for each page of items returned by GitHub. Maximum page size is 100. Unlike getRepositories(), this does not wait until all the repositories are returned.
    
    Returns:
    
    the paged iterable
  - iterateRepositories
```
@Deprecated
public Iterable<List<GHRepository>> iterateRepositories(int pageSize)
```
    Deprecated. Use listRepositories()
    
    Loads repository list in a paginated fashion.
    For a person with a lot of repositories, GitHub returns the list of repositories in a paginated fashion. Unlike getRepositories(), this method allows the caller to start processing data as it arrives.
    Every Iterator.next() call results in I/O. Exceptions that occur during the processing is wrapped into Error.
    
    Parameters:
    
    pageSize - the page size
    
    Returns:
    
    the iterable
  - getRepository
```
public GHRepository getRepository(String name)
                           throws IOException
```
    Gets repository.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    null if the repository was not found
    
    Throws:
    
    IOException - the io exception
  - listEvents
```
public abstract PagedIterable<GHEventInfo> listEvents()
                                               throws IOException
```
    Lists events for an organization or an user.
    
    Returns:
    
    the paged iterable
    
    Throws:
    
    IOException - the io exception
  - getGravatarId
```
public String getGravatarId()
```
    Deprecated. No longer available in the v3 API.
    
    Gravatar ID of this user, like 0cb9832a01c22c083390f3c5dcb64105
    
    Returns:
    
    the gravatar id
  - getAvatarUrl
```
public String getAvatarUrl()
```
    Returns a string like 'https://secure.gravatar.com/avatar/0cb9832a01c22c083390f3c5dcb64105' that indicates the avatar image URL.
    
    Returns:
    
    the avatar url
  - getLogin
```
public String getLogin()
```
    Gets the login ID of this user, like 'kohsuke'
    
    Returns:
    
    the login
  - getName
```
public String getName()
               throws IOException
```
    Gets the human-readable name of the user, like "Kohsuke Kawaguchi"
    
    Returns:
    
    the name
    
    Throws:
    
    IOException - the io exception
  - getCompany
```
public String getCompany()
                  throws IOException
```
    Gets the company name of this user, like "Sun Microsystems, Inc."
    
    Returns:
    
    the company
    
    Throws:
    
    IOException - the io exception
  - getLocation
```
public String getLocation()
                   throws IOException
```
    Gets the location of this user, like "Santa Clara, California"
    
    Returns:
    
    the location
    
    Throws:
    
    IOException - the io exception
  - getCreatedAt
```
public Date getCreatedAt()
                  throws IOException
```
    Description copied from class: GHObject
    
    When was this resource created?
    
    Overrides:
    
    getCreatedAt in class GHObject
    
    Returns:
    
    date created
    
    Throws:
    
    IOException - on error
  - getUpdatedAt
```
public Date getUpdatedAt()
                  throws IOException
```
    Description copied from class: GHObject
    
    When was this resource last updated?
    
    Overrides:
    
    getUpdatedAt in class GHObject
    
    Returns:
    
    updated date
    
    Throws:
    
    IOException - on error
  - getBlog
```
public String getBlog()
               throws IOException
```
    Gets the blog URL of this user.
    
    Returns:
    
    the blog
    
    Throws:
    
    IOException - the io exception
  - getHtmlUrl
```
public URL getHtmlUrl()
```
    Description copied from class: GHObject
    
    Gets html url.
    
    Specified by:
    
    getHtmlUrl in class GHObject
    
    Returns:
    
    URL of this object for humans, which renders some HTML.
  - getEmail
```
public String getEmail()
                throws IOException
```
    Gets the e-mail address of the user.
    
    Returns:
    
    the email
    
    Throws:
    
    IOException - the io exception
  - getPublicGistCount
```
public int getPublicGistCount()
                       throws IOException
```
    Gets public gist count.
    
    Returns:
    
    the public gist count
    
    Throws:
    
    IOException - the io exception
  - getPublicRepoCount
```
public int getPublicRepoCount()
                       throws IOException
```
    Gets public repo count.
    
    Returns:
    
    the public repo count
    
    Throws:
    
    IOException - the io exception
  - getFollowingCount
```
public int getFollowingCount()
                      throws IOException
```
    Gets following count.
    
    Returns:
    
    the following count
    
    Throws:
    
    IOException - the io exception
  - getFollowersCount
```
public int getFollowersCount()
                      throws IOException
```
    Gets followers count.
    
    Returns:
    
    the followers count
    
    Throws:
    
    IOException - the io exception
  - getType
```
public String getType()
               throws IOException
```
    Gets the type. This is either "User" or "Organization".
    
    Returns:
    
    the type
    
    Throws:
    
    IOException - the io exception
  - isSiteAdmin
```
public boolean isSiteAdmin()
                    throws IOException
```
    Gets the site_admin field
    
    Returns:
    
    the site_admin field
    
    Throws:
    
    IOException - the io exception

Class GHPerson

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

Constructor Summary

Method Summary

Methods inherited from class org.kohsuke.github.GHObject

Methods inherited from class java.lang.Object

Field Detail

login

avatar_url

gravatar_id

location

blog

email

name

company

type

html_url

followers

following

public_repos

public_gists

site_admin

Constructor Detail

GHPerson

Method Detail

populate

getRepositories

listRepositories

listRepositories

iterateRepositories

getRepository

listEvents

getGravatarId

getAvatarUrl

getLogin

getName

getCompany

getLocation

getCreatedAt

getUpdatedAt

getBlog

getHtmlUrl

getEmail

getPublicGistCount

getPublicRepoCount

getFollowingCount

getFollowersCount

getType

isSiteAdmin