docs.unity3d.com
    Show / Hide Table of Contents

    Class GameSessionRequests.RetrievedSessionData

    Retrieved session data when using GameSessionRequests.GetGameSessionsRequest

    Inheritance
    Object
    GameSessionRequests.RetrievedSessionData
    Namespace: Unity.PSN.PS5.Sessions
    Syntax
    public class RetrievedSessionData

    Properties

    CreatedTimeStamp

    Date and time of creation of the Player Session

    Declaration
    public DateTime CreatedTimeStamp { get; }
    Property Value
    Type Description
    DateTime

    CustomData1

    Custom data. The maximum size is the size yielded from encoding 1024 bytes in Base64.

    Declaration
    public byte[] CustomData1 { get; }
    Property Value
    Type Description
    Byte[]

    CustomData2

    Custom data. The maximum size is the size yielded from encoding 1024 bytes in Base64.

    Declaration
    public byte[] CustomData2 { get; }
    Property Value
    Type Description
    Byte[]

    IsUserInSession

    True is the calling user is in the session

    Declaration
    public bool IsUserInSession { get; }
    Property Value
    Type Description
    Boolean

    JoinDisabled

    Flag for temporarily prohibiting joining

    Declaration
    public bool JoinDisabled { get; }
    Property Value
    Type Description
    Boolean

    MatchmakingOfferId

    Information added by the Matchmaking service

    Declaration
    public string MatchmakingOfferId { get; }
    Property Value
    Type Description
    String

    MaxPlayers

    Maximum number of members who can join as players

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

    MaxSpectators

    Maximum number of members who can join as spectators

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

    Players

    Members participating as players. This will only contain a partial set of session member data

    Declaration
    public SessionMember[] Players { get; }
    Property Value
    Type Description
    SessionMember[]

    ReservationTimeoutSeconds

    Period of validity for a reservation by a member to join a Game Session

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

    SessionId

    The session id

    Declaration
    public string SessionId { get; }
    Property Value
    Type Description
    String

    SetFlags

    The flags represent which parts of the data have been returned based on the RequiredFields

    Declaration
    public GameSession.ParamTypes SetFlags { get; }
    Property Value
    Type Description
    GameSession.ParamTypes

    Spectators

    Members participating as spectators. This will only contain a partial set of session member data

    Declaration
    public SessionMember[] Spectators { get; }
    Property Value
    Type Description
    SessionMember[]

    SupportedPlatforms

    Platforms that can join

    Declaration
    public SessionPlatforms SupportedPlatforms { get; }
    Property Value
    Type Description
    SessionPlatforms

    UsePlayerSession

    Flag that indicates Game Session and Player Session dependency. true indicates an association with a Player Session, and false indicates a standalone Game Session.

    Declaration
    public bool UsePlayerSession { get; }
    Property Value
    Type Description
    Boolean
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX
    on 25 September 2020