API reference
API reference
Select your platform
No SDKs available
No versions available

Challenge Class

Challenges leverage 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.

Fields

An enum that specifies if this challenge was created by a user (ChallengeCreationType.UserCreated) or the app developer (ChallengeCreationType.DeveloperCreated).
A displayable string of the challenge's description.
The timestamp when this challenge ends. You can retrieve this field from the response of the challenge creation request.
The ID of the challenge. This is an unique string that the application will refer to this challenge in your app.
Users that are invited to this challenge.
readonly UserList InvitedUsers[Get]
The Models.Leaderboard associated with this challenge. You can retrieve the leaderboard ID from the response of the challenge creation request.
Users that have participated in this challenge.
readonly UserList Participants[Get]
The timestamp when this challenge begins. You can retrieve this field from the response of the challenge creation request.
A displayable string of the challenge's title.
An enum that specifies who can see and participate in this challenge.ChallengeVisibility.InviteOnly - Only those invited can participate in it. Everyone can see it.ChallengeVisibility.Public - Everyone can participate and see this challenge.ChallengeVisibility.Private - Only those invited can participate and see this challenge.

Member Functions

Challenge
( IntPtr o )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon