GHPerson (GitHub API for Java 1.79 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 java.lang.String`	`avatar_url`
`protected java.lang.String`	`blog`
`protected java.lang.String`	`company`
`protected java.lang.String`	`email`
`protected int`	`followers`
`protected int`	`following`
`protected java.lang.String`	`gravatar_id`
`protected java.lang.String`	`html_url`
`protected java.lang.String`	`location`
`protected java.lang.String`	`login`
`protected java.lang.String`	`name`
`protected int`	`public_gists`
`protected int`	`public_repos`

Fields inherited from class org.kohsuke.github.GHObject
created_at, id, 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
`java.lang.String`	`getAvatarUrl()` Returns a string like 'https://secure.gravatar.com/avatar/0cb9832a01c22c083390f3c5dcb64105' that indicates the avatar image URL.
`java.lang.String`	`getBlog()` Gets the blog URL of this user.
`java.lang.String`	`getCompany()` Gets the company name of this user, like "Sun Microsystems, Inc."
`java.util.Date`	`getCreatedAt()` When was this resource created?
`java.lang.String`	`getEmail()` Gets the e-mail address of the user.
`int`	`getFollowersCount()`
`int`	`getFollowingCount()`
`java.lang.String`	`getGravatarId()` Deprecated. No longer available in the v3 API.
`java.net.URL`	`getHtmlUrl()` URL of this object for humans, which renders some HTML.
`java.lang.String`	`getLocation()` Gets the location of this user, like "Santa Clara, California"
`java.lang.String`	`getLogin()` Gets the login ID of this user, like 'kohsuke'
`java.lang.String`	`getName()` Gets the human-readable name of the user, like "Kohsuke Kawaguchi"
`int`	`getPublicGistCount()`
`int`	`getPublicRepoCount()`
`java.util.Map<java.lang.String,GHRepository>`	`getRepositories()` Gets the public repositories this user owns.
`GHRepository`	`getRepository(java.lang.String name)`
`java.util.Date`	`getUpdatedAt()` When was this resource last updated?
`java.lang.Iterable<java.util.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, getUrl, toString

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

- Field Detail
  - login
```
protected java.lang.String login
```
  - avatar_url
```
protected java.lang.String avatar_url
```
  - gravatar_id
```
protected java.lang.String gravatar_id
```
  - location
```
protected java.lang.String location
```
  - blog
```
protected java.lang.String blog
```
  - email
```
protected java.lang.String email
```
  - name
```
protected java.lang.String name
```
  - company
```
protected java.lang.String company
```
  - html_url
```
protected java.lang.String html_url
```
  - followers
```
protected int followers
```
  - following
```
protected int following
```
  - public_repos
```
protected int public_repos
```
  - public_gists
```
protected int public_gists
```
- Constructor Detail
  - GHPerson
```
public GHPerson()
```
- Method Detail
  - populate
```
protected void populate()
                 throws java.io.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:
    
    java.io.IOException
  - getRepositories
```
public java.util.Map<java.lang.String,GHRepository> getRepositories()
                                                             throws java.io.IOException
```
    Gets the public repositories this user owns.
    To list your own repositories, including private repositories, use GHMyself.listRepositories()
    
    Throws:
    
    java.io.IOException
  - 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.
  - 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.
  - iterateRepositories
```
public java.lang.Iterable<java.util.List<GHRepository>> iterateRepositories(int pageSize)
```
    Deprecated. Use listRepositories()
    
    Loads repository list in a pagenated fashion.
    For a person with a lot of repositories, GitHub returns the list of repositories in a pagenated 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.
  - getRepository
```
public GHRepository getRepository(java.lang.String name)
                           throws java.io.IOException
```
    Returns:
    
    null if the repository was not found
    
    Throws:
    
    java.io.IOException
  - listEvents
```
public abstract PagedIterable<GHEventInfo> listEvents()
                                               throws java.io.IOException
```
    Lists events for an organization or an user.
    
    Throws:
    
    java.io.IOException
  - getGravatarId
```
public java.lang.String getGravatarId()
```
    Deprecated. No longer available in the v3 API.
    
    Gravatar ID of this user, like 0cb9832a01c22c083390f3c5dcb64105
  - getAvatarUrl
```
public java.lang.String getAvatarUrl()
```
    Returns a string like 'https://secure.gravatar.com/avatar/0cb9832a01c22c083390f3c5dcb64105' that indicates the avatar image URL.
  - getLogin
```
public java.lang.String getLogin()
```
    Gets the login ID of this user, like 'kohsuke'
  - getName
```
public java.lang.String getName()
                         throws java.io.IOException
```
    Gets the human-readable name of the user, like "Kohsuke Kawaguchi"
    
    Throws:
    
    java.io.IOException
  - getCompany
```
public java.lang.String getCompany()
                            throws java.io.IOException
```
    Gets the company name of this user, like "Sun Microsystems, Inc."
    
    Throws:
    
    java.io.IOException
  - getLocation
```
public java.lang.String getLocation()
                             throws java.io.IOException
```
    Gets the location of this user, like "Santa Clara, California"
    
    Throws:
    
    java.io.IOException
  - getCreatedAt
```
public java.util.Date getCreatedAt()
                            throws java.io.IOException
```
    Description copied from class: GHObject
    
    When was this resource created?
    
    Overrides:
    
    getCreatedAt in class GHObject
    
    Throws:
    
    java.io.IOException
  - getUpdatedAt
```
public java.util.Date getUpdatedAt()
                            throws java.io.IOException
```
    Description copied from class: GHObject
    
    When was this resource last updated?
    
    Overrides:
    
    getUpdatedAt in class GHObject
    
    Throws:
    
    java.io.IOException
  - getBlog
```
public java.lang.String getBlog()
                         throws java.io.IOException
```
    Gets the blog URL of this user.
    
    Throws:
    
    java.io.IOException
  - getHtmlUrl
```
public java.net.URL getHtmlUrl()
```
    Description copied from class: GHObject
    
    URL of this object for humans, which renders some HTML.
    
    Specified by:
    
    getHtmlUrl in class GHObject
  - getEmail
```
public java.lang.String getEmail()
                          throws java.io.IOException
```
    Gets the e-mail address of the user.
    
    Throws:
    
    java.io.IOException
  - getPublicGistCount
```
public int getPublicGistCount()
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getPublicRepoCount
```
public int getPublicRepoCount()
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getFollowingCount
```
public int getFollowingCount()
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getFollowersCount
```
public int getFollowersCount()
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException

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

html_url

followers

following

public_repos

public_gists

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