list method

Future<LeaderboardListResponse> list({ String? language, int? maxResults, String? pageToken, String? $fields, })

Lists all the leaderboard metadata for your application.

Request parameters:

language - The preferred language to use for strings returned by this method.

maxResults - The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified maxResults.

pageToken - The token returned by the previous request.

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

Completes with a LeaderboardListResponse.

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<LeaderboardListResponse> list({
  core.String? language,
  core.int? maxResults,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'language': ?language == null ? null : [language],
    'maxResults': ?maxResults == null ? null : ['${maxResults}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

  const url_ = 'games/v1/leaderboards';

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