com.captainup.android.core.model

Interface Badge

All Superinterfaces:

CaptainUpObject

public interface Badge
extends CaptainUpObject

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Condition>	getConditions() List of all the badge conditions for achievement
java.util.Map<java.lang.String,java.lang.Long>	getCurrencies() Get the currencies awarded when achieving this badge.
java.util.Map<java.lang.String,java.lang.Object>	getCustomData() The badge custom data
java.lang.String	getDescription() The badge description
java.lang.String	getID() The badge ID
ImageFiles	getImageFiles() Details on the badge's image files
java.lang.String	getName() The name of the badge
long	getPoints() The number of points that will be awarded to the user for achieving this badge
Reward	getReward() The Badge Reward Object
java.util.Collection<Reward>	getRewards() The Badge Rewards Array
int	getWeight() The badge weight affect the weight given to each badge when we sort, display and recommend the badges to users.
boolean	hasReward() Does the badge has a reward object that is safe to sue
boolean	isHidden() Whether the badge is "hidden".
boolean	isRepeatable() A repeatable badge is a badge that can be achieved multiple times.
boolean	isSegmented() Segmented badges can be used to filter the badge presentation according to different user attributes.
boolean	isSegmentedForUser(User user) Use this function to know if a badge should be displayed for your specific user For example: badge.isSegmentedForUser(CaptainUp.getLoggedInUser())
boolean	isVisible() A badge that is not visible will be hidden from users that have not achieved it.

Method Detail

getID

java.lang.String getID()

The badge ID

Returns:

the badge ID

getName

java.lang.String getName()

The name of the badge

Returns:

the name of the badge

getDescription

java.lang.String getDescription()

The badge description

Returns:

the badge description

isHidden

boolean isHidden()

Whether the badge is "hidden". hidden badges are to be shown as a secret badge in the UI

Returns:

true if the badge is hidden, false otherwise.

isVisible

boolean isVisible()

A badge that is not visible will be hidden from users that have not achieved it.

Returns:

true if badge is visible

getPoints

long getPoints()

The number of points that will be awarded to the user for achieving this badge

Returns:

number of points

getWeight

int getWeight()

The badge weight affect the weight given to each badge when we sort, display and recommend the badges to users. The higher the weight, the more difficult the badge is considered the be, the lower the likelihood we recommend users to complete this badge.

Returns:

the badge's weight

getCustomData

java.util.Map<java.lang.String,java.lang.Object> getCustomData()

The badge custom data

Returns:

a map (key-value) of the badge custom data

getImageFiles

ImageFiles getImageFiles()

Details on the badge's image files

Returns:

the details of the badge's image files

getConditions

java.util.Collection<Condition> getConditions()

List of all the badge conditions for achievement

Returns:

a collection of Condition

getRewards

java.util.Collection<Reward> getRewards()

The Badge Rewards Array

Returns:

a Collection Array or Null if there is no reward for this badge

getReward

Reward getReward()

The Badge Reward Object

Returns:

a Object or Null if there is no reward for this badge

hasReward

boolean hasReward()

Does the badge has a reward object that is safe to sue

Returns:

a true if the badge has a reward object or false if reward object is null

isRepeatable

boolean isRepeatable()

A repeatable badge is a badge that can be achieved multiple times. you can check inside a player's badge progress to know how many times he achieved a badge For example: CaptainUp.getLoggedInUser().getBadgeProgress().get(badge.getID()).getTimesCompleted()

Returns:

true if a badge is repeatable, false otherwise.

getCurrencies

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

Get the currencies awarded when achieving this badge. For example: badge.getCurrencies().get("points") will return the amount of points awarded when completing the badge's conditions

Returns:

A map where key is the currency name and value is the awarded currency amount

isSegmented

boolean isSegmented()

Segmented badges can be used to filter the badge presentation according to different user attributes. For example - you can add a "market" filter so only users in this specific market can see the badge. If a badge is segmented, you can check if it is restricted for the current user by checking his unavailable segmented badges list (User.getUnavailableSegmentedBadgesIDs() - A badge that is both segmented and appears in the user restricted segmented badges list should not be shown to that user.

Returns:

true if badge is segmented, false otherwise.

isSegmentedForUser

boolean isSegmentedForUser(User user)

Use this function to know if a badge should be displayed for your specific user For example: badge.isSegmentedForUser(CaptainUp.getLoggedInUser())

Parameters:

user -

Returns:

true if the badge is segmented to the provided user, false otherwise.