com.captainup.android.core.model

Interface User

All Superinterfaces:

CaptainUpObject

All Known Subinterfaces:

ActionableUser

public interface User
extends CaptainUpObject

The player resource provides information about an app's users. Users share basic information and details such as the user name and the avatar image across all Captain Up apps, while users' progress in each app is completely independent.

Method Summary

Modifier and Type	Method and Description
java.util.List<Action>	addAction(Action action)
java.lang.String	getAccessToken() The access token can be used in other Captain Up requests to identify the user that is currently logged in to the app.
java.util.Map<java.lang.String,AcquiredAsset>	getAcquiredAssets()
java.util.Map<java.lang.String,java.lang.Integer>	getActionCounters() Information on the total number of times the user has done the app actions.
BadgeProgressMap	getBadgeProgress() All of the badges the user has any progress on, including the completed ones.
java.lang.String	getCaptainUpID()
java.util.Map<java.lang.String,java.lang.Long>	getCurrencies()
long	getDailyPoints()
java.lang.String	getID()
java.lang.String	getImageURL()
java.util.Map<LeaderboardTime,java.lang.Long>	getLeaderboardPositions() The user's position in all the leaderboards
Level	getLevel()
java.lang.String	getLevelID()
long	getMonthlyPoints()
java.lang.String	getName()
Level	getNextLevel()
java.util.List<Action>	getPrivateActivities()
java.util.List<Action>	getPublicActivities()
int	getTotalActionCount()
java.util.List<java.lang.String>	getUnavailableSegmentedBadgesIDs()
long	getWeeklyPoints()
void	setApplication(Application app)

Method Detail

getID

java.lang.String getID()

getCaptainUpID

java.lang.String getCaptainUpID()

getAccessToken

java.lang.String getAccessToken()

The access token can be used in other Captain Up requests to identify the user that is currently logged in to the app. For example, this will grant permissions to see the user's private activities or to post actions for the user. The access token will be empty if the app enabled the "Secure User Integration" option and the requested user data was not signed (see IntegrationUserBuilder.setSignature(String).

Returns:

the user's access token string.

getName

java.lang.String getName()

getImageURL

java.lang.String getImageURL()

getMonthlyPoints

long getMonthlyPoints()

getWeeklyPoints

long getWeeklyPoints()

getDailyPoints

long getDailyPoints()

getLeaderboardPositions

java.util.Map<LeaderboardTime,java.lang.Long> getLeaderboardPositions()

The user's position in all the leaderboards

Returns:

a map between the type of leaderboard and the the user's position.

getPrivateActivities

java.util.List<Action> getPrivateActivities()

getPublicActivities

java.util.List<Action> getPublicActivities()

getBadgeProgress

BadgeProgressMap getBadgeProgress()

All of the badges the user has any progress on, including the completed ones.

Returns:

a map where the keys are the IDs (String) of the badges and the the values are the badge's progress information.

getTotalActionCount

int getTotalActionCount()

getActionCounters

java.util.Map<java.lang.String,java.lang.Integer> getActionCounters()

Information on the total number of times the user has done the app actions. The keys here are based on your app action identifiers.

Returns:

A map between the action name and its counter (never null).

getLevelID

java.lang.String getLevelID()

getLevel

Level getLevel()

getNextLevel

Level getNextLevel()

addAction

java.util.List<Action> addAction(Action action)

getCurrencies

java.util.Map<java.lang.String,java.lang.Long> getCurrencies()

getAcquiredAssets

java.util.Map<java.lang.String,AcquiredAsset> getAcquiredAssets()

getUnavailableSegmentedBadgesIDs

java.util.List<java.lang.String> getUnavailableSegmentedBadgesIDs()

setApplication

void setApplication(Application app)