API reference

OVR_ChallengeOptions.h File

Typedefs

struct ovrChallengeOptions * ovrChallengeOptionsHandle

The Challenge Option is a parameter that can be passed in the ovr_Challenges_GetList() method to retrieve a list of challenges that match the specified options. The ovr_ChallengeOptions_Create parameter allows you to specify the criteria for the challenges you want to retrieve, such as the viewer filter, the visibility, or the date range.

Functions

ovrChallengeOptionsHandle ovr_ChallengeOptions_Create ( )

Creates a new instance of ovrChallengeOptionsHandle() which is used to customize the option flow. It returns a handle to the newly created options object, which can be used to set various properties for the options.

void ovr_ChallengeOptions_Destroy

( ovrChallengeOptionsHandle handle )

Destroys an existing instance of the ovrChallengeOptionsHandle() and frees up memory when you're done using it.

void ovr_ChallengeOptions_SetDescription

( ovrChallengeOptionsHandle handle,

const char * value )

The description of the challenge is a detailed and informative text that provides a comprehensive overview of the challenge's objectives, rules, and requirements, which can be retrieved with ovr_Challenge_GetDescription().

void ovr_ChallengeOptions_SetEndDate

( ovrChallengeOptionsHandle handle,

unsigned long long value )

The challenge end date is the timestamp when this challenge ends, which can be retrieved using ovr_Challenge_GetEndDate().

void ovr_ChallengeOptions_SetIncludeActiveChallenges

( ovrChallengeOptionsHandle handle,

bool value )

This option indicates whether to include challenges that are currently active in the search results. By default, this is set to true, meaning that only active challenges will be returned.

void ovr_ChallengeOptions_SetIncludeFutureChallenges

( ovrChallengeOptionsHandle handle,

bool value )

This option indicates whether to include challenges that have not yet started in the search results. By default, this is set to false, meaning that only active will be returned.

void ovr_ChallengeOptions_SetIncludePastChallenges

( ovrChallengeOptionsHandle handle,

bool value )

This option indicates whether to include challenges that have already ended in the search results. By default, this is set to false, meaning that only active will be returned.

void ovr_ChallengeOptions_SetLeaderboardName

( ovrChallengeOptionsHandle handle,

const char * value )

Optional: Only find challenges belonging to this leaderboard. This filter allows you to narrow down the search results to only include challenges that are associated with a specific leaderboard.

void ovr_ChallengeOptions_SetStartDate

( ovrChallengeOptionsHandle handle,

unsigned long long value )

The challenge start date is the timestamp when this challenge begins, which can be retrieved using ovr_Challenge_GetStartDate().

void ovr_ChallengeOptions_SetTitle

( ovrChallengeOptionsHandle handle,

const char * value )

The title of the challenge is a descriptive label that provides a concise summary of the challenge's purpose and objectives, which 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 )

The challenge visibility setting specifies who can see and participate in this challenge, which be retrieved with ovr_Challenge_GetVisibility(). There are three visibility levels: ovrChallengeVisibility_Public, ovrChallengeVisibility_InviteOnly and ovrChallengeVisibility_Private.