Class ScoresResource.ListRequest
Lists the scores in a leaderboard, starting from the top.
Inheritance
ScoresResource.ListRequest
Inherited Members
Namespace: Google.Apis.Games.v1
Assembly: Google.Apis.Games.v1.dll
Syntax
public class ScoresResource.ListRequest : GamesBaseServiceRequest<LeaderboardScores>, IClientServiceRequest<LeaderboardScores>, IClientServiceRequest
Constructors
ListRequest(IClientService, string, CollectionEnum, TimeSpanEnum)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string leaderboardId, ScoresResource.ListRequest.CollectionEnum collection, ScoresResource.ListRequest.TimeSpanEnum timeSpan)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | leaderboardId | |
ScoresResource.ListRequest.CollectionEnum | collection | |
ScoresResource.ListRequest.TimeSpanEnum | timeSpan |
Properties
Collection
The collection of scores you're requesting.
Declaration
[RequestParameter("collection", RequestParameterType.Path)]
public virtual ScoresResource.ListRequest.CollectionEnum Collection { get; }
Property Value
Type | Description |
---|---|
ScoresResource.ListRequest.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
TimeSpan
Required. The time span for the scores and ranks you're requesting.
Declaration
[RequestParameter("timeSpan", RequestParameterType.Query)]
public virtual ScoresResource.ListRequest.TimeSpanEnum TimeSpan { get; }
Property Value
Type | Description |
---|---|
ScoresResource.ListRequest.TimeSpanEnum |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()