com.google.api.services.games

Class Games.Achievements

java.lang.Object

com.google.api.services.games.Games.Achievements

Enclosing class:

Games

public class Games.Achievements
extends Object

The "achievements" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Games.Achievements.Increment
class	Games.Achievements.List
class	Games.Achievements.Reveal
class	Games.Achievements.SetStepsAtLeast
class	Games.Achievements.Unlock
class	Games.Achievements.UpdateMultiple

Constructor Summary

Constructors

Constructor and Description
Achievements()

Method Summary

Modifier and Type	Method and Description
Games.Achievements.Increment	increment(String achievementId, Integer stepsToIncrement) Increments the steps of the achievement with the given ID for the currently authenticated player.
Games.Achievements.List	list(String playerId) Lists the progress for all your application's achievements for the currently authenticated player.
Games.Achievements.Reveal	reveal(String achievementId) Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player.
Games.Achievements.SetStepsAtLeast	setStepsAtLeast(String achievementId, Integer steps) Sets the steps for the currently authenticated player towards unlocking an achievement.
Games.Achievements.Unlock	unlock(String achievementId) Unlocks this achievement for the currently authenticated player.
Games.Achievements.UpdateMultiple	updateMultiple(AchievementUpdateMultipleRequest content) Updates multiple achievements for the currently authenticated player.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Achievements

public Achievements()

Method Detail

increment

public Games.Achievements.Increment increment(String achievementId,
                                              Integer stepsToIncrement)
                                       throws IOException

Increments the steps of the achievement with the given ID for the currently authenticated player. Create a request for the method "achievements.increment". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

achievementId - The ID of the achievement used by this method.

stepsToIncrement - Required. The number of steps to increment.

Returns:

the request

Throws:

IOException

list

public Games.Achievements.List list(String playerId)
                             throws IOException

Lists the progress for all your application's achievements for the currently authenticated player. Create a request for the method "achievements.list". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

playerId - A player ID. A value of `me` may be used in place of the authenticated player's ID.

Returns:

the request

Throws:

IOException

reveal

public Games.Achievements.Reveal reveal(String achievementId)
                                 throws IOException

Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player. Create a request for the method "achievements.reveal". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

achievementId - The ID of the achievement used by this method.

Returns:

the request

Throws:

IOException

setStepsAtLeast

public Games.Achievements.SetStepsAtLeast setStepsAtLeast(String achievementId,
                                                          Integer steps)
                                                   throws IOException

Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified. Create a request for the method "achievements.setStepsAtLeast". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

achievementId - The ID of the achievement used by this method.

steps - Required. The minimum value to set the steps to.

Returns:

the request

Throws:

IOException

unlock

public Games.Achievements.Unlock unlock(String achievementId)
                                 throws IOException

Unlocks this achievement for the currently authenticated player. Create a request for the method "achievements.unlock". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

achievementId - The ID of the achievement used by this method.

Returns:

the request

Throws:

IOException

updateMultiple

public Games.Achievements.UpdateMultiple updateMultiple(AchievementUpdateMultipleRequest content)
                                                 throws IOException

Updates multiple achievements for the currently authenticated player. Create a request for the method "achievements.updateMultiple". This request holds the parameters needed by the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the AchievementUpdateMultipleRequest

Returns:

the request

Throws:

IOException