Package 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 Detail

      • getUserGists

        List<GitHubGist> getUserGists​(String user)
        Public operation to return the given user's public gists.
        Parameters:
        user - GitHub user
        Returns:
        list of user's gists

      • getGists

        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

        List<GitHubGist> getPublicGists()
        Public operation to return all public gists.
        Returns:
        all public gists

      • getStarredGists

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

      • getGist

        GitHubGist getGist​(String id)
        Returns the gist with the given ID.
        Parameters:
        id - gist ID
        Returns:
        gist

      • getGistComments

        List<GitHubComment> getGistComments​(String gistId)
        Public operation to return the comments on a given gist.
        Parameters:
        gistId - gist ID
        Returns:
        gist comments

      • getGistComment

        GitHubComment getGistComment​(Long id)
        Public operation to return a gist comment.
        Parameters:
        id - comment ID
        Returns:
        comment