Class ScoresResource.ListWindowRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<LeaderboardScores>
GamesBaseServiceRequest<LeaderboardScores>
ScoresResource.ListWindowRequest
Implements
Inherited Members
Namespace: Google.Apis.Games.v1
Assembly: Google.Apis.Games.v1.dll
Syntax
public class ScoresResource.ListWindowRequest : GamesBaseServiceRequest<LeaderboardScores>, IClientServiceRequest<LeaderboardScores>, IClientServiceRequest

Constructors

ListWindowRequest(IClientService, string, CollectionEnum, TimeSpanEnum)

Constructs a new ListWindow request.

Declaration
public ListWindowRequest(IClientService service, string leaderboardId, ScoresResource.ListWindowRequest.CollectionEnum collection, ScoresResource.ListWindowRequest.TimeSpanEnum timeSpan)
Parameters
Type Name Description
IClientService service
string leaderboardId
ScoresResource.ListWindowRequest.CollectionEnum collection
ScoresResource.ListWindowRequest.TimeSpanEnum timeSpan

Properties

Collection

The collection of scores you're requesting.

Declaration
[RequestParameter("collection", RequestParameterType.Path)]
public virtual ScoresResource.ListWindowRequest.CollectionEnum Collection { get; }
Property Value
Type Description
ScoresResource.ListWindowRequest.CollectionEnum

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

Language

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

Declaration
[RequestParameter("language", RequestParameterType.Query)]
public virtual string Language { get; set; }
Property Value
Type Description
string

LeaderboardId

The ID of the leaderboard.

Declaration
[RequestParameter("leaderboardId", RequestParameterType.Path)]
public virtual string LeaderboardId { get; }
Property Value
Type Description
string

MaxResults

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.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageToken

The token returned by the previous request.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ResultsAbove

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.

Declaration
[RequestParameter("resultsAbove", RequestParameterType.Query)]
public virtual int? ResultsAbove { get; set; }
Property Value
Type Description
int?

ReturnTopIfAbsent

True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.

Declaration
[RequestParameter("returnTopIfAbsent", RequestParameterType.Query)]
public virtual bool? ReturnTopIfAbsent { get; set; }
Property Value
Type Description
bool?

TimeSpan

Required. The time span for the scores and ranks you're requesting.

Declaration
[RequestParameter("timeSpan", RequestParameterType.Query)]
public virtual ScoresResource.ListWindowRequest.TimeSpanEnum TimeSpan { get; }
Property Value
Type Description
ScoresResource.ListWindowRequest.TimeSpanEnum

Methods

InitParameters()

Initializes ListWindow parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements