org.springframework.social.github.api
Interface GitHubApi

All Known Implementing Classes:

GitHubTemplate

public interface GitHubApi

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.

Method Summary

java.lang.String	getProfileId() Retrieves the user's GitHub profile ID.
java.lang.String	getProfileUrl() Retrieve the URL to the user's GitHub profile.
GitHubUserProfile	getUserProfile() Retrieves the user's GitHub profile details.

Method Detail

getProfileId

java.lang.String getProfileId()

Retrieves the user's GitHub profile ID.

Returns:

the user's GitHub profile ID.

getUserProfile

GitHubUserProfile getUserProfile()

Retrieves the user's GitHub profile details.

Returns:

the user's GitHub profile

getProfileUrl

java.lang.String getProfileUrl()

Retrieve the URL to the user's GitHub profile.

Returns:

the URL to the user's GitHub profile.