GoogleApi.Games.V1.Api.Scores.games_scores_list_window

You're seeing just the function games_scores_list_window, go back to GoogleApi.Games.V1.Api.Scores module for more information.
Link to this function

games_scores_list_window(connection, leaderboard_id, collection, time_span, optional_params \\ [], opts \\ [])

View Source

Specs

games_scores_list_window(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.LeaderboardScores.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the scores in a leaderboard around (and including) a player's score.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • leaderboard_id (type: String.t) - The ID of the leaderboard.
  • collection (type: String.t) - The collection of scores you're requesting.
  • time_span (type: String.t) - The time span for the scores and ranks you're requesting.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :language (type: String.t) - The preferred language to use for strings returned by this method.
    • :maxResults (type: integer()) - The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.
    • :pageToken (type: String.t) - The token returned by the previous request.
    • :resultsAbove (type: integer()) - The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
    • :returnTopIfAbsent (type: boolean()) - True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Games.V1.Model.LeaderboardScores{}} on success
  • {:error, info} on failure