org.springframework.social.gowalla.api
Interface GowallaApi

All Known Implementing Classes:

GowallaTemplate

public interface GowallaApi

Interface specifying a basic set of operations for interacting with Gowalla. Implemented by GowallaTemplate. Many of the methods contained in this interface require OAuth authentication with Gowalla. 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 Gowalla profile ID.
java.lang.String	getProfileUrl() Retrieves a URL to the user's public profile page.
java.util.List<Checkin>	getTopCheckins(java.lang.String userId) Retrieves a list of the spots that the user has checked into most.
GowallaProfile	getUserProfile() Gets the authenticating user's profile data.
GowallaProfile	getUserProfile(java.lang.String userId) Gets a specific user's profile data.

Method Detail

getProfileId

java.lang.String getProfileId()

Retrieves the user's Gowalla profile ID.

Returns:

the user's Gowalla profile ID.

getProfileUrl

java.lang.String getProfileUrl()

Retrieves a URL to the user's public profile page.

Returns:

a URL to the user's public profile page.

getUserProfile

GowallaProfile getUserProfile()

Gets the authenticating user's profile data.

Returns:

profile information for the authenticating user.

getUserProfile

GowallaProfile getUserProfile(java.lang.String userId)

Gets a specific user's profile data.

Parameters:

userId - the user ID to retrieve profile data for

Returns:

profile information for the specified user.

getTopCheckins

java.util.List<Checkin> getTopCheckins(java.lang.String userId)

Retrieves a list of the spots that the user has checked into most.

Parameters:

userId -

Returns:

a list of Checkins that the user has visited the most.