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.

Member Functions

Challenge

( final long ptr )

ChallengeCreationType 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).

Returns

ChallengeCreationType

String getDescription ( )

A displayable string of the challenge's description.

Returns

String

LocalDateTime getEndDate ( )

The timestamp when this challenge ends. You can retrieve this field from the response of the challenge creation request.

Returns

LocalDateTime

long getID ( )

The ID of the challenge. This is an unique string that the application will refer to this challenge in your app.

Returns

long

UserArray getInvitedUsers ( )

Users that are invited to this challenge.

Returns

UserArray

Leaderboard 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.

Returns

Leaderboard

UserArray getParticipants ( )

Users that have participated in this challenge.

Returns

UserArray

LocalDateTime getStartDate ( )

The timestamp when this challenge begins. You can retrieve this field from the response of the challenge creation request.

Returns

LocalDateTime

String getTitle ( )

A displayable string of the challenge's title.