reset method

Future<PlayerScoreResetResponse> reset(
  1. String leaderboardId, {
  2. String? $fields,
})

Resets scores for the leaderboard with the given ID for the currently authenticated player.

This method is only accessible to whitelisted tester accounts for your application.

Request parameters:

leaderboardId - The ID of the leaderboard.

$fields - Selector specifying which fields to include in a partial response.

Completes with a PlayerScoreResetResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<PlayerScoreResetResponse> reset(
  core.String leaderboardId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'games/v1management/leaderboards/' +
      commons.escapeVariable('$leaderboardId') +
      '/scores/reset';

  final response_ = await _requester.request(
    url_,
    'POST',
    queryParams: queryParams_,
  );
  return PlayerScoreResetResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}