API reference

OVR_Challenge.h File

Typedefs

struct ovrChallenge * ovrChallengeHandle

Challenges leverage ovrDestinationHandle and Group Presence to create shareable links that allow players to compete directly based on score.Challenges can be ranked by highest or lowest scores within a time period. Any application that uses Leaderboards gets Challenges for free. It appears in the Scoreboards UI. Players can create Challenges and send invites through the Challenges app.

Functions

ovrChallengeCreationType ovr_Challenge_GetCreationType

( const ovrChallengeHandle obj )

An enum that specifies if this challenge was created by a user (ovrChallengeCreationType_UserCreated) or the app developer (ovrChallengeCreationType_DeveloperCreated).

const char * ovr_Challenge_GetDescription

( const ovrChallengeHandle obj )

A displayable string of the challenge's description.

unsigned long long ovr_Challenge_GetEndDate

( const ovrChallengeHandle obj )

The timestamp when this challenge ends. You can retrieve this field from the response of the challenge creation request.

ovrID ovr_Challenge_GetID

( const ovrChallengeHandle obj )

The ID of the challenge. This is an unique string that the application will refer to this challenge in your app.

ovrUserArrayHandle ovr_Challenge_GetInvitedUsers

( const ovrChallengeHandle obj )

Users that are invited to this challenge. This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.

ovrLeaderboardHandle ovr_Challenge_GetLeaderboard

( const ovrChallengeHandle obj )

The ovrLeaderboardHandle associated with this challenge. You can retrieve the leaderboard ID from the response of the challenge creation request.

ovrUserArrayHandle ovr_Challenge_GetParticipants

( const ovrChallengeHandle obj )

Users that have participated in this challenge. This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.

unsigned long long ovr_Challenge_GetStartDate

( const ovrChallengeHandle obj )

The timestamp when this challenge begins. You can retrieve this field from the response of the challenge creation request.

const char * ovr_Challenge_GetTitle

( const ovrChallengeHandle obj )

A displayable string of the challenge's title.

ovrChallengeVisibility ovr_Challenge_GetVisibility

( const ovrChallengeHandle obj )

An enum that specifies who can see and participate in this challenge.ovrChallengeVisibility_InviteOnly - Only those invited can participate in it. Everyone can see it.ovrChallengeVisibility_Public - Everyone can participate and see this challenge.ovrChallengeVisibility_Private - Only those invited can participate and see this challenge.