FOvrChallengeOptions Struct

The Challenge Option is a parameter that can be passed in the UOvrRequestsBlueprintLibrary::Challenges_GetList() method to retrieve a list of challenges that match the specified options. The FOvrChallengeOptions 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.

Constructors

FOvrChallengeOptions ()

Signature

FOvrChallengeOptions::FOvrChallengeOptions()

Fields

Description : FString	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 field FOvrChallenge::Description. Signature FString FOvrChallengeOptions::Description
EndDate : FDateTime	The challenge end date is the timestamp when this challenge ends, which can be retrieved using field FOvrChallenge::EndDate. Signature FDateTime FOvrChallengeOptions::EndDate
IncludeActiveChallenges : bool	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. Signature bool FOvrChallengeOptions::IncludeActiveChallenges
IncludeFutureChallenges : bool	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. Signature bool FOvrChallengeOptions::IncludeFutureChallenges
IncludePastChallenges : bool	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. Signature bool FOvrChallengeOptions::IncludePastChallenges
LeaderboardName : FString	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. Signature FString FOvrChallengeOptions::LeaderboardName
StartDate : FDateTime	The challenge start date is the timestamp when this challenge begins, which can be retrieved using field FOvrChallenge::StartDate. Signature FDateTime FOvrChallengeOptions::StartDate
Title : FString	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 field FOvrChallenge::Title. Signature FString FOvrChallengeOptions::Title
ViewerFilter : EOvrChallengeViewerFilter	An enum that specifies what filter to apply to the list of returned challenges. Returns all public (EOvrChallengeVisibility::Public) and invite-only (EOvrChallengeVisibility::InviteOnly) FOvrChallenge in which the user is a participant or invitee. Excludes private (EOvrChallengeVisibility::Private) challenges. EOvrChallengeViewerFilter::Participating - Returns challenges the user is participating in. EOvrChallengeViewerFilter::Invited - Returns challenges the user is invited to. EOvrChallengeViewerFilter::ParticipatingOrInvited - Returns challenges the user is either participating in or invited to. Signature EOvrChallengeViewerFilter FOvrChallengeOptions::ViewerFilter
Visibility : EOvrChallengeVisibility	The challenge visibility setting specifies who can see and participate in this challenge, which be retrieved with field FOvrChallenge::Visibility. There are three visibility levels: EOvrChallengeVisibility::Public, EOvrChallengeVisibility::InviteOnly and EOvrChallengeVisibility::Private. Signature EOvrChallengeVisibility FOvrChallengeOptions::Visibility