v1.2.1
Latest
2020.3+

Class JoinByCodeRequest

The body of a Join Lobby request using lobby code.

Inheritance
JoinByCodeRequest
Namespace: Unity.Services.Lobbies.Models
Syntax
[Preserve]
public class JoinByCodeRequest

Constructors

JoinByCodeRequest(String, Player, String)

The body of a Join Lobby request using lobby code.

Declaration
[Preserve]
public JoinByCodeRequest(string lobbyCode, Player player = null, string password = null)
Parameters
TypeNameDescription
StringlobbyCode

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.

Playerplayer

player param

Stringpassword

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

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
[Preserve]
public string LobbyCode { get; }
Property Value
TypeDescription
String

Password

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

Declaration
[Preserve]
public string Password { get; }
Property Value
TypeDescription
String

Player

Parameter player of JoinByCodeRequest

Declaration
[Preserve]
public Player Player { get; }
Property Value
TypeDescription
Player