MetaPlatformSDK_ChallengeOptions

Inherits: RefCounted

Represents challenge search options.

Description

Represents challenge search options.

Methods

void	set_description ( String value )
void	set_end_date ( int value )
void	set_include_active_challenges ( bool value )
void	set_include_future_challenges ( bool value )
void	set_include_past_challenges ( bool value )
void	set_leaderboard_name ( String value )
void	set_start_date ( int value )
void	set_title ( String value )
void	set_viewer_filter ( ChallengeViewerFilter value )
void	set_visibility ( ChallengeVisibility value )

---

Method Descriptions

void set_description ( String 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.

---

void set_end_date ( int value )

The challenge end date is the timestamp when this challenge ends.

---

void set_include_active_challenges ( 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 set_include_future_challenges ( 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 set_include_past_challenges ( 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 set_leaderboard_name ( String value )

Optional: Only find challenges belonging to this leaderboard.

---

void set_start_date ( int value )

The challenge start date is the timestamp when this challenge begins.

---

void set_title ( String value )

The title of the challenge is a descriptive label that provides a concise summary of the challenge's purpose and objectives.

---

void set_viewer_filter ( ChallengeViewerFilter value )

An enum that specifies what filter to apply to the list of returned challenges.

Returns all public and invite-only challenges in which the user is a participant or invitee. Excludes private challenges.

---

void set_visibility ( ChallengeVisibility value )

The challenge visibility setting specifies who can see and participate in this challenge.