com.captainup.android.core.model

Interface BadgeProgress

All Superinterfaces:

CaptainUpObject

All Known Implementing Classes:

BadgeProgressImpl

public interface BadgeProgress
extends CaptainUpObject

Method Summary

Modifier and Type	Method and Description
int	getCompletedConditionsCount() The number of conditions completed
java.util.Date	getCompletedDate() The latest date the badge was completed on.
java.util.Map<java.lang.String,ConditionProgress>	getConditionsProgress() The badge's conditions progress
double	getProgress() The user’s badge progress, as a number between 0 and 1.
java.util.Map<java.lang.String,RewardProgress>	getRewardProgress() Map of the badge rewards (key: reward ID, value: RewardProgress obejct) When you want to know if a reward has already been claimed (therefor there's no need to show a 'claim!' dialog to the user, for example) you can get the rewardsProgress Map from the badgeProgress object and use the .isClaimed() function.
int	getTimesCompleted() The number of times the user has completed this badge.

Method Detail

getProgress

double getProgress()

The user’s badge progress, as a number between 0 and 1. Completed badges will have `1` as their progress, badges with no progress will have `0` as their progress. For example, if the user visited one time, out of a total of four required visits, then the progress will be set to 0.25.

Returns:

the badge progress as a number between 0.0 (inclusive) and 1.0 (inclusive)

getCompletedConditionsCount

int getCompletedConditionsCount()

The number of conditions completed

Returns:

the number of conditions completed

getConditionsProgress

java.util.Map<java.lang.String,ConditionProgress> getConditionsProgress()

The badge's conditions progress

Returns:

a Map between a condition ID and its progress.

getTimesCompleted

int getTimesCompleted()

The number of times the user has completed this badge.

• If 0, then the user did not completed the badge
• If 1, then the user completed the badge exactly once
• If 1, this is repeatable badge, and the user had completed it multiple times

Returns:

a non-negative value representing the number of times the badge was completed.

getRewardProgress

java.util.Map<java.lang.String,RewardProgress> getRewardProgress()

Map of the badge rewards (key: reward ID, value: RewardProgress obejct) When you want to know if a reward has already been claimed (therefor there's no need to show a 'claim!' dialog to the user, for example) you can get the rewardsProgress Map from the badgeProgress object and use the .isClaimed() function. A usage example to check if a badge reward is claimed: RewardProgress rewardProgress = CaptainUp.getLoggedInUser().getBadgeProgress().get(badge.getID()).getRewardProgress().get(badge.getReward().getID()); rewardProgress.isClaimed()

Returns:

the badge rewards progress map

getCompletedDate

java.util.Date getCompletedDate()

The latest date the badge was completed on.

Returns:

the latest date the badge was completed on. May be equal to null, depending on the source of the information. Specifically, information that is derived from a Create Action Response, might not contain the completion date for a completed badge. To check if a badge was completed or not see getTimesCompleted()