com.captainup.android.core.model

Interface Asset

All Superinterfaces:

CaptainUpObject

public interface Asset
extends CaptainUpObject

An asset object, can be used as a Shop Item getType(), to track a player's progress on an asset check the corresponding AcquiredAsset object that is stored in the player object

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAcquireOn() A list of #List badges ID's that are required to achieve this asset (optional).
java.util.Date	getCreatedAt() The #Date the asset was created.
java.util.Map<java.lang.String,java.lang.Long>	getCurrencies() The currencies required to acquire this asset.
java.lang.String	getDescription() The asset description
java.lang.String	getDescriptionHtml() The asset description in html format, can be used to display dynamic links or text formats.
java.lang.String	getID() The asset ID
ImageFiles	getImageFiles() The asset images file, can be used to fetch high quality version of the asset image.
java.lang.String	getName() The Asset name
java.lang.String	getPresetImage() The asset preset image
Reward	getReward() The Asset Reward Object
java.util.Collection<Reward>	getRewards() The Asset Rewards Array
long	getStock() Asset stock, can be set in the admin panel to manage products availability in your shop.
AssetType	getType() The Asset type
java.util.Date	getUpdatedAt() The #Date the asset was updated.
int	getWeight() Asset weight, can be set in the admin panel.
boolean	hasReward() Does the asset has a reward object attached to it
java.lang.Boolean	isActive() The asset state
boolean	isUnlimitedStock() An asset can have unlimited stock, you can set up unlimited stock for an asset in the admin panel.

Method Detail

getID

java.lang.String getID()

The asset ID

Returns:

the asset ID.

isActive

java.lang.Boolean isActive()

The asset state

Returns:

true if the asset is active, false otherwise.

getType

AssetType getType()

The Asset type

Returns:

the asset type #AssetType.

getName

java.lang.String getName()

The Asset name

Returns:

the asset name.

getDescription

java.lang.String getDescription()

The asset description

Returns:

the asset description.

getPresetImage

java.lang.String getPresetImage()

The asset preset image

Returns:

the asset preset image.

getCreatedAt

java.util.Date getCreatedAt()

The #Date the asset was created.

Returns:

the the date the asset was created.

getUpdatedAt

java.util.Date getUpdatedAt()

The #Date the asset was updated.

Returns:

the the date the asset was updated.

getAcquireOn

java.util.List<java.lang.String> getAcquireOn()

A list of #List badges ID's that are required to achieve this asset (optional).

Returns:

#List of badges ID's.

getWeight

int getWeight()

Asset weight, can be set in the admin panel.

Returns:

the asset weight

getStock

long getStock()

Asset stock, can be set in the admin panel to manage products availability in your shop.

Returns:

the asset stock

isUnlimitedStock

boolean isUnlimitedStock()

An asset can have unlimited stock, you can set up unlimited stock for an asset in the admin panel.

Returns:

true if asset has unlimited stock, false otherwise

getCurrencies

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

The currencies required to acquire this asset.

Returns:

a Map where key is the currency name #String and value is currency amount #Long

getDescriptionHtml

java.lang.String getDescriptionHtml()

The asset description in html format, can be used to display dynamic links or text formats.

Returns:

the asset description.

getImageFiles

ImageFiles getImageFiles()

The asset images file, can be used to fetch high quality version of the asset image.

Returns:

the asset #ImageFiles.

getRewards

java.util.Collection<Reward> getRewards()

The Asset Rewards Array

Returns:

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

getReward

Reward getReward()

The Asset Reward Object

Returns:

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

hasReward

boolean hasReward()

Does the asset has a reward object attached to it

Returns:

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