API reference

OVR_ChallengeOptions.h File

Typedefs

struct ovrChallengeOptions * ovrChallengeOptionsHandle

Functions

ovrChallengeOptionsHandle ovr_ChallengeOptions_Create ( )

void ovr_ChallengeOptions_Destroy

( ovrChallengeOptionsHandle handle )

void ovr_ChallengeOptions_SetDescription

( ovrChallengeOptionsHandle handle,

const char * value )

The description of the challenge that can be retrieved with ovr_Challenge_GetDescription().

void ovr_ChallengeOptions_SetEndDate

( ovrChallengeOptionsHandle handle,

unsigned long long value )

The timestamp when this challenge ends which can be retrieved with ovr_Challenge_GetEndDate().

void ovr_ChallengeOptions_SetIncludeActiveChallenges

( ovrChallengeOptionsHandle handle,

bool value )

This indicates whether to include challenges that are currently active.

void ovr_ChallengeOptions_SetIncludeFutureChallenges

( ovrChallengeOptionsHandle handle,

bool value )

This indicates whether to include challenges that have not yet started.

void ovr_ChallengeOptions_SetIncludePastChallenges

( ovrChallengeOptionsHandle handle,

bool value )

This indicates whether to include challenges that have already ended.

void ovr_ChallengeOptions_SetLeaderboardName

( ovrChallengeOptionsHandle handle,

const char * value )

Optional: Only find challenges belonging to this leaderboard.

void ovr_ChallengeOptions_SetStartDate

( ovrChallengeOptionsHandle handle,

unsigned long long value )

The timestamp when this challenge starts which can be retrieved with ovr_Challenge_GetStartDate().

void ovr_ChallengeOptions_SetTitle

( ovrChallengeOptionsHandle handle,

const char * value )

The title of the challenge that can be retrieved with ovr_Challenge_GetTitle().

void ovr_ChallengeOptions_SetViewerFilter

( ovrChallengeOptionsHandle handle,

ovrChallengeViewerFilter value )

An enum that specifies what filter to apply to the list of returned challenges.Returns all public ((ovrChallengeVisibility_Public)) and invite-only (ovrChallengeVisibility_InviteOnly) ovrChallengeHandles in which the user is a participant or invitee. Excludes private (ovrChallengeVisibility_Private) challenges.ovrChallengeViewerFilter_Participating - Returns challenges the user is participating in.ovrChallengeViewerFilter_Invited - Returns challenges the user is invited to.ovrChallengeViewerFilter_ParticipatingOrInvited - Returns challenges the user is either participating in or invited to.

void ovr_ChallengeOptions_SetVisibility

( ovrChallengeOptionsHandle handle,

ovrChallengeVisibility value )

Specifies who can see and participate in this challenge. It can be retrieved with ovr_Challenge_GetVisibility().