com.captainup.android.framework

Interface ActionableUser

All Superinterfaces:

CaptainUpObject, User

public interface ActionableUser
extends User

A Captain Up User that can also perform operations on itself. Use this interface to both perform actions on the user as well as listen to any changes to the user as a result of those actions.

Method Summary

Modifier and Type	Method and Description
void	acquire(Asset asset) Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener.
void	acquire(Asset asset, CaptainUpCallback<CreateAcquireCaptainUpResponse> callback) Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener.
void	addListener(CaptainUpUserListener listener) Adds a listener to this user instance.
void	claimReward(Badge badge) Performs a claim action on a badge with reward
void	claimReward(Badge badge, CaptainUpCallback<CreateClaimCaptainUpResponse> callback) Performs an Async claim action on a badge with reward, accepts a callback This method is asynchronous.
void	claimReward(Badge badge, Reward reward) Performs a claim action on a badge with reward
void	claimReward(Badge badge, Reward reward, CaptainUpCallback<CreateClaimCaptainUpResponse> callback) Perform an Async claim action on a specific reward, accepts callback
Inbox	getInbox() Returns the user's inbox.
NotificationsQueue	getNotificationsQueue() Returns the user's notification's queue.
java.util.Map<Reward,Badge>	getUnclaimedRewards() Returns a list of rewards that are ready to be claimed (unclaimed rewards from achieved badges).
java.util.Collection<Reward>	getUnclaimedRewards(Badge badge) Giving a Badge object, returns a list of associated rewards that are ready to be claimed.
void	performAction(Action action) Creates a new action and adds it to your user.
void	removeListener(CaptainUpUserListener listener) Removes a listener from this user instance.
void	updateImageUrl(java.lang.String url)
void	updateImageUrl(java.lang.String url, CaptainUpCallback callback)
void	updateName(java.lang.String name)
void	updateName(java.lang.String name, CaptainUpCallback callback)

Methods inherited from interface com.captainup.android.core.model.User

addAction, getAccessToken, getAcquiredAssets, getActionCounters, getBadgeProgress, getCaptainUpID, getCurrencies, getDailyPoints, getID, getImageURL, getLeaderboardPositions, getLevel, getLevelID, getMonthlyPoints, getName, getNextLevel, getPrivateActivities, getPublicActivities, getTotalActionCount, getUnavailableSegmentedBadgesIDs, getWeeklyPoints, setApplication

Method Detail

addListener

void addListener(CaptainUpUserListener listener)

Adds a listener to this user instance. The type of event or events being listened to is determined by the interfaces implemented by the listener parameter. Supported events:

• Change in the user's currencies - CurrencyCaptainUpUserListener
• Change in the user's awarded badges (not for any change in a badge's progress) - BadgeCaptainUpUserListener
• Change in the user's level - LevelCaptainUpUserListener
• An error occurred during the posting of an action - ErrorCaptainUpUserListener

Parameters:

listener - any object implementing CaptainUpUserListener. The listener can implement multiple interfaces and thus will be registered to all events it supports.

removeListener

void removeListener(CaptainUpUserListener listener)

Removes a listener from this user instance.

Parameters:

listener - the listener object to be removed.

performAction

void performAction(Action action)

Creates a new action and adds it to your user. When you create new actions, several things happen:

• The user may receive points from doing this action based on the action settings.
• The user may get promoted to a new level because of the points he or she received from the action.
• The user might achieve a badges, or multiple badges.
• When one of these things happen, it will be reflected in the user's state and the corresponding event\s will be raised.

This method is asynchronous.

Parameters:

action - the action to create. The action can be obtained using ActionBuilder.

getUnclaimedRewards

java.util.Map<Reward,Badge> getUnclaimedRewards()

Returns a list of rewards that are ready to be claimed (unclaimed rewards from achieved badges). You can present these reward to the user with a 'claim' button, when user pressed 'claim' you can use `claimReward` to claim.

Returns:

map of all reward that the user can claim (where key is the reward object and value is the associated badge), or an empty Map in case no rewards are available.

getUnclaimedRewards

java.util.Collection<Reward> getUnclaimedRewards(Badge badge)

Giving a Badge object, returns a list of associated rewards that are ready to be claimed. Can be used when achieving a badge to get all the badge's associated rewards.

Parameters:

badge - Badge to check rewards in. (Must be an achieved badge)

Returns:

list of badge rewards or an empty list if no rewards are available.

claimReward

void claimReward(Badge badge)

Performs a claim action on a badge with reward

Parameters:

badge - badge with reward

claimReward

void claimReward(Badge badge,
                 CaptainUpCallback<CreateClaimCaptainUpResponse> callback)

Performs an Async claim action on a badge with reward, accepts a callback This method is asynchronous.

Parameters:

badge - with reward

callback - listener

claimReward

void claimReward(Badge badge,
                 Reward reward)

Performs a claim action on a badge with reward

Parameters:

badge - badge with reward

reward - The reward to claim

claimReward

void claimReward(Badge badge,
                 Reward reward,
                 CaptainUpCallback<CreateClaimCaptainUpResponse> callback)

Perform an Async claim action on a specific reward, accepts callback

Parameters:

badge - the badge with the reward

reward - the reward to claim

callback - listener

acquire

void acquire(Asset asset)

Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener. in some cases (for example when user does not have enough currency or stock is limited) call will return an error, you can listen to user error listener, or supply a callback

Parameters:

asset - the Asset object to acquire

acquire

void acquire(Asset asset,
             CaptainUpCallback<CreateAcquireCaptainUpResponse> callback)

Acquire an asset, you will receive the Asset object in the `AcquiredAssetCaptainUpUserListener` listener. in some cases (for example when user does not have enough currency or stock is limited) call will return an error.

Parameters:

asset - the Asset object to acquire

callback - listener

getInbox

Inbox getInbox()

Returns the user's inbox.

Returns:

ther user's inbox.

getNotificationsQueue

NotificationsQueue getNotificationsQueue()

Returns the user's notification's queue. When first logging in, the user might already have notifications pending from previous sessions. After logging in, the notification's queue is updates when there's a new badge or level awarded to the user.

Returns:

the user's notification's queue.

updateName

void updateName(java.lang.String name)

updateName

void updateName(java.lang.String name,
                CaptainUpCallback callback)

updateImageUrl

void updateImageUrl(java.lang.String url)

updateImageUrl

void updateImageUrl(java.lang.String url,
                    CaptainUpCallback callback)