com.google.appinventor.components.runtime.util

Class GameInstance

java.lang.Object

com.google.appinventor.components.runtime.util.GameInstance

public class GameInstance
extends java.lang.Object

A container for information about a GameInstance for use with the App Inventor game framework.

Constructor Summary

Constructors

Constructor and Description
GameInstance(java.lang.String instanceId) A GameInstance contains the most recent values for the leader and players of a particular game instance.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInstanceId() Return the instance id of this instance.
java.lang.String	getLeader() Return the current leader of this instance.
java.lang.String	getMessageTime(java.lang.String type) Return the most recently put time string for this type.
java.util.List<java.lang.String>	getPlayers() Return the list of players currently in this instance.
void	putMessageTime(java.lang.String type, java.lang.String time) Puts a new time string for the specified message type.
void	setLeader(java.lang.String leader) Sets the leader of this instance.
PlayerListDelta	setPlayers(java.util.List<java.lang.String> newPlayersList) Sets the players of this instances to currentPlayersList.

Methods inherited from class java.lang.Object

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

Constructor Detail

GameInstance

public GameInstance(java.lang.String instanceId)

A GameInstance contains the most recent values for the leader and players of a particular game instance. This object is also used to keep track of the most recent time that a particular message type was retrieved from the server.

Parameters:

instanceId - The unique String that identifies this instance.

Method Detail

getInstanceId

public java.lang.String getInstanceId()

Return the instance id of this instance.

Returns:

the instance id.

getLeader

public java.lang.String getLeader()

Return the current leader of this instance.

Returns:

The email address of the current leader.

setLeader

public void setLeader(java.lang.String leader)

Sets the leader of this instance.

Parameters:

leader - The email address of the new leader.

setPlayers

public PlayerListDelta setPlayers(java.util.List<java.lang.String> newPlayersList)

Sets the players of this instances to currentPlayersList. Compares the current players list with the new one and returns a delta to the caller.

Parameters:

newPlayersList - All players currently in the instance.

Returns:

PlayersListDelta.NO_CHANGE if there is no change in membership. Otherwise returns a PlayersListDelta with the appropriate player lists.

getPlayers

public java.util.List<java.lang.String> getPlayers()

Return the list of players currently in this instance.

Returns:

A list of the players in the instance.

getMessageTime

public java.lang.String getMessageTime(java.lang.String type)

Return the most recently put time string for this type. This should represent the creation time of the most recently received message of the specified type and can be used to filter available messages to find those that have not been received.

Parameters:

type - The message type.

Returns:

The most recently put value for this type.

putMessageTime

public void putMessageTime(java.lang.String type,
                  java.lang.String time)

Puts a new time string for the specified message type. The string should be some value that can be understood by its eventual consumer. It is left as a string here to remove the need to convert back and forth from DateTime objects when dealing with web services.

Parameters:

type - The message type.

time - A string representing the time the message was created.