docs.unity3d.com
    Show / Hide Table of Contents

    Class UserSystem.GetFriendsRequest

    Obtains a friend list

    Inheritance
    Object
    Request
    UserSystem.GetFriendsRequest
    Inherited Members
    Request.Result
    Request.HasUpdate()
    Request.Update()
    Namespace: Unity.PSN.PS5.Users
    Syntax
    public class GetFriendsRequest : Request

    Properties

    Filter

    The filter to use

    Declaration
    public UserSystem.GetFriendsRequest.Filters Filter { get; set; }
    Property Value
    Type Description
    UserSystem.GetFriendsRequest.Filters

    Limit

    Maximum number of items with which to respond at once.

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

    Minimum value 0, Maximum value 2000, Default value 100.

    NextOffset

    The next offset to use if more friends can be fetched

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

    Offset

    Relative position from start of list

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

    PreviousOffset

    The previous offset used in the request

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

    RetrievedAccountIds

    The retireved list of friend account ids

    Declaration
    public List<ulong> RetrievedAccountIds { get; }
    Property Value
    Type Description
    List<UInt64>

    SortOrder

    The sort order

    Declaration
    public UserSystem.GetFriendsRequest.Order SortOrder { get; set; }
    Property Value
    Type Description
    UserSystem.GetFriendsRequest.Order

    UserId

    User Id

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

    Methods

    Run()

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