com.google.api.services.games.model

Class AchievementDefinition

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.games.model.AchievementDefinition

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class AchievementDefinition
extends com.google.api.client.json.GenericJson

This is a JSON template for an achievement definition object.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Game Services API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AchievementDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
AchievementDefinition	clone()
java.lang.String	getAchievementType() The type of the achievement.
java.lang.String	getDescription() The description of the achievement.
java.lang.Long	getExperiencePoints() Experience points which will be earned when unlocking this achievement.
java.lang.String	getFormattedTotalSteps() The total steps for an incremental achievement as a string.
java.lang.String	getId() The ID of the achievement.
java.lang.String	getInitialState() The initial state of the achievement.
java.lang.Boolean	getIsRevealedIconUrlDefault() Indicates whether the revealed icon image being returned is a default image, or is provided by the game.
java.lang.Boolean	getIsUnlockedIconUrlDefault() Indicates whether the unlocked icon image being returned is a default image, or is game- provided.
java.lang.String	getKind() Uniquely identifies the type of this resource.
java.lang.String	getName() The name of the achievement.
java.lang.String	getRevealedIconUrl() The image URL for the revealed achievement icon.
java.lang.Integer	getTotalSteps() The total steps for an incremental achievement.
java.lang.String	getUnlockedIconUrl() The image URL for the unlocked achievement icon.
AchievementDefinition	set(java.lang.String fieldName, java.lang.Object value)
AchievementDefinition	setAchievementType(java.lang.String achievementType) The type of the achievement.
AchievementDefinition	setDescription(java.lang.String description) The description of the achievement.
AchievementDefinition	setExperiencePoints(java.lang.Long experiencePoints) Experience points which will be earned when unlocking this achievement.
AchievementDefinition	setFormattedTotalSteps(java.lang.String formattedTotalSteps) The total steps for an incremental achievement as a string.
AchievementDefinition	setId(java.lang.String id) The ID of the achievement.
AchievementDefinition	setInitialState(java.lang.String initialState) The initial state of the achievement.
AchievementDefinition	setIsRevealedIconUrlDefault(java.lang.Boolean isRevealedIconUrlDefault) Indicates whether the revealed icon image being returned is a default image, or is provided by the game.
AchievementDefinition	setIsUnlockedIconUrlDefault(java.lang.Boolean isUnlockedIconUrlDefault) Indicates whether the unlocked icon image being returned is a default image, or is game- provided.
AchievementDefinition	setKind(java.lang.String kind) Uniquely identifies the type of this resource.
AchievementDefinition	setName(java.lang.String name) The name of the achievement.
AchievementDefinition	setRevealedIconUrl(java.lang.String revealedIconUrl) The image URL for the revealed achievement icon.
AchievementDefinition	setTotalSteps(java.lang.Integer totalSteps) The total steps for an incremental achievement.
AchievementDefinition	setUnlockedIconUrl(java.lang.String unlockedIconUrl) The image URL for the unlocked achievement icon.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AchievementDefinition

public AchievementDefinition()

Method Detail

getAchievementType

public java.lang.String getAchievementType()

The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental.

Returns:

value or null for none

setAchievementType

public AchievementDefinition setAchievementType(java.lang.String achievementType)

The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental.

Parameters:

achievementType - achievementType or null for none

getDescription

public java.lang.String getDescription()

The description of the achievement.

Returns:

value or null for none

setDescription

public AchievementDefinition setDescription(java.lang.String description)

The description of the achievement.

Parameters:

description - description or null for none

getExperiencePoints

public java.lang.Long getExperiencePoints()

Experience points which will be earned when unlocking this achievement.

Returns:

value or null for none

setExperiencePoints

public AchievementDefinition setExperiencePoints(java.lang.Long experiencePoints)

Experience points which will be earned when unlocking this achievement.

Parameters:

experiencePoints - experiencePoints or null for none

getFormattedTotalSteps

public java.lang.String getFormattedTotalSteps()

The total steps for an incremental achievement as a string.

Returns:

value or null for none

setFormattedTotalSteps

public AchievementDefinition setFormattedTotalSteps(java.lang.String formattedTotalSteps)

The total steps for an incremental achievement as a string.

Parameters:

formattedTotalSteps - formattedTotalSteps or null for none

getId

public java.lang.String getId()

The ID of the achievement.

Returns:

value or null for none

setId

public AchievementDefinition setId(java.lang.String id)

The ID of the achievement.

Parameters:

id - id or null for none

getInitialState

public java.lang.String getInitialState()

The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked.

Returns:

value or null for none

setInitialState

public AchievementDefinition setInitialState(java.lang.String initialState)

The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked.

Parameters:

initialState - initialState or null for none

getIsRevealedIconUrlDefault

public java.lang.Boolean getIsRevealedIconUrlDefault()

Indicates whether the revealed icon image being returned is a default image, or is provided by the game.

Returns:

value or null for none

setIsRevealedIconUrlDefault

public AchievementDefinition setIsRevealedIconUrlDefault(java.lang.Boolean isRevealedIconUrlDefault)

Indicates whether the revealed icon image being returned is a default image, or is provided by the game.

Parameters:

isRevealedIconUrlDefault - isRevealedIconUrlDefault or null for none

getIsUnlockedIconUrlDefault

public java.lang.Boolean getIsUnlockedIconUrlDefault()

Indicates whether the unlocked icon image being returned is a default image, or is game- provided.

Returns:

value or null for none

setIsUnlockedIconUrlDefault

public AchievementDefinition setIsUnlockedIconUrlDefault(java.lang.Boolean isUnlockedIconUrlDefault)

Indicates whether the unlocked icon image being returned is a default image, or is game- provided.

Parameters:

isUnlockedIconUrlDefault - isUnlockedIconUrlDefault or null for none

getKind

public java.lang.String getKind()

Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinition.

Returns:

value or null for none

setKind

public AchievementDefinition setKind(java.lang.String kind)

Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinition.

Parameters:

kind - kind or null for none

getName

public java.lang.String getName()

The name of the achievement.

Returns:

value or null for none

setName

public AchievementDefinition setName(java.lang.String name)

The name of the achievement.

Parameters:

name - name or null for none

getRevealedIconUrl

public java.lang.String getRevealedIconUrl()

The image URL for the revealed achievement icon.

Returns:

value or null for none

setRevealedIconUrl

public AchievementDefinition setRevealedIconUrl(java.lang.String revealedIconUrl)

The image URL for the revealed achievement icon.

Parameters:

revealedIconUrl - revealedIconUrl or null for none

getTotalSteps

public java.lang.Integer getTotalSteps()

The total steps for an incremental achievement.

Returns:

value or null for none

setTotalSteps

public AchievementDefinition setTotalSteps(java.lang.Integer totalSteps)

The total steps for an incremental achievement.

Parameters:

totalSteps - totalSteps or null for none

getUnlockedIconUrl

public java.lang.String getUnlockedIconUrl()

The image URL for the unlocked achievement icon.

Returns:

value or null for none

setUnlockedIconUrl

public AchievementDefinition setUnlockedIconUrl(java.lang.String unlockedIconUrl)

The image URL for the unlocked achievement icon.

Parameters:

unlockedIconUrl - unlockedIconUrl or null for none

set

public AchievementDefinition set(java.lang.String fieldName,
                        java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AchievementDefinition clone()

Overrides:

clone in class com.google.api.client.json.GenericJson