Summary: Constants | Inherited Constants | Methods | Inherited Methods | [Expand All]
public interface

# Milestone

implements Freezable<Milestone> Parcelable

com.google.android.gms.games.quest.Milestone

Known Indirect Subclasses MilestoneEntity
MilestoneEntity | Data object representing the data for a milestone.

## Class Overview

Data interface for retrieving milestone information.

## Summary

Constants
int | STATE_CLAIMED | Constant returned by server indicating the milestone was successfully claimed.
int | STATE_COMPLETED_NOT_CLAIMED | Constant returned by server indicating the milestone has not been claimed yet.
int | STATE_NOT_COMPLETED | Constant returned by server indicating the player has not completed the milestone.
int | STATE_NOT_STARTED | Constant returned by server when the milestone has not been started.

[Expand] Inherited Constants
From interface android.os.Parcelable
int | CONTENTS_FILE_DESCRIPTOR |
int | PARCELABLE_WRITE_RETURN_VALUE |

Public Methods
abstract byte[] | getCompletionRewardData() Retrieves the completion reward data for this milestone.
abstract long | getCurrentProgress() Retrieves the current progress of `getTargetProgress()` required to complete the milestone.
abstract String | getEventId() Retrieve the ID of the associated event.
abstract String | getMilestoneId() Retrieves the ID of this milestone.
abstract int | getState() Retrieves the state of the milestone - one of `STATE_COMPLETED_NOT_CLAIMED`, `STATE_CLAIMED`, `STATE_NOT_COMPLETED`, or `STATE_NOT_STARTED`.
abstract long | getTargetProgress() Retrieves the number of increments of the event associated with the milestone `getEventId()` required to complete the milestone.

[Expand] Inherited Methods
From interface com.google.android.gms.common.data.Freezable
abstract Milestone | freeze() Freeze a volatile representation into an immutable representation.
abstract boolean | isDataValid() Check to see if this object is valid for use.
From interface android.os.Parcelable
abstract int | describeContents()
abstract void | writeToParcel(Parcel arg0, int arg1)

## Constants

#### public static final int STATE_CLAIMED

Constant returned by server indicating the milestone was successfully claimed.

Constant Value: 4 (0x00000004)

#### public static final int STATE_COMPLETED_NOT_CLAIMED

Constant returned by server indicating the milestone has not been claimed yet.

Constant Value: 3 (0x00000003)

#### public static final int STATE_NOT_COMPLETED

Constant returned by server indicating the player has not completed the milestone.

Constant Value: 2 (0x00000002)

#### public static final int STATE_NOT_STARTED

Constant returned by server when the milestone has not been started.

Constant Value: 1 (0x00000001)

## Public Methods

#### public abstract byte[] getCompletionRewardData ()

Retrieves the completion reward data for this milestone.

##### Returns

- The completion reward data.

#### public abstract long getCurrentProgress ()

Retrieves the current progress of `getTargetProgress()` required to complete the milestone.

When the milestone state is `STATE_CLAIMED` or `STATE_COMPLETED_NOT_CLAIMED` the value of `getTargetProgress()` is returned.

When the milestone state is `STATE_NOT_COMPLETED` the return value is the number of increments to the event `getEventId()` associated with the milestone that have occurred since the quest was accepted.

When the milestone state is `STATE_NOT_STARTED` the return value is 0.

##### Returns

- An indicator of progress through the milestone.

#### public abstract String getEventId ()

Retrieve the ID of the associated event. Increments to this event will increase the user's progress toward this milestone when the milestone is in the `STATE_NOT_COMPLETED` state.

##### Returns

- The ID of the `Event` associated with this milestone.

#### public abstract String getMilestoneId ()

Retrieves the ID of this milestone.

##### Returns

- The milestone ID.

#### public abstract int getState ()

Retrieves the state of the milestone - one of `STATE_COMPLETED_NOT_CLAIMED`, `STATE_CLAIMED`, `STATE_NOT_COMPLETED`, or `STATE_NOT_STARTED`.

##### Returns

- The state of this milestone.

#### public abstract long getTargetProgress ()

Retrieves the number of increments of the event associated with the milestone `getEventId()` required to complete the milestone.

##### Returns

- The number of increments required to complete the milestone.