Spring Social GitHub

org.springframework.social.github.api
Interface GitHub

All Superinterfaces:
org.springframework.social.ApiBinding
All Known Implementing Classes:
GitHubTemplate

public interface GitHub
extends org.springframework.social.ApiBinding

Interface specifying a basic set of operations for interacting with GitHub. Implemented by GitHubTemplate. Many of the methods contained in this interface require OAuth authentication with GitHub. When a method's description speaks of the "current user", it is referring to the user for whom the access token has been issued.

Author:
Craig Walls, Willie Wheeler (willie.wheeler@gmail.com)

Method Summary
 GistOperations gistOperations()
          Returns the portion of the GitHub API containing the gist operations.
 RepoOperations repoOperations()
          Returns the portion of the GitHub API containing the repo operations.
 org.springframework.web.client.RestOperations restOperations()
          Returns the underlying RestOperations object allowing for consumption of GitHub endpoints that may not be otherwise covered by the API binding.
 UserOperations userOperations()
          Returns the portion of the GitHub API containing the user operations.
 
Methods inherited from interface org.springframework.social.ApiBinding
isAuthorized
 

Method Detail

gistOperations

GistOperations gistOperations()
Returns the portion of the GitHub API containing the gist operations.

Returns:
gist operations

repoOperations

RepoOperations repoOperations()
Returns the portion of the GitHub API containing the repo operations.

Returns:
repo operations

userOperations

UserOperations userOperations()
Returns the portion of the GitHub API containing the user operations.

Returns:
user operations

restOperations

org.springframework.web.client.RestOperations restOperations()
Returns the underlying RestOperations object allowing for consumption of GitHub endpoints that may not be otherwise covered by the API binding. The RestOperations object returned is configured to include an OAuth "Authorization" header on all requests.


Spring Social GitHub