get method

Future<Leaderboard> get(
  1. String leaderboardId, {
  2. String? language,
  3. String? $fields,
})

Retrieves the metadata of the leaderboard with the given ID.

Request parameters:

leaderboardId - The ID of the leaderboard.

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

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

Completes with a Leaderboard.

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<Leaderboard> get(
  core.String leaderboardId, {
  core.String? language,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (language != null) 'language': [language],
    if ($fields != null) 'fields': [$fields],
  };

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

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