-
Notifications
You must be signed in to change notification settings - Fork 0
newgroundsiodotnet.components.requests.scoreboard.scoreboardgetscoresrequest
Namespace: NewgroundsIODotNet.Components.Requests.ScoreBoard
Request to get the Scores from a Scoreboard
public class ScoreBoardGetScoresRequest : NewgroundsIODotNet.Components.Interfaces.INgioComponentRequestInheritance Object → ScoreBoardGetScoresRequest
Implements INgioComponentRequest
public string Component { get; }public Dictionary<string, object> Parameters { get; }public object Echo { get; set; }public bool RequiresSecureCall { get; }App ID of another game to get the scores from. Set to null to use the current game
public string AppId { get; set; }ID of the ScoreBoard to get scores from.
public int Id { get; set; }How many score entries to fetch
public int Limit { get; set; }Period of time to get the scores from
public ScoreBoardPeriod Period { get; set; }How many scores to skip before fetching
public int Skip { get; set; }Whether the scores will only include the logged in user and their friends
public bool Social { get; set; }Remarks:
Useless if there's no Session with a specified User.
Tag to filter scores by.
public string FilterTag { get; set; }ID or Username of the User to get local stores in relation to.
public string User { get; set; }Use this constructor only if you know what you're doing.
public ScoreBoardGetScoresRequest(Dictionary<string, object> parameters, object echo)parameters Dictionary<String, Object>
Manually provided component parameters
echo Object
NGIO Echo response
ScoreBoardGetScoresRequest(Int32, String, Int32, ScoreBoardPeriod, Int32, Boolean, String, Nullable<User>)
public ScoreBoardGetScoresRequest(int id, string appId, int limit, ScoreBoardPeriod period, int skip, bool social, string tag, Nullable<User> user)id Int32
appId String
limit Int32
period ScoreBoardPeriod
skip Int32
social Boolean
tag String
user Nullable<User>
ScoreBoardGetScoresRequest(ScoreBoard, String, Int32, ScoreBoardPeriod, Int32, Boolean, String, Nullable<User>)
public ScoreBoardGetScoresRequest(ScoreBoard board, string appId, int limit, ScoreBoardPeriod period, int skip, bool social, string tag, Nullable<User> user)board ScoreBoard
appId String
limit Int32
period ScoreBoardPeriod
skip Int32
social Boolean
tag String
user Nullable<User>