list method

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

Lists the progress for all your application's achievements for the currently authenticated player.

Request parameters:

playerId - A player ID. A value of me may be used in place of the authenticated player's ID.

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

maxResults - The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified maxResults.

pageToken - The token returned by the previous request.

state - Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned. Possible string values are:

• "ALL" : List all achievements. This is the default.
• "HIDDEN" : List only hidden achievements.
• "REVEALED" : List only revealed achievements.
• "UNLOCKED" : List only unlocked achievements.

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

Completes with a PlayerAchievementListResponse.

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

  final url_ = 'games/v1/players/' +
      commons.escapeVariable('$playerId') +
      '/achievements';

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