list method

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

Get the collection of players for the currently authenticated user.

Request parameters:

collection - Collection of players being retrieved Possible string values are:

• "CONNECTED" : Retrieve a list of players that are also playing this game in reverse chronological order.
• "VISIBLE" : Retrieve a list of players in the user's social graph that are visible to this game.
• "FRIENDS_ALL" : Retrieve a list of players who are friends of the user in alphabetical order.

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

maxResults - The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player 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 PlayerListResponse.

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<PlayerListResponse> list(
  core.String collection, {
  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/me/players/' + commons.escapeVariable('$collection');

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