API reference

Challenge Class

Challenges leverage com.meta.horizon.platform.ovr.models.Destination 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.

getCreationType ()	An enum that specifies if this challenge was created by a user (com.meta.horizon.platform.ovr.enums.ChallengeCreationType#UserCreated) or the app developer (com.meta.horizon.platform.ovr.enums.ChallengeCreationType#DeveloperCreated). Signature ChallengeCreationType com.meta.horizon.platform.ovr.models.Challenge.getCreationType() Returns `ChallengeCreationType` ChallengeCreationType
getDescription ()	A displayable string of the challenge's description. Signature String com.meta.horizon.platform.ovr.models.Challenge.getDescription() Returns `String` String
getEndDate ()	The timestamp when this challenge ends. You can retrieve this field from the response of the challenge creation request. Signature LocalDateTime com.meta.horizon.platform.ovr.models.Challenge.getEndDate() Returns `LocalDateTime` LocalDateTime
getID ()	The ID of the challenge. This is an unique string that the application will refer to this challenge in your app. Signature long com.meta.horizon.platform.ovr.models.Challenge.getID() Returns `long` long
getInvitedUsers ()	Users that are invited to this challenge. Signature UserArray com.meta.horizon.platform.ovr.models.Challenge.getInvitedUsers() Returns `UserArray` UserArray
getLeaderboard ()	The com.meta.horizon.platform.ovr.models.Leaderboard associated with this challenge. You can retrieve the leaderboard ID from the response of the challenge creation request. Signature Leaderboard com.meta.horizon.platform.ovr.models.Challenge.getLeaderboard() Returns `Leaderboard` Leaderboard
getParticipants ()	Users that have participated in this challenge. Signature UserArray com.meta.horizon.platform.ovr.models.Challenge.getParticipants() Returns `UserArray` UserArray
getStartDate ()	The timestamp when this challenge begins. You can retrieve this field from the response of the challenge creation request. Signature LocalDateTime com.meta.horizon.platform.ovr.models.Challenge.getStartDate() Returns `LocalDateTime` LocalDateTime
getTitle ()	A displayable string of the challenge's title. Signature String com.meta.horizon.platform.ovr.models.Challenge.getTitle() Returns `String` String
getVisibility ()	An enum that specifies who can see and participate in this challenge. com.meta.horizon.platform.ovr.enums.ChallengeVisibility#InviteOnly - Only those invited can participate in it. Everyone can see it. com.meta.horizon.platform.ovr.enums.ChallengeVisibility#Public - Everyone can participate and see this challenge. com.meta.horizon.platform.ovr.enums.ChallengeVisibility#Private - Only those invited can participate and see this challenge. Signature ChallengeVisibility com.meta.horizon.platform.ovr.models.Challenge.getVisibility() Returns `ChallengeVisibility` ChallengeVisibility

Challenge Class

Constructors

Methods