UserService (jdroid-java-github 0.9.4 API)

java.lang.Object
- com.jdroid.github.service.GitHubService
- - com.jdroid.github.service.UserService

```
public class UserService
extends GitHubService
```
User service class.

See Also:

GitHub users API documentation, GitHub followers API documentation, GitHub user email API documentation, GitHub user keys API documentation

Field Summary
- Fields inherited from class com.jdroid.github.service.GitHubService
  ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors
Constructor and Description

UserService()
Create user service

UserService(GitHubClient client)
Create user service

Constructors
Constructor and Description
`UserService()` Create user service
`UserService(GitHubClient client)` Create user service

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEmail(java.lang.String... emails)` Add one or more e-mail addresses to the currently authenticated user's account
`protected PagedRequest<User>`	`createFollowersRequest(int start, int size, java.lang.String user)` Create follower request
`protected PagedRequest<User>`	`createFollowingRequest(int start, int size, java.lang.String user)` Create following request
`Key`	`createKey(Key key)` Create key for currently authenticated user
`void`	`deleteKey(int id)` Delete key with given id
`Key`	`editKey(Key key)` Edit key for currently authenticated user
`User`	`editUser(User user)` Edit given user
`void`	`follow(java.lang.String user)` Follow the given user
`java.util.List<java.lang.String>`	`getEmails()` Get all e-mail addresses for the currently authenticated user
`java.util.List<User>`	`getFollowers()` Get all followers of the currently authenticated user
`java.util.List<User>`	`getFollowers(java.lang.String user)` Get all followers of the given user
`java.util.List<User>`	`getFollowing()` Get all users being followed by the currently authenticated user
`java.util.List<User>`	`getFollowing(java.lang.String user)` Get all users being followed by the given user
`Key`	`getKey(int id)` Get key with given id
`java.util.List<Key>`	`getKeys()` Get all public keys for currently authenticated user
`User`	`getUser()` Get currently authenticated user
`User`	`getUser(java.lang.String login)` Get user with given login name
`boolean`	`isFollowing(java.lang.String user)` Check if the currently authenticated user is following the given user
`PageIterator<User>`	`pageFollowers()` Page followers of the currently authenticated user
`PageIterator<User>`	`pageFollowers(int size)` Page followers of the currently authenticated user
`PageIterator<User>`	`pageFollowers(int start, int size)` Page followers of the currently authenticated user
`PageIterator<User>`	`pageFollowers(java.lang.String user)` Page followers of the given user
`PageIterator<User>`	`pageFollowers(java.lang.String user, int size)` Page followers of the given user
`PageIterator<User>`	`pageFollowers(java.lang.String user, int start, int size)` Page followers of the given user
`PageIterator<User>`	`pageFollowing()` Page users being followed by the currently authenticated user
`PageIterator<User>`	`pageFollowing(int size)` Page users being followed by the currently authenticated user
`PageIterator<User>`	`pageFollowing(int start, int size)` Page users being followed by the currently authenticated user
`PageIterator<User>`	`pageFollowing(java.lang.String user)` Page users being followed by the given user
`PageIterator<User>`	`pageFollowing(java.lang.String user, int size)` Page users being followed by the given user
`PageIterator<User>`	`pageFollowing(java.lang.String user, int start, int size)` Page users being followed by the given user
`void`	`removeEmail(java.lang.String... emails)` Remove one or more e-mail addresses from the currently authenticated user's account
`void`	`unfollow(java.lang.String user)` Unfollow the given user

Methods inherited from class com.jdroid.github.service.GitHubService
check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

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

- Constructor Detail
  - UserService
```
public UserService()
```
    Create user service
  - UserService
```
public UserService(GitHubClient client)
```
    Create user service
    
    Parameters:
    
    client -
- Method Detail
  - getUser
```
public User getUser(java.lang.String login)
             throws java.io.IOException
```
    Get user with given login name
    
    Parameters:
    
    login -
    
    Returns:
    
    user
    
    Throws:
    
    java.io.IOException
  - getUser
```
public User getUser()
             throws java.io.IOException
```
    Get currently authenticated user
    
    Returns:
    
    user
    
    Throws:
    
    java.io.IOException
  - editUser
```
public User editUser(User user)
              throws java.io.IOException
```
    Edit given user
    
    Parameters:
    
    user -
    
    Returns:
    
    edited user
    
    Throws:
    
    java.io.IOException
  - createFollowersRequest
```
protected PagedRequest<User> createFollowersRequest(int start,
                                                    int size,
                                                    java.lang.String user)
```
    Create follower request
    
    Parameters:
    
    start -
    
    size -
    
    user -
    
    Returns:
    
    request
  - createFollowingRequest
```
protected PagedRequest<User> createFollowingRequest(int start,
                                                    int size,
                                                    java.lang.String user)
```
    Create following request
    
    Parameters:
    
    start -
    
    size -
    
    user -
    
    Returns:
    
    request
  - getFollowers
```
public java.util.List<User> getFollowers()
                                  throws java.io.IOException
```
    Get all followers of the currently authenticated user
    
    Returns:
    
    list of followers
    
    Throws:
    
    java.io.IOException
  - pageFollowers
```
public PageIterator<User> pageFollowers()
```
    Page followers of the currently authenticated user
    
    Returns:
    
    page iterator
  - pageFollowers
```
public PageIterator<User> pageFollowers(int size)
```
    Page followers of the currently authenticated user
    
    Parameters:
    
    size -
    
    Returns:
    
    page iterator
  - pageFollowers
```
public PageIterator<User> pageFollowers(int start,
                                        int size)
```
    Page followers of the currently authenticated user
    
    Parameters:
    
    start -
    
    size -
    
    Returns:
    
    page iterator
  - getFollowers
```
public java.util.List<User> getFollowers(java.lang.String user)
                                  throws java.io.IOException
```
    Get all followers of the given user
    
    Parameters:
    
    user -
    
    Returns:
    
    list of followers
    
    Throws:
    
    java.io.IOException
  - pageFollowers
```
public PageIterator<User> pageFollowers(java.lang.String user)
```
    Page followers of the given user
    
    Parameters:
    
    user -
    
    Returns:
    
    page iterator
  - pageFollowers
```
public PageIterator<User> pageFollowers(java.lang.String user,
                                        int size)
```
    Page followers of the given user
    
    Parameters:
    
    size -
    
    user -
    
    Returns:
    
    page iterator
  - pageFollowers
```
public PageIterator<User> pageFollowers(java.lang.String user,
                                        int start,
                                        int size)
```
    Page followers of the given user
    
    Parameters:
    
    start -
    
    size -
    
    user -
    
    Returns:
    
    page iterator
  - getFollowing
```
public java.util.List<User> getFollowing()
                                  throws java.io.IOException
```
    Get all users being followed by the currently authenticated user
    
    Returns:
    
    list of users being followed
    
    Throws:
    
    java.io.IOException
  - pageFollowing
```
public PageIterator<User> pageFollowing()
```
    Page users being followed by the currently authenticated user
    
    Returns:
    
    page iterator
  - pageFollowing
```
public PageIterator<User> pageFollowing(int size)
```
    Page users being followed by the currently authenticated user
    
    Parameters:
    
    size -
    
    Returns:
    
    page iterator
  - pageFollowing
```
public PageIterator<User> pageFollowing(int start,
                                        int size)
```
    Page users being followed by the currently authenticated user
    
    Parameters:
    
    start -
    
    size -
    
    Returns:
    
    page iterator
  - getFollowing
```
public java.util.List<User> getFollowing(java.lang.String user)
                                  throws java.io.IOException
```
    Get all users being followed by the given user
    
    Parameters:
    
    user -
    
    Returns:
    
    list of users being followed
    
    Throws:
    
    java.io.IOException
  - pageFollowing
```
public PageIterator<User> pageFollowing(java.lang.String user)
```
    Page users being followed by the given user
    
    Parameters:
    
    user -
    
    Returns:
    
    page iterator
  - pageFollowing
```
public PageIterator<User> pageFollowing(java.lang.String user,
                                        int size)
```
    Page users being followed by the given user
    
    Parameters:
    
    user -
    
    size -
    
    Returns:
    
    page iterator
  - pageFollowing
```
public PageIterator<User> pageFollowing(java.lang.String user,
                                        int start,
                                        int size)
```
    Page users being followed by the given user
    
    Parameters:
    
    user -
    
    start -
    
    size -
    
    Returns:
    
    page iterator
  - isFollowing
```
public boolean isFollowing(java.lang.String user)
                    throws java.io.IOException
```
    Check if the currently authenticated user is following the given user
    
    Parameters:
    
    user -
    
    Returns:
    
    true if following, false if not following
    
    Throws:
    
    java.io.IOException
  - follow
```
public void follow(java.lang.String user)
            throws java.io.IOException
```
    Follow the given user
    
    Parameters:
    
    user -
    
    Throws:
    
    java.io.IOException
  - unfollow
```
public void unfollow(java.lang.String user)
              throws java.io.IOException
```
    Unfollow the given user
    
    Parameters:
    
    user -
    
    Throws:
    
    java.io.IOException
  - getEmails
```
public java.util.List<java.lang.String> getEmails()
                                           throws java.io.IOException
```
    Get all e-mail addresses for the currently authenticated user
    
    Returns:
    
    list of e-mail address
    
    Throws:
    
    java.io.IOException
  - addEmail
```
public void addEmail(java.lang.String... emails)
              throws java.io.IOException
```
    Add one or more e-mail addresses to the currently authenticated user's account
    
    Parameters:
    
    emails -
    
    Throws:
    
    java.io.IOException
  - removeEmail
```
public void removeEmail(java.lang.String... emails)
                 throws java.io.IOException
```
    Remove one or more e-mail addresses from the currently authenticated user's account
    
    Parameters:
    
    emails -
    
    Throws:
    
    java.io.IOException
  - getKeys
```
public java.util.List<Key> getKeys()
                            throws java.io.IOException
```
    Get all public keys for currently authenticated user
    
    Returns:
    
    non-null list of public keys
    
    Throws:
    
    java.io.IOException
  - getKey
```
public Key getKey(int id)
           throws java.io.IOException
```
    Get key with given id
    
    Parameters:
    
    id -
    
    Returns:
    
    key
    
    Throws:
    
    java.io.IOException
  - createKey
```
public Key createKey(Key key)
              throws java.io.IOException
```
    Create key for currently authenticated user
    
    Parameters:
    
    key -
    
    Returns:
    
    created key
    
    Throws:
    
    java.io.IOException
  - editKey
```
public Key editKey(Key key)
            throws java.io.IOException
```
    Edit key for currently authenticated user
    
    Parameters:
    
    key -
    
    Returns:
    
    edited key
    
    Throws:
    
    java.io.IOException
  - deleteKey
```
public void deleteKey(int id)
               throws java.io.IOException
```
    Delete key with given id
    
    Parameters:
    
    id -
    
    Throws:
    
    java.io.IOException

Class UserService

Field Summary

Fields inherited from class com.jdroid.github.service.GitHubService

Constructor Summary

Method Summary

Methods inherited from class com.jdroid.github.service.GitHubService

Methods inherited from class java.lang.Object

Constructor Detail

UserService

UserService

Method Detail

getUser

getUser

editUser

createFollowersRequest

createFollowingRequest

getFollowers

pageFollowers

pageFollowers

pageFollowers

getFollowers

pageFollowers

pageFollowers

pageFollowers

getFollowing

pageFollowing

pageFollowing

pageFollowing

getFollowing

pageFollowing

pageFollowing

pageFollowing

isFollowing

follow

unfollow

getEmails

addEmail

removeEmail

getKeys

getKey

createKey

editKey

deleteKey