Edit

Share via


Achievement Class

Definition

Represents an achievement, a system-wide mechanism for directing and rewarding users' in-game actions consistently across all games.

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Version(1)]
public sealed class Achievement
type Achievement = class
    interface __IAchievementPublicNonVirtuals
Public NotInheritable Class Achievement
Inheritance
Achievement
Attributes
Windows.Foundation.Metadata.MarshalingBehaviorAttribute Windows.Foundation.Metadata.ThreadingAttribute Windows.Foundation.Metadata.VersionAttribute

Properties

AchievementType

The type of achievement, such as a challenge achievement.

Available

The time window during which the achievement is available. Applies to Challenges.

DeepLink

A deeplink for clients that enables the title to launch at a desired starting point for the achievement.

EstimatedUnlockTime

The estimated time that the achievement takes to be earned.

Id

The achievement ID. Can be a uint or a guid.

IsRevoked

A value that indicates whether or not the achievement is revoked by enforcement.

IsSecret

Whether or not the achievement is secret.

LockedDescription

The description of the locked achievement.

MediaAssets

The media assets associated with the achievement, such as image IDs.

Name

The localized achievement name.

ParticipationType

The participation type for the achievement, such as group or individual.

PlatformsAvailableOn

The collection of platforms that the achievement is available on.

ProductId

The ProductId the achievement was released with. This is a globally unique identifier that may correspond to an application, downloadable content, etc.

Progression

The progression object containing progress details about the achievement, including requirements.

ProgressState

The state of a user's progress towards the earning of the achievement.

Rewards

The collection of rewards that the player earns when the achievement is unlocked.

ServiceConfigurationId

The ID of the service configuration set associated with the achievement.

TitleAssociations

The game/app titles associated with the achievement.

UnlockedDescription

The description of the unlocked achievement.

Applies to