Class JoinByCodeRequest
The body of a Join Lobby request using lobby code.
Inheritance
object
JoinByCodeRequest
Namespace: Unity.Services.Lobbies.Models
Assembly: solution.dll
Syntax
public class JoinByCodeRequest
Constructors
JoinByCodeRequest(string, Player, string)
The body of a Join Lobby request using lobby code.
Declaration
public JoinByCodeRequest(string lobbyCode, Player player = null, string password = null)
Parameters
| Type | Name | Description |
|---|---|---|
| string | lobbyCode | The lobby code of the lobby to join. Mutually exclusive with |
| Player | player | player param |
| string | password | 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
public string LobbyCode { get; }
Property Value
| Type | Description |
|---|---|
| string |
Password
The password to the target lobby. If target lobby HasPassword is true, this password must match or the request is denied.
Declaration
public string Password { get; }
Property Value
| Type | Description |
|---|---|
| string |
Player
Parameter player of JoinByCodeRequest
Declaration
public Player Player { get; }
Property Value
| Type | Description |
|---|---|
| Player |