| Modifier and Type | Class and Description |
|---|---|
class |
CLSInternalErrorException
Thrown when there is an internal error at the CLS server.
|
class |
CLSInvalidApiKeyException
Thrown when supplied API key is invalid.
|
class |
CLSInvalidReferenceException
Thrown when supplied API reference is invalid.
|
class |
CLSInvalidResponseException
Thrown when the response could not be evaluated.
|
| Modifier and Type | Method and Description |
|---|---|
CLSAchievementClaim |
CLSApiContext.ClaimAchievement(String playerApiReference,
String playerKey,
String achievementApiReference)
Convenience overload for ClaimAchievement(playerApiReference, achievementApiReference, null)
|
CLSAchievementClaim |
CLSApiContext.ClaimAchievement(String playerApiReference,
String playerKey,
String achievementApiReference,
Double progress)
Awards an event achievement to a player or updates progress on a progress achievement.
|
CLSAchievement |
CLSApiContext.GetAchievement(String achievementApiReference)
Requests information about a specific achievement.
|
List<CLSAchievementClaim> |
CLSApiContext.GetAchievementClaims(String playerApiReference)
Convenience overload for GetAchievementClaims(playerApiReference, null)
|
List<CLSAchievementClaim> |
CLSApiContext.GetAchievementClaims(String playerApiReference,
String achievementApiReference)
Requests achievement claims for a specific player.
|
List<CLSAchievement> |
CLSApiContext.GetAchievements()
Requests information about all achievements.
|
CLSPlayer |
CLSApiContext.GetPlayer(String playerApiReference)
Requests information about a specific player.
|
CLSProject |
CLSApiContext.GetProject()
Requests information about the project the API key was generated for.
|
CLSScoreboard |
CLSApiContext.GetScoreboard(String scoreboardApiReference)
Requests information about a specific scoreboard.
|
CLSScoreboard |
CLSApiContext.GetScoreboardResults(String scoreboardApiReference,
int offset,
int limit)
Requests scoreboard results.
|
CLSScoreboard |
CLSApiContext.GetScoreboardResults(String scoreboardApiReference,
String playerApiReference,
int offset,
int limit)
Requests scoreboard results for a specific player.
|
CLSScoreboardEntry |
CLSApiContext.InsertScoreboardRecord(String scoreboardApiReference,
CLSPlayer player,
double value)
Records a new scoreboard entry.
|
CLSScoreboardEntry |
CLSApiContext.InsertScoreboardRecord(String scoreboardApiReference,
String playerApiReference,
String playerKey,
double value)
Records a new scoreboard entry.
|
CLSPlayer |
CLSApiContext.RegisterPlayer()
Registers a new player at CLS.
|
CLSPlayer |
CLSApiContext.RegisterPlayer(String playerName)
Registers a new player with username at CLS.
|
void |
CLSApiContext.ReportPlayerActivity(CLSPlayer player)
Reports player activity for project analytics.
|
void |
CLSApiContext.ReportPlayerActivity(String playerApiReference,
String playerKey)
Reports player activity for project analytics.
|
CLSPlayer |
CLSApiContext.UpdatePlayer(CLSPlayer player,
String playerName,
String countryCode)
Updates player name or country code at CLS.
|
CLSPlayer |
CLSApiContext.UpdatePlayer(String playerApiReference,
String playerKey,
String playerName,
String countryCode)
Updates player name or country code at CLS.
|
Copyright © 2019. All rights reserved.