API reference
Challenges Class
Static Member Functions
static Request< Models.ChallengeEntryList > GetNextEntries
( Models.ChallengeEntryList list )
static Request< Models.ChallengeEntryList > GetPreviousEntries
( Models.ChallengeEntryList list )
static Request< Models.ChallengeList > GetNextChallenges
( Models.ChallengeList list )
static Request< Models.ChallengeList > GetPreviousChallenges
( Models.ChallengeList list )
static Request< Models.Challenge > Create
( string leaderboardName,
ChallengeOptions challengeOptions )
DEPRECATED. Use server-to-server API call instead.
static Request< Models.Challenge > DeclineInvite
( UInt64 challengeID )
If the current user has an invite to the challenge, decline the invite
static Request Delete
( UInt64 challengeID )
DEPRECATED. Use server-to-server API call instead.
static Request< Models.Challenge > Get
( UInt64 challengeID )
Gets the information for a single challenge
Parameters
challengeID
The id of the challenge whose entries to return.
static Request< Models.ChallengeEntryList > GetEntries
( UInt64 challengeID,
int limit,
LeaderboardFilterType filter,
LeaderboardStartAt startAt )
Requests a block of challenge entries.
Parameters
challengeID
The id of the challenge whose entries to return.
limit
Defines the maximum number of entries to return.
filter
By using ovrLeaderboard_FilterFriends, this allows you to filter the returned values to bidirectional followers.
startAt
Defines whether to center the query on the user or start at the top of the challenge.
static Request< Models.ChallengeEntryList > GetEntriesAfterRank
( UInt64 challengeID,
int limit,
ulong afterRank )
Requests a block of challenge entries.
Parameters
challengeID
The id of the challenge whose entries to return.
limit
The maximum number of entries to return.
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 )
Requests a block of challenge entries. Will return only entries matching the user IDs passed in.
Parameters
challengeID
The id of the challenge whose entries to return.
limit
Defines the maximum number of entries to return.
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.
userIDs
Defines a list of user ids to get entries for.
static Request< Models.ChallengeList > GetList
( ChallengeOptions challengeOptions,
int limit )
Requests for a list of challenge
static Request< Models.Challenge > Join
( UInt64 challengeID )
If the current user has permission, join the challenge
static Request< Models.Challenge > Leave
( UInt64 challengeID )
If the current user has permission, leave the challenge
static Request< Models.Challenge > UpdateInfo
( UInt64 challengeID,
ChallengeOptions challengeOptions )
DEPRECATED. Use server-to-server API call instead.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta