> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PlayFabMultiplayer.JoinArrangedLobby

> PlayFabMultiplayer.JoinArrangedLobby

## Method (1 of 2)

Joins a lobby using an arrangement string provided by another service, such as matchmaking. If no one has joined the lobby yet, the lobby is initialized using the configuration parameters.

```csharp theme={null}
public static Lobby JoinArrangedLobby(PFEntityKey newMember, string arrangementString, 
    LobbyArrangedJoinConfiguration config)
```

| parameter | description |
| - | - |
| newMember | The local PlayFab entity joining the lobby. |
| arrangementString | The arrangement string used by the entity to join the lobby. |
| config | The initial configuration data used to initialize the lobby, if no one has joined the lobby yet. |

## Return Value (1 of 2)

Output lobby object which can be used to queue operations for immediate execution of this operation

## Remarks (1 of 2)

This is an asynchronous operation. Upon successful completion, the title will be provided a [`OnLobbyMemberAdded`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyMemberAdded) followed by a [`OnLobbyJoinArrangedLobbyCompleted`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinArrangedLobbyCompleted) with the `OnLobbyJoinArrangedLobbyCompleted.result` field set to [`Success`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/Success). Upon a failed completion, the title will be provided a [`OnLobbyJoinArrangedLobbyCompleted`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinArrangedLobbyCompleted) with the with the `result` field set to a failure.

When using matchmaking through this library, the [`LobbyArrangementString`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/LobbyArrangementString) can be used with this method to join a lobby with all of the users that have been matched together.

***

## Method (2 of 2)

Joins a lobby using an arrangement string provided by another service, such as matchmaking. If no one has joined the lobby yet, the lobby is initialized using the configuration parameters.

```csharp theme={null}
public static Lobby JoinArrangedLobby(PlayFabAuthenticationContext newMember, 
    string arrangementString, LobbyArrangedJoinConfiguration config)
```

| parameter | description |
| - | - |
| newMember | The local PlayFab entity joining the lobby. |
| arrangementString | The arrangement string used by the entity to join the lobby. |
| config | The initial configuration data used to initialize the lobby, if no one has joined the lobby yet. |

## Return Value (2 of 2)

Output lobby object which can be used to queue operations for immediate execution of this operation

## Remarks (2 of 2)

This is an asynchronous operation. Upon successful completion, the title will be provided a [`OnLobbyMemberAdded`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyMemberAdded) followed by a [`OnLobbyJoinArrangedLobbyCompleted`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinArrangedLobbyCompleted) with the `OnLobbyJoinArrangedLobbyCompleted.result` field set to [`Success`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyError/Success). Upon a failed completion, the title will be provided a [`OnLobbyJoinArrangedLobbyCompleted`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinArrangedLobbyCompleted) with the with the `result` field set to a failure.

When using matchmaking through this library, the [`LobbyArrangementString`](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/MatchmakingMatchDetails/LobbyArrangementString) can be used with this method to join a lobby with all of the users that have been matched together.

## See Also

* class [Lobby](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/Lobby/overview.md)
* class [PFEntityKey](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PFEntityKey/overview.md)
* class [LobbyArrangedJoinConfiguration](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/LobbyArrangedJoinConfiguration/overview.md)
* class [PlayFabMultiplayer](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/overview.md)
* namespace [PlayFab.Multiplayer](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference.md)


## Related topics

- [PlayFabMultiplayer.OnLobbyJoinArrangedLobbyCompleted](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinArrangedLobbyCompleted.md)
- [PlayFabMultiplayer.JoinLobby](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/JoinLobby.md)
- [PlayFabMultiplayer.CreateAndJoinLobby](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/CreateAndJoinLobby.md)
- [PlayFabMultiplayer.OnLobbyJoinCompleted](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyJoinCompleted.md)
- [PlayFabMultiplayer.OnLobbyCreateAndJoinCompleted](https://docs.xbox.com/services/playfab/multiplayer/lobby/unity-multiplayer-api-reference/PlayFab.Multiplayer/PlayFabMultiplayer/OnLobbyCreateAndJoinCompleted.md)