list method

Future<SnapshotListResponse> list(
  1. String playerId, {
  2. String? language,
  3. int? maxResults,
  4. String? pageToken,
  5. String? $fields,
})

Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

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 snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot resources 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 SnapshotListResponse.

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

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

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