com.captainup.android.core.model

Interface Application

All Superinterfaces:

CaptainUpObject

public interface Application
extends CaptainUpObject

An app holds the information about the Captain Up experience in your site or app. The app resource holds all the settings and configurations related to your app, including information about the app's actions and levels

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,ActionSettings>	getActionSettings() The app's action's settings.
java.lang.String	getApplicationURL() The URL of the application.
java.util.Map<java.lang.String,Asset>	getAssets() A map of all the application assets by their Asset Type ID.
java.util.Map<java.lang.String,Asset>	getAssetsByType(AssetType type) Get only Assets of a specific type (TROPHY, SHOP_ITEM or GIFT)
java.util.Map<java.lang.String,Badge>	getBadges() A map of all the application badges by their Badge ID.
GameCenter	getGameCenterDetails() The details of the app's game center display (like the title and text).
java.lang.String	getID() The ID of the app.
java.util.List<Level>	getLevels() List of the app's levels
java.lang.String	getLogoURL() The URL to your app's logo.
java.lang.String	getName() The name of the app.
java.util.Map<java.lang.String,RewardType>	getRewardTypes() A map of all the application reward types by their Reward Type ID.
SignUpMessage	getSignUpMessage() The details of the sign up message for the app.
Theme	getTheme() The details of the theme defined for the app.

Method Detail

getID

java.lang.String getID()

The ID of the app.

Returns:

the ID of the app.

getLogoURL

java.lang.String getLogoURL()

The URL to your app's logo. Will default to a community logo.

Returns:

the URL to the app's logo.

getName

java.lang.String getName()

The name of the app.

Returns:

the name of the app.

getApplicationURL

java.lang.String getApplicationURL()

The URL of the application.

Returns:

the URL of the application.

getGameCenterDetails

GameCenter getGameCenterDetails()

The details of the app's game center display (like the title and text).

Returns:

the app's game center's details.

getTheme

Theme getTheme()

The details of the theme defined for the app.

Returns:

the app's theme.

getSignUpMessage

SignUpMessage getSignUpMessage()

The details of the sign up message for the app.

Returns:

the app's sign up message object.

getBadges

java.util.Map<java.lang.String,Badge> getBadges()

A map of all the application badges by their Badge ID.

Returns:

a map of all the application badges by their Badge ID.

getActionSettings

java.util.Map<java.lang.String,ActionSettings> getActionSettings()

The app's action's settings.

Returns:

the app's action's settings as map between their name (which is the same as Action.getName()) and their details.

getLevels

java.util.List<Level> getLevels()

List of the app's levels

Returns:

list of the app's levels

getRewardTypes

java.util.Map<java.lang.String,RewardType> getRewardTypes()

A map of all the application reward types by their Reward Type ID.

Returns:

a map of all the application reward types by their RewardType ID.

getAssets

java.util.Map<java.lang.String,Asset> getAssets()

A map of all the application assets by their Asset Type ID.

Returns:

a map of all the application assets types by their Asset ID.

getAssetsByType

java.util.Map<java.lang.String,Asset> getAssetsByType(AssetType type)

Get only Assets of a specific type (TROPHY, SHOP_ITEM or GIFT)

Parameters:

type - can be either AssetType.TROPHY, AssetType.SHOP_ITEM, AssetType.GIFT

Returns:

a map of the selected asset type, where key is the asset ID and value is the Asset object.