Class BulkUpdateRequest

The body of a Bulk Update request.

Inheritance

object

BulkUpdateRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Lobbies

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "BulkUpdateRequest")]
[Preserve]
public class BulkUpdateRequest

Constructors

BulkUpdateRequest(UpdateRequest, Dictionary<string, PlayerUpdateRequest>, List<Player>, List<string>, bool?)

Initializes a new instance of the BulkUpdateRequest class.

Declaration

[Preserve]
public BulkUpdateRequest(UpdateRequest lobbyUpdate = null, Dictionary<string, PlayerUpdateRequest> playerUpdates = null, List<Player> playersToAdd = null, List<string> playersToRemove = null, bool? ignoreIneffectualUpdates = false)

Parameters

Type	Name	Description
UpdateRequest	lobbyUpdate	lobbyUpdate.
Dictionary<string, PlayerUpdateRequest>	playerUpdates	A mapping from player IDs to player update requests..
List<Player>	playersToAdd	An array of players to add to the lobby..
List<string>	playersToRemove	An array of player IDs to remove from the lobby..
bool?	ignoreIneffectualUpdates	Whether or not to silently ignore ineffectual updates (i.e. removing or updating players who are not in the lobby) instead of failing. (default to false).

Properties

IgnoreIneffectualUpdates

Whether or not to silently ignore ineffectual updates (i.e. removing or updating players who are not in the lobby) instead of failing.

Declaration

[DataMember(Name = "ignoreIneffectualUpdates", EmitDefaultValue = true)]
[Preserve]
public bool? IgnoreIneffectualUpdates { get; set; }

Property Value

Type	Description
bool?	Whether or not to silently ignore ineffectual updates (i.e. removing or updating players who are not in the lobby) instead of failing.

LobbyUpdate

Gets or Sets LobbyUpdate

Declaration

[DataMember(Name = "lobbyUpdate", EmitDefaultValue = false)]
[Preserve]
public UpdateRequest LobbyUpdate { get; set; }

Property Value

Type	Description
UpdateRequest

PlayerUpdates

A mapping from player IDs to player update requests.

Declaration

[DataMember(Name = "playerUpdates", EmitDefaultValue = true)]
[Preserve]
public Dictionary<string, PlayerUpdateRequest> PlayerUpdates { get; set; }

Property Value

Type	Description
Dictionary<string, PlayerUpdateRequest>	A mapping from player IDs to player update requests.

PlayersToAdd

An array of players to add to the lobby.

Declaration

[DataMember(Name = "playersToAdd", EmitDefaultValue = true)]
[Preserve]
public List<Player> PlayersToAdd { get; set; }

Property Value

Type	Description
List<Player>	An array of players to add to the lobby.

PlayersToRemove

An array of player IDs to remove from the lobby.

Declaration

[DataMember(Name = "playersToRemove", EmitDefaultValue = true)]
[Preserve]
public List<string> PlayersToRemove { get; set; }

Property Value

Type	Description
List<string>	An array of player IDs to remove from the lobby.