AchievementService.GetAchievementsForTitleIdAsync Method

Reference

Definition

Namespace:: Microsoft.Xbox.Services.Achievements

Assembly:: Microsoft.Xbox.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns an AchievementsResult object containing the first page of achievements for a player of the specified title.

public Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Achievements.AchievementsResult> GetAchievementsForTitleIdAsync (string xboxUserId, uint titleId, Microsoft.Xbox.Services.Achievements.AchievementType type, bool unlockedOnly, Microsoft.Xbox.Services.Achievements.AchievementOrderBy orderBy, uint skipItems, uint maxItems);

abstract member GetAchievementsForTitleIdAsync : string * uint32 * Microsoft.Xbox.Services.Achievements.AchievementType * bool * Microsoft.Xbox.Services.Achievements.AchievementOrderBy * uint32 * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Achievements.AchievementsResult>
override this.GetAchievementsForTitleIdAsync : string * uint32 * Microsoft.Xbox.Services.Achievements.AchievementType * bool * Microsoft.Xbox.Services.Achievements.AchievementOrderBy * uint32 * uint32 -> Windows.Foundation.IAsyncOperation<Microsoft.Xbox.Services.Achievements.AchievementsResult>

Public Function GetAchievementsForTitleIdAsync (xboxUserId As String, titleId As UInteger, type As AchievementType, unlockedOnly As Boolean, orderBy As AchievementOrderBy, skipItems As UInteger, maxItems As UInteger) As IAsyncOperation(Of AchievementsResult)

Parameters

xboxUserId: String

The Xbox User ID of the player.

titleId: UInt32

The title ID.

type: AchievementType

The achievement type to retrieve.

unlockedOnly: Boolean

Indicates whether to return unlocked achievements only.

orderBy: AchievementOrderBy

skipItems: UInt32

The number of achievements to skip.

maxItems: UInt32

The maximum number of achievements the result can contain. Pass 0 to attempt to retrieve all items.

Returns

Windows.Foundation.IAsyncOperation<AchievementsResult>

An AchievementsResult object that contains a list of Achievement objects.

Implements

Microsoft.Xbox.Services.Achievements.__IAchievementServicePublicNonVirtuals.GetAchievementsForTitleIdAsync(System.String,System.UInt32,Microsoft.Xbox.Services.Achievements.AchievementType,System.Boolean,Microsoft.Xbox.Services.Achievements.AchievementOrderBy,System.UInt32,System.UInt32)

Remarks

Returns an IAsyncOperation<TResult> object that represents the state of the asynchronous operation. Completion of the asynchronous operation is signaled by using a handler that is passed to the IAsyncOperation<TResult>.Completed property. When the asynchronous operation is complete, the result of the operation can be retrieved by using the IAsyncOperation<TResult>.GetResults method.

See AchievementsResult::GetNextAsync to page in the next set of results.

This method calls V2 GET /users/xuid({xuid})/achievements.

Applies to

Share via