getCharactersLeaderboardLeaderboardCharactersGet method

Future<DataPageCharacterLeaderboardSchema?> getCharactersLeaderboardLeaderboardCharactersGet({ CharacterLeaderboardType? sort, String? name, int? page, int? size, })

Get Characters Leaderboard

Fetch leaderboard details.

Parameters:

• CharacterLeaderboardType sort: Sort of character leaderboards.

• String name: Character name.

• int page: Page number

• int size: Page size

Implementation

Future<DataPageCharacterLeaderboardSchema?>
    getCharactersLeaderboardLeaderboardCharactersGet({
  CharacterLeaderboardType? sort,
  String? name,
  int? page,
  int? size,
}) async {
  final response =
      await getCharactersLeaderboardLeaderboardCharactersGetWithHttpInfo(
    sort: sort,
    name: name,
    page: page,
    size: size,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'DataPageCharacterLeaderboardSchema',
    ) as DataPageCharacterLeaderboardSchema;
  }
  return null;
}