com.google.android.gms.games.quest.Quest |
![]() |
Data interface for retrieving quest information.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | STATE_ACCEPTED | Constant returned by getState() indicating the player has accepted the quest. |
|||||||||
int | STATE_COMPLETED | Constant returned by getState() indicating the player has completed the quest. |
|||||||||
int | STATE_EXPIRED | Constant returned by getState() indicating the quest is over and this player
never accepted the quest. |
|||||||||
int | STATE_FAILED | Constant returned by getState() indicating the quest is over and this player
did not complete the quest. |
|||||||||
int | STATE_OPEN | Constant returned by getState() indicating players can now accept this quest. |
|||||||||
int | STATE_UPCOMING | Constant returned by getState() indicating the quest happens in the future,
so it is visible to the UI, but players can't accept it yet. |
|||||||||
long | UNSET_QUEST_TIMESTAMP | The default value for Quest related timestamps when they aren't set by the server. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
QUEST_STATE_ALL | Array of all the valid state constants. | ||||||||||
QUEST_STATE_NON_TERMINAL |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Retrieves the timestamp (in milliseconds since epoch) at which this quest was accepted
by the player.
| |||||||||||
Retrieves a URI that can be used to load the quest's banner image.
| |||||||||||
Retrieves the latest milestone information associated with this quest.
| |||||||||||
Retrieves the description for this quest.
| |||||||||||
Loads the quest description into the given
CharArrayBuffer . | |||||||||||
Timestamp at which this quest will change to STATE_EXPIRED if not accepted,
or change to STATE_FAILED if accepted but not completed.
| |||||||||||
Retrieves the game metadata associated with this quest.
| |||||||||||
Retrieves a URI that can be used to load the quest's icon image.
| |||||||||||
Retrieves the timestamp (in milliseconds since epoch) at which this quest was last
updated.
| |||||||||||
Loads the quest name into the given
CharArrayBuffer . | |||||||||||
Retrieves the name of this quest.
| |||||||||||
Retrieves the ID of this quest.
| |||||||||||
Retrieves the timestamp (in milliseconds since epoch) at which this quest will be available
for players to accept.
| |||||||||||
Retrieves the state of the quest - one of
STATE_UPCOMING ,
STATE_OPEN , STATE_COMPLETED , STATE_EXPIRED ,
STATE_FAILED , STATE_ACCEPTED . | |||||||||||
Indicates whether the quest will be expiring soon
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Constant returned by getState()
indicating the player has accepted the quest.
Constant returned by getState()
indicating the player has completed the quest.
Constant returned by getState()
indicating the quest is over and this player
never accepted the quest.
Constant returned by getState()
indicating the quest is over and this player
did not complete the quest.
Constant returned by getState()
indicating players can now accept this quest.
Constant returned by getState()
indicating the quest happens in the future,
so it is visible to the UI, but players can't accept it yet.
The default value for Quest related timestamps when they aren't set by the server.
Array of all the valid state constants.
Retrieves the timestamp (in milliseconds since epoch) at which this quest was accepted
by the player. If the quest has never been accepted, this will return
UNSET_QUEST_TIMESTAMP
. If you are looking for the time that a quest is available
to be accepted, see getStartTimestamp()
. This value should always be greater
than getStartTimestamp()
and less than getEndTimestamp()
Returns | |
---|---|
long |
Timestamp at which this quest was accepted. |
Retrieves a URI that can be used to load the quest's banner image. Returns null if the quest has no banner image.
To retrieve the Image from theUri
, use
ImageManager
.
Returns | |
---|---|
Uri |
The image URI for the quest's banner image, or null if the quest has no banner image. |
Retrieves the latest milestone information associated with this quest.
Returns | |
---|---|
Milestone |
The latest milestone associated with this quest. |
Retrieves the description for this quest.
Returns | |
---|---|
String |
The quest description. |
Loads the quest description into the given CharArrayBuffer
.
Parameters | |
---|---|
dataOut |
CharArrayBuffer :
The buffer to load the data into.
|
Timestamp at which this quest will change to STATE_EXPIRED if not accepted, or change to STATE_FAILED if accepted but not completed.
Returns | |
---|---|
long |
Timestamp at which this quest will end. |
Retrieves the game metadata associated with this quest.
Returns | |
---|---|
Game |
The game associated with the quest. |
Retrieves a URI that can be used to load the quest's icon image. Returns null if the quest has no icon image.
To retrieve the Image from theUri
, use
ImageManager
.
Returns | |
---|---|
Uri |
The image URI for the quest's icon image, or null if the quest has no icon image. |
Retrieves the timestamp (in milliseconds since epoch) at which this quest was last
updated. If the quest has never been updated, this will return
UNSET_QUEST_TIMESTAMP
.
Returns | |
---|---|
long |
Timestamp at which this quest was last updated. |
Loads the quest name into the given CharArrayBuffer
.
Parameters | |
---|---|
dataOut |
CharArrayBuffer :
The buffer to load the data into.
|
Retrieves the name of this quest.
Returns | |
---|---|
String |
The quest name. |
Retrieves the ID of this quest.
Returns | |
---|---|
String |
The quest ID. |
Retrieves the timestamp (in milliseconds since epoch) at which this quest will be available
for players to accept. If you are looking for the time that a quest was accepted by the
player, see getAcceptedTimestamp()
Returns | |
---|---|
long |
Timestamp at which this quest will begin. |
Retrieves the state of the quest - one of STATE_UPCOMING
,
STATE_OPEN
, STATE_COMPLETED
, STATE_EXPIRED
,
STATE_FAILED
, STATE_ACCEPTED
.
Returns | |
---|---|
int |
The state of this quest. |
Indicates whether the quest will be expiring soon
Returns | |
---|---|
boolean |
Is the quest expiring soon. |