docs.unity3d.com
    Show / Hide Table of Contents

    Class Leaderboards.GetRankingRequest

    Obtains ranking data

    Inheritance
    Object
    Request
    Leaderboards.GetRankingRequest
    Inherited Members
    Request.Result
    Request.HasUpdate()
    Request.Update()
    Namespace: Unity.PSN.PS5.Leaderboard
    Syntax
    public class GetRankingRequest : Request

    Properties

    BoardId

    Leaderboard ID

    Declaration
    public int BoardId { get; set; }
    Property Value
    Type Description
    Int32

    Group

    Collection of target users, such as friends

    Declaration
    public Leaderboards.GetRankingRequest.Groups Group { get; set; }
    Property Value
    Type Description
    Leaderboards.GetRankingRequest.Groups

    Limit

    Number of entries

    Declaration
    public int Limit { get; set; }
    Property Value
    Type Description
    Int32

    Offset

    From what position within the target range for obtaining rankings to do so

    Declaration
    public int Offset { get; set; }
    Property Value
    Type Description
    Int32

    Rankings

    Leaderboard ranking results

    Declaration
    public Leaderboards.Rankings Rankings { get; }
    Property Value
    Type Description
    Leaderboards.Rankings

    ServiceLabel

    NP service label

    Declaration
    public uint ServiceLabel { get; set; }
    Property Value
    Type Description
    UInt32

    StartSerialRank

    From which rank (where the player who scored first is ranked higher if there is a tie in terms of points) to start targeting for obtaining rankings

    Declaration
    public int StartSerialRank { get; set; }
    Property Value
    Type Description
    Int32

    UserId

    User ID

    Declaration
    public int UserId { get; set; }
    Property Value
    Type Description
    Int32

    Users

    Specified set of users

    Declaration
    public List<Leaderboards.GetRankingRequest.UserInfo> Users { get; set; }
    Property Value
    Type Description
    List<Leaderboards.GetRankingRequest.UserInfo>

    Methods

    Run()

    Declaration
    protected override void Run()
    Overrides
    Request.Run()
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on 25 September 2020