com.captainup.android.core.model

Interface ActionSettings

All Superinterfaces:

CaptainUpObject

public interface ActionSettings
extends CaptainUpObject

Method Summary

Modifier and Type	Method and Description
java.util.List<ActionableEntitySchema>	getEntitySchemas()
java.lang.String	getID() The ID of the Action Setting
java.lang.String	getImageURL() The URL to the action's image.
java.lang.String	getName() The name of the action.
java.lang.String	getPastTense() The past tense of the action
long	getPoints() The number of points that will be awarded to the user for doing the action.
long	getPointsInterval() The points interval.
java.lang.String	getPresentProgressiveTense() The present progressive tense of the action.
boolean	hasLeaderboard() Whether to show a leaderboard for this action.
boolean	showActivity() Whether to show an activity for this action.
boolean	showNotification() Whether to show a notification for this action or not.

Method Detail

getID

java.lang.String getID()

The ID of the Action Setting

Returns:

the ID of the Action Setting

getName

java.lang.String getName()

The name of the action.

Returns:

the name of the action.

getPoints

long getPoints()

The number of points that will be awarded to the user for doing the action.

Returns:

the points awarded for doing the action

getPointsInterval

long getPointsInterval()

The points interval.

Returns:

the points interval.

hasLeaderboard

boolean hasLeaderboard()

Whether to show a leaderboard for this action.

Returns:

true when the action has a leaderboard, false otherwise

showActivity

boolean showActivity()

Whether to show an activity for this action.

Returns:

true when the action will show in a player's activity log, false otherwise.

showNotification

boolean showNotification()

Whether to show a notification for this action or not.

Returns:

true if the action will also generate a notification, false otherwise.

getPastTense

java.lang.String getPastTense()

The past tense of the action

Returns:

the past tense of the action

getPresentProgressiveTense

java.lang.String getPresentProgressiveTense()

The present progressive tense of the action.

Returns:

the present progressive tense of the action.

getImageURL

java.lang.String getImageURL()

The URL to the action's image.

Returns:

a URL referring to the action's image.

getEntitySchemas

java.util.List<ActionableEntitySchema> getEntitySchemas()