Edit

Share via


MultiplayerSessionProperties.ReadRestriction Property

Definition

Gets or sets the restriction that is applied to members when reading an open session. Defaults to "none".

public Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionRestriction ReadRestriction { get; set; }
member this.ReadRestriction : Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionRestriction with get, set
Public Property ReadRestriction As MultiplayerSessionRestriction

Property Value

Implements

Microsoft.Xbox.Services.Multiplayer.__IMultiplayerSessionPropertiesPublicNonVirtuals.ReadRestriction

Remarks

The read restriction has no effect on reservations, which means that it has no impact on "private" and "visible" sessions.

If "local", only users whose token's DeviceId matches someone else already in the session and "active": true. If "followed", only local users (as defined above) and users who are followed by an existing (not reserved) member of the session can read without a reservation.

The read restriction must be at least as open as the JoinRestriction restriction. For example, JoinRestriction cannot be set to MultiplayerSessionJoinRestriction.Followed without also setting ReadRestriction to MultiplayerSessionReadRestriction.Followed.

Applies to