Class PlayerSessionRequests.RetrievedSessionData
Retrieved session data when using PlayerSessionRequests.GetPlayerSessionsRequest
Namespace: Unity.PSN.PS5.Sessions
Syntax
public class RetrievedSessionDataProperties
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[] |
ExclusiveLeaderPrivileges
Information about the items to exclude from the leader privileges of a Player Session
Declaration
public LeaderPrivilegeFlags ExclusiveLeaderPrivileges { get; }Property Value
| Type | Description |
|---|---|
| LeaderPrivilegeFlags |
InvitableUserType
Members who can send invitations
Declaration
public InvitableUserTypes InvitableUserType { get; }Property Value
| Type | Description |
|---|---|
| InvitableUserTypes |
IsUserInSession
True is the calling user is in the session
Declaration
public bool IsUserInSession { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
JoinableSpecifiedUsers
List of the users who can join without invitations
Declaration
public ulong[] JoinableSpecifiedUsers { get; }Property Value
| Type | Description |
|---|---|
| UInt64[] |
JoinableUserType
Users who can join without invitations
Declaration
public JoinableUserTypes JoinableUserType { get; }Property Value
| Type | Description |
|---|---|
| JoinableUserTypes |
JoinDisabled
Flag for temporarily prohibiting joining
Declaration
public bool JoinDisabled { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
LeaderAccountId
The leader account id
Declaration
public ulong LeaderAccountId { get; }Property Value
| Type | Description |
|---|---|
| UInt64 |
LeaderPlatform
The leaders platform
Declaration
public SessionPlatforms LeaderPlatform { get; }Property Value
| Type | Description |
|---|---|
| SessionPlatforms |
LeaderPrivileges
Information about the items to include the leader privileges of a Player Session
Declaration
public LeaderPrivilegeFlags LeaderPrivileges { get; }Property Value
| Type | Description |
|---|---|
| LeaderPrivilegeFlags |
LocalisedNames
Name of the Player Session (in all languages)
Declaration
public LocalisedSessionNames LocalisedNames { get; }Property Value
| Type | Description |
|---|---|
| LocalisedSessionNames |
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[] |
SessionId
The session id
Declaration
public string SessionId { get; }Property Value
| Type | Description |
|---|---|
| String |
SessionName
Name of the Player Session
Declaration
public string SessionName { get; }Property Value
| Type | Description |
|---|---|
| String |
SetFlags
The flags represent which parts of the data have been returned based on the RequiredFields
Declaration
public PlayerSession.ParamTypes SetFlags { get; }Property Value
| Type | Description |
|---|---|
| PlayerSession.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 |
SwapSupported
Flag indicating whether swapping from player to spectator, or from spectator to player, is supported When true, it is supported.When this is the case, it is also possible to swap from the system software UI.When false, it is not supported.
Declaration
public bool SwapSupported { get; }Property Value
| Type | Description |
|---|---|
| Boolean |