Spring Social GitHub

org.springframework.social.github.api
Interface GistOperations

All Known Implementing Classes:
GistTemplate

public interface GistOperations

Interface defining the operations for working with GitHub gists.

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

Method Summary
 GitHubGist getGist(java.lang.String id)
          Returns the gist with the given ID.
 GitHubComment getGistComment(java.lang.Long id)
          Public operation to return a gist comment.
 java.util.List<GitHubComment> getGistComments(java.lang.String gistId)
          Public operation to return the comments on a given gist.
 java.util.List<GitHubGist> getGists()
           If authenticated, this method returns the current user's gists.
 java.util.List<GitHubGist> getPublicGists()
          Public operation to return all public gists.
 java.util.List<GitHubGist> getStarredGists()
          Returns the authenticated user's starred gists.
 java.util.List<GitHubGist> getUserGists(java.lang.String user)
          Public operation to return the given user's public gists.
 

Method Detail

getUserGists

java.util.List<GitHubGist> getUserGists(java.lang.String user)
Public operation to return the given user's public gists.

Parameters:
user - GitHub user
Returns:
list of user's gists

getGists

java.util.List<GitHubGist> getGists()

If authenticated, this method returns the current user's gists. Otherwise it returns all public gists.

Returns:
current user's gists, or else all public gists

getPublicGists

java.util.List<GitHubGist> getPublicGists()
Public operation to return all public gists.

Returns:
all public gists

getStarredGists

java.util.List<GitHubGist> getStarredGists()
Returns the authenticated user's starred gists.

Returns:
authenticated user's starred gists

getGist

GitHubGist getGist(java.lang.String id)
Returns the gist with the given ID.

Parameters:
id - gist ID
Returns:
gist

getGistComments

java.util.List<GitHubComment> getGistComments(java.lang.String gistId)
Public operation to return the comments on a given gist.

Parameters:
gistId - gist ID
Returns:
gist comments

getGistComment

GitHubComment getGistComment(java.lang.Long id)
Public operation to return a gist comment.

Parameters:
id - comment ID
Returns:
comment

Spring Social GitHub