Class UpdateRequest#

The body of an Update Lobby request.

Namespace: Unity.Services.Lobbies.Models#

Syntax#

[Preserve]
public class UpdateRequest

Constructors#

UpdateRequest(String, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Dictionary<String, DataObject>, String, String)#

The body of an Update Lobby request.

Declaration#

[Preserve]
public UpdateRequest(string name = null, int? maxPlayers = null, bool? isPrivate = null, bool? isLocked = null, Dictionary<string, DataObject> data = null, string hostId = null, string password = null)

Parameters#

Properties#

Data#

Custom game-specific properties to add, update, or remove from the lobby (e.g. mapName or gameType). To remove an existing property, include it in data but set the property object to null. To update the value to null, set the value property of the object to null.

Declaration#

[Preserve]
public JsonObject Data { get; }

Property Value#

HostId#

The ID of the player to make the host of the lobby. As soon as this is updated, the current host will no longer have permission to modify the lobby.

Declaration#

[Preserve]
public string HostId { get; }

Property Value#

IsLocked#

Whether or not the lobby is locked. If true, new players will not be able to join.

Declaration#

[Preserve]
public bool? IsLocked { get; }

Property Value#

IsPrivate#

Whether or not the lobby is private. Private lobbies do not appear in query results and cannot be fetched by non-members using the GetLobby API. If the lobby is not publicly visible, the creator can share the lobbyCode with other users who can use it to join this lobby.

Declaration#

[Preserve]
public bool? IsPrivate { get; }

Property Value#

MaxPlayers#

The maximum number of players that can be members of the lobby. Must be greater than or equal to the current number of players in the lobby.

Declaration#

[Preserve]
public int? MaxPlayers { get; }

Property Value#

Name#

The name of the lobby that should be displayed to users. All whitespace will be trimmed from the name.

Declaration#

[Preserve]
public string Name { get; }

Property Value#

Password#

Updates the password for this lobby. If previously unspecified, HasPassword set to true. If becoming null, HasPassword will be set to false. All future joins will be rejected unless provided password matches.

Declaration#

[Preserve]
public string Password { get; }

Property Value#