Class JoinByCodeRequest

The body of a Join Lobby request using lobby code.

Inheritance

object

JoinByCodeRequest

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 = "JoinByCodeRequest")]
[Preserve]
public class JoinByCodeRequest

Constructors

JoinByCodeRequest(string, string, Player)

Initializes a new instance of the JoinByCodeRequest class.

Declaration

[Preserve]
public JoinByCodeRequest(string lobbyCode = null, string password = null, Player player = null)

Parameters

Type	Name	Description
string	lobbyCode	The lobby code of the lobby to join. Mutually exclusive with id. This is used to join a private lobby where the lobby code was shared to other users manually. (required).
string	password	The password to the target lobby. If target lobby HasPassword is true, this password must match or the request is denied..
Player	player	player.

Properties

LobbyCode

The lobby code of the lobby to join. Mutually exclusive with id. This is used to join a private lobby where the lobby code was shared to other users manually.

Declaration

[DataMember(Name = "lobbyCode", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string LobbyCode { get; set; }

Property Value

Type	Description
string	The lobby code of the lobby to join. Mutually exclusive with id. This is used to join a private lobby where the lobby code was shared to other users manually.

Password

The password to the target lobby. If target lobby HasPassword is true, this password must match or the request is denied.

Declaration

[DataMember(Name = "password", EmitDefaultValue = true)]
[Preserve]
public string Password { get; set; }

Property Value

Type	Description
string	The password to the target lobby. If target lobby HasPassword is true, this password must match or the request is denied.

Player

Gets or Sets Player

Declaration

[DataMember(Name = "player", EmitDefaultValue = false)]
[Preserve]
public Player Player { get; set; }

Property Value

Type	Description
Player