Meta Developers

The Challenges API enhances social interactions in your app, which use GroupPresence.SetDestination() to create shareable links for score-based competition. Players can repeatedly challenge others, get to know them, and compete asynchronously. Challenges can be ranked by highest/lowest scores within a time period. Leaderboard-integrated apps get Challenges for free, accessible through the Scoreboards UI. Players can create and invite others to Challenges via the Challenges app.

Static Member Functions

static Request< Models.ChallengeEntryList > GetNextEntries

( Models.ChallengeEntryList list )

Retrieves the next page of challenge entries. If there is no next page, this field will be empty.

static Request< Models.ChallengeEntryList > GetPreviousEntries

( Models.ChallengeEntryList list )

Retrieves the previous page of challenge entries. If there is no previous page, this field will be empty.

static Request< Models.ChallengeList > GetNextChallenges

( Models.ChallengeList list )

Retrieves the next page of challenges. If there is no next page, this field will be empty.

static Request< Models.ChallengeList > GetPreviousChallenges

( Models.ChallengeList list )

Retrieves the previous page of challenges. If there is no previous page, this field will be empty.

static Request< Models.Challenge > Create

( string leaderboardName,

ChallengeOptions challengeOptions )

Parameters

leaderboardName

A string represents the name of the leaderboard.

challengeOptions

This indicates the options of the challenge and it can be retrieved by ChallengeOptions().

Deprecated

Use server-to-server API call instead.

static Request< Models.Challenge > DeclineInvite

( UInt64 challengeID )

If the current user has the necessary permissions, they can decline a challenge by providing the challenge ID, which can be obtained using Challenge::ID.

Parameters

challengeID

The ID of challenge that the user is going to decline. It can be retrieved by Challenge::ID.

static Request Delete

( UInt64 challengeID )

Parameters

challengeID

The uuid of the challenge.

Deprecated

Use server-to-server API call instead.

static Request< Models.Challenge > Get

( UInt64 challengeID )

Gets detailed information for a single challenge by providing the challenge ID, which can be retrieved by calling Challenge::ID.

Parameters

challengeID

The id of the challenge whose entries to return, which can be retrieved by calling Challenge::ID.

static Request< Models.ChallengeEntryList > GetEntries

( UInt64 challengeID,

int limit,

LeaderboardFilterType filter,

LeaderboardStartAt startAt )

Retrieves a list of entries for a specific challenge, with options to filter and limit the results. By providing the challengeID, you can specify which challenge's entries you want to retrieve. The limit parameter allows you to control the number of entries returned. The filter parameter enables you to refine the results to only include entries from users who are bidirectional followers. The startAt parameter allows you to define whether to center the query on the user or start at the top of the challenge.

Parameters

challengeID

The id of the challenge whose entries to return, which can be retrieved by calling Challenge::ID.

limit

Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.

filter

By using the LeaderboardFilterType, you can refine the results to only include entries from users who are bidirectional followers.

startAt

Defines whether to center the query on the user or start at the top of the challenge. If this is LeaderboardStartAt.CenteredOnViewer or LeaderboardStartAt.CenteredOnViewerOrTop, then the current user's ID will be automatically added to the query.

static Request< Models.ChallengeEntryList > GetEntriesAfterRank

( UInt64 challengeID,

int limit,

ulong afterRank )

Returns a list of entries for a specific challenge, starting from a specified rank. By providing the challengeID and rank, you can specify which challenge's entries you want to retrieve and where to start the query. The limit parameter allows you to control the number of entries returned.

Parameters

challengeID

The id of the challenge whose entries to return, which can be retrieved by calling Challenge::ID.

limit

Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.

afterRank

The position after which to start. For example, 10 returns challenge results starting with the 11th user.

static Request< Models.ChallengeEntryList > GetEntriesByIds

( UInt64 challengeID,

int limit,

LeaderboardStartAt startAt,

UInt64 [] userIDs )

Retrieves a list of challenge entries for a specific set of user IDs, with options to filter and limit the results. This method is useful for retrieving a list of challenge entries for a specific set of users, allowing you to display their progress and rankings within the challenge.

Parameters

challengeID

The id of the challenge whose entries to return, which can be retrieved by calling Challenge::ID.

limit

Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.

startAt

userIDs

Defines a list of user ids to get entries for.

static Request< Models.ChallengeList > GetList

( ChallengeOptions challengeOptions,

int limit )

Returns a list of challenges that match the specified options. The ChallengeOptions() parameter allows you to specify the criteria for the challenges you want to retrieve. The limit parameter allows you to control the number of challenges returned.

Parameters

challengeOptions

This indicates the options of the challenge and it can be retrieved by ChallengeOptions().

limit

Sets a limit on the maximum number of challenges to be fetched, which can be useful for pagination or performance reasons.

static Request< Models.Challenge > Join

( UInt64 challengeID )

If the current user has the necessary permissions to join, participate in a challenge by providing the challenge ID, which can be retrieved using Challenge::ID.

Parameters

challengeID

The ID of challenge that the user is going to join. It can be retrieved by Challenge::ID.

static Request< Models.Challenge > Leave

( UInt64 challengeID )

If the current user has the necessary permissions, they can leave a challenge by providing the challenge ID, which can be obtained using Challenge::ID.

Parameters

challengeID

The ID of challenge that the user is going to leave. It can be retrieved by Challenge::ID.

static Request< Models.Challenge > UpdateInfo

( UInt64 challengeID,

ChallengeOptions challengeOptions )

Parameters

challengeID

The uuid of the challenge.

challengeOptions

This indicates the options of the challenge and it can be retrieved by ChallengeOptions().

Deprecated

Use server-to-server API call instead.

Did you find this page helpful?