com.captainup.android.core

Interface CaptainUpConnection

All Known Subinterfaces:

AuthenticatedCaptainUpConnection

public interface CaptainUpConnection

A connection to the Captain Up Platform. An instance of this interface should be instantiated using CaptainUpConnectionFactory.createConnection(String, String, String). Contains method that does not require authentication to be used (aside from the App ID and Mobile Token, that was used to create the connection).

Method Summary

Modifier and Type	Method and Description
UserCaptainUpResponse	addOrUpdateIntegrationUser(IntegrationUser user) Allows you to either update an existing user account or create a new user account, based on a unique user ID that you create and maintain in your system.
void	addOrUpdateIntegrationUserAsync(IntegrationUser user, CaptainUpCallback<UserCaptainUpResponse> callback) Allows you to either update an existing user account or create a new user account, based on a unique user ID that you create and maintain in your system.
AuthenticatedCaptainUpConnection	authenticate(User user) Returns an authenticated connection to captain up.
GetActionCaptainUpResponse	queryActions(java.lang.String playerId, Query query) Returns several actions and information about the users associated with them.
void	queryActionsAsync(java.lang.String playerId, Query query, CaptainUpCallback<GetActionCaptainUpResponse> callback) Returns several actions and information about the users associated with them.
LeaderboardCaptainUpResponse	queryLeaderboard(LeaderboardTime time, java.lang.String playerId, Query query) Returns several users from the requested leaderboard, including general information on those users, and their position in the leaderboard.
void	queryLeaderboardAsync(LeaderboardTime time, java.lang.String playerId, Query query, CaptainUpCallback<LeaderboardCaptainUpResponse> callback) Returns several users from the requested leaderboard, including general information on those users, and their position in the leaderboard.
GetSocialFeedCaptainUpResponse	querySocialFeed(Query query) Returns the social feed, which is constructed by several actions from different users and information about the users associated with them.
void	querySocialFeedAsync(Query query, CaptainUpCallback<GetSocialFeedCaptainUpResponse> callback) Returns several actions and information about the users associated with them.
ApplicationCaptainUpResponse	retrieveApplication() Returns all the current connected application's settings, including information on the action settings, levels, badges and etc.
void	retrieveApplicationAsync(CaptainUpCallback<ApplicationCaptainUpResponse> callback) Returns all the current connected application's settings, including information on the action settings, levels, badges and etc.
UserCaptainUpResponse	retrieveUser(java.lang.String userId) Returns information about the specific user requested, including general information about the user (name, Facebook link, avatar, etc.) and information about the user's progress (current level, number of points, missions and progress).
void	retrieveUserAsync(java.lang.String userId, CaptainUpCallback<UserCaptainUpResponse> callback) Returns information about the specific user requested, including general information about the user (name, Facebook link, avatar, etc.) and information about the user's progress (current level, number of points, missions and progress).
void	setLanguageCode(java.lang.String languageCode) Use this function for setting your user localization, setting language code will affect your application badges and levels as localized in the admins panel.

Method Detail

retrieveApplication

ApplicationCaptainUpResponse retrieveApplication()
                                          throws CaptainUpException

Returns all the current connected application's settings, including information on the action settings, levels, badges and etc.

Returns:

a response object that may either contain an error code or the application's information

Throws:

CaptainUpException

See Also:

retrieveApplicationAsync(CaptainUpCallback)

retrieveApplicationAsync

void retrieveApplicationAsync(CaptainUpCallback<ApplicationCaptainUpResponse> callback)

Returns all the current connected application's settings, including information on the action settings, levels, badges and etc. This method is preferred over retrieveApplication() since this will not block the current thread until the request returns.

Parameters:

callback - a callback that will contain the response and any exception that might have risen during the execution.

See Also:

retrieveApplication()

addOrUpdateIntegrationUser

UserCaptainUpResponse addOrUpdateIntegrationUser(IntegrationUser user)
                                          throws CaptainUpException

Allows you to either update an existing user account or create a new user account, based on a unique user ID that you create and maintain in your system. The response will contain the updated user information.

Parameters:

user - the user details to create or update. The user can be created using the IntegrationUserBuilder

Returns:

a response object that may either contain an error code or the updated user information

Throws:

CaptainUpException

See Also:

addOrUpdateIntegrationUserAsync(IntegrationUser, CaptainUpCallback)

addOrUpdateIntegrationUserAsync

void addOrUpdateIntegrationUserAsync(IntegrationUser user,
                                     CaptainUpCallback<UserCaptainUpResponse> callback)
                              throws CaptainUpException

Allows you to either update an existing user account or create a new user account, based on a unique user ID that you create and maintain in your system. The response will contain the updated user information. This method is preferred over queryActions since this will not block the current thread until the request returns.

Parameters:

user - the user details to create or update. The user can be created using the IntegrationUserBuilder

callback - a callback that will contain the response and any exception that might have risen during the execution.

Throws:

CaptainUpException

See Also:

addOrUpdateIntegrationUser(IntegrationUser)

queryActions

GetActionCaptainUpResponse queryActions(java.lang.String playerId,
                                        Query query)
                                 throws CaptainUpException

Returns several actions and information about the users associated with them. Only returns public actions, since there is no authenticated user. Use this method to request the public actions of any user in your application.

Parameters:

playerId - the ID of the player whose actions are requested

query - query parameters. To create a query object use QueryBuilder

Returns:

a response object that may either contain an error code or the list of requested actions

Throws:

CaptainUpException

See Also:

queryActionsAsync(String, Query, CaptainUpCallback)

queryActionsAsync

void queryActionsAsync(java.lang.String playerId,
                       Query query,
                       CaptainUpCallback<GetActionCaptainUpResponse> callback)

Returns several actions and information about the users associated with them. Only returns public actions, since there is no authenticated user. Use this method to request the public actions of any user in your application. This method is preferred over queryActions since this will not block the current thread until the request returns.

Parameters:

playerId - the ID of the player whose actions are requested

query - query parameters. To create a query object use QueryBuilder

callback - a callback that will contain the response and any exception that might have risen during the execution.

See Also:

queryActions(String, Query)

querySocialFeed

GetSocialFeedCaptainUpResponse querySocialFeed(Query query)
                                        throws CaptainUpException

Returns the social feed, which is constructed by several actions from different users and information about the users associated with them. Only returns public actions.

Parameters:

query - query parameters. To create a query object use QueryBuilder

Returns:

a response object that may either contain an error code or the list of the social feed items {@link SocialFeedItem )

Throws:

CaptainUpException

See Also:

#querySocialFeedAsync(String, Query, CaptainUpCallback)

querySocialFeedAsync

void querySocialFeedAsync(Query query,
                          CaptainUpCallback<GetSocialFeedCaptainUpResponse> callback)

Returns several actions and information about the users associated with them. Only returns public actions, since there is no authenticated user. Use this method to request the public actions of any user in your application. This method is preferred over queryActions since this will not block the current thread until the request returns.

Parameters:

query - query parameters. To create a query object use QueryBuilder

callback - a callback that will contain the response and any exception that might have risen during the execution.

See Also:

querySocialFeed(Query)

queryLeaderboard

LeaderboardCaptainUpResponse queryLeaderboard(LeaderboardTime time,
                                              java.lang.String playerId,
                                              Query query)
                                       throws CaptainUpException

Returns several users from the requested leaderboard, including general information on those users, and their position in the leaderboard.

Parameters:

time - the type of the leaderboard (according to the time limit on the leaderboard)

playerId - the user id for the user we want to focus the leaderboard on. Useful for showing a specific user’s standing in the leaderboard. If playerId is not null, the skip query parameter will be dismissed. The response will be a list of the players around the given player, with a maximum of half the users above the player and the rest below.

query - query parameters. To create a query object use QueryBuilder.

• skip - The number of users to skip when returning the users. If skip is above the total number of users, an empty list of users will be returned.
• limit - The maximum number of users to return in the results. Can be between 10 and 100.
• extended - If set to true, will return extended information on each user.

Returns:

a response object that may either contain an error code or the leaderboard's details

Throws:

CaptainUpException

See Also:

queryLeaderboardAsync(LeaderboardTime, String, Query, CaptainUpCallback)

queryLeaderboardAsync

void queryLeaderboardAsync(LeaderboardTime time,
                           java.lang.String playerId,
                           Query query,
                           CaptainUpCallback<LeaderboardCaptainUpResponse> callback)

Returns several users from the requested leaderboard, including general information on those users, and their position in the leaderboard. his method is preferred over queryLeaderboard since this will not block the current thread until the request returns.

Parameters:

time - the type of the leaderboard (according to the time limit on the leaderboard)

playerId - the user id for the user we want to focus the leaderboard on. Useful for showing a specific user’s standing in the leaderboard. If playerId is not null, the skip query parameter will be dismissed. The response will be a list of the players around the given player, with a maximum of half the users above the player and the rest below.

query - query parameters. To create a query object use QueryBuilder.

• skip - The number of users to skip when returning the users. If skip is above the total number of users, an empty list of users will be returned.
• limit - The maximum number of users to return in the results. Can be between 10 and 100.
• extended - If set to true, will return extended information on each user.

callback - a callback that will contain the response and any exception that might have risen during the execution.

See Also:

queryLeaderboard(LeaderboardTime, String, Query)

retrieveUser

UserCaptainUpResponse retrieveUser(java.lang.String userId)
                            throws CaptainUpException

Returns information about the specific user requested, including general information about the user (name, Facebook link, avatar, etc.) and information about the user's progress (current level, number of points, missions and progress).

Parameters:

userId - the user's captain-up ID

Returns:

a response object that may either contain an error code or the requested user information

Throws:

CaptainUpException

See Also:

retrieveUserAsync(String, CaptainUpCallback)

retrieveUserAsync

void retrieveUserAsync(java.lang.String userId,
                       CaptainUpCallback<UserCaptainUpResponse> callback)

Returns information about the specific user requested, including general information about the user (name, Facebook link, avatar, etc.) and information about the user's progress (current level, number of points, missions and progress). This method is preferred over retrieveUser since this will not block the current thread until the request returns.

Parameters:

userId - the user's captain-up ID

callback - callback that will contain the response and any exception that might have risen during the execution.

See Also:

retrieveUser(String)

authenticate

AuthenticatedCaptainUpConnection authenticate(User user)

Returns an authenticated connection to captain up. Some operations are only available after authentication.

Parameters:

user - the user to authenticate. This user can be acquired from the addOrUpdateIntegrationUser.

Returns:

an authenticated connection to captain up.

See Also:

addOrUpdateIntegrationUser(IntegrationUser), addOrUpdateIntegrationUserAsync(IntegrationUser, CaptainUpCallback)

setLanguageCode

void setLanguageCode(java.lang.String languageCode)

Use this function for setting your user localization, setting language code will affect your application badges and levels as localized in the admins panel. this function must be called *before calling @see authenticate(User user) or connect. This function is used internally by CaptainUpManager object

Parameters:

languageCode -