game-common / pragma.matchmaking / MatchmakingApi / isInMatchmaking /

isInMatchmaking #

suspend fun isInMatchmaking(playerId: <ERROR CLASS>): PragmaResult<Boolean, PragmaFailure>

Request to check whether a player is currently in matchmaking.

Return #

True if the player is currently in matchmaking or false otherwise.

Parameters #

playerId

The id of the player to check.

suspend fun isInMatchmaking(playerIds: List<<ERROR CLASS>>): PragmaResult<Map<<ERROR CLASS>, Boolean>, PragmaFailure>

Request to check whether a list of players are currently in matchmaking.

Return #

A map of player to a boolean that is true if the player is currently in matchmaking or false otherwise.

Parameters #

playerIds

The ids of the players to check.