One Logo Pool Ball
X
Github
Discord

System

GameKit · IOS API REFERENCE

GKMatchmaker

class · iOS 4.1+ · SDK 27.1

class GKMatchmaker

Members (20)

static · iOS 4.1+

shared

TypeScript
static shared(): GKMatchmaker
Swift declaration
class func shared() -> GKMatchmaker
method · iOS 4.1+

addPlayers

TypeScript
addPlayers(match: GKMatch, matchRequest: GKMatchRequest, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func addPlayers(to match: GKMatch, matchRequest: GKMatchRequest) async throws
method · iOS 4.1+

cancel

TypeScript
cancel(): void
Swift declaration
func cancel()
method · iOS 6.0+ · Deprecated in iOS 8.0

cancelInvite

TypeScript
cancelInvite(playerID: string): void
Swift declaration
func cancelInvite(toPlayer playerID: String)
method · iOS 8.0+

cancelPendingInvite

TypeScript
cancelPendingInvite(player: GKPlayer): void
Swift declaration
func cancelPendingInvite(to player: GKPlayer)
method · iOS 4.1+

findMatch

TypeScript
findMatch(request: GKMatchRequest, completionHandler?: (((arg0: (GKMatch) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func findMatch(for request: GKMatchRequest) async throws -> GKMatch
method · iOS 17.2+

findMatchedPlayers

TypeScript
findMatchedPlayers(request: GKMatchRequest, completionHandler: ((arg0: (GKMatchedPlayers) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func findMatchedPlayers(_ request: GKMatchRequest) async throws -> GKMatchedPlayers
method · iOS 4.1+ · Deprecated in iOS 8.0

findPlayers

TypeScript
findPlayersForHostedMatchRequestWithCompletionHandler(request: GKMatchRequest, completionHandler?: (((arg0: (Array<string>) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func findPlayers(forHostedMatchRequest request: GKMatchRequest, withCompletionHandler completionHandler: (@Sendable ([String]?, (any Error)?) -> Void)? = nil)
method · iOS 8.0+

findPlayers

TypeScript
findPlayersForHostedRequestWithCompletionHandler(request: GKMatchRequest, completionHandler?: (((arg0: (Array<GKPlayer>) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func findPlayers(forHostedRequest request: GKMatchRequest) async throws -> [GKPlayer]
method · iOS 6.0+

finishMatchmaking

TypeScript
finishMatchmaking(match: GKMatch): void
Swift declaration
func finishMatchmaking(for match: GKMatch)
init

init

TypeScript
static init(): GKMatchmaker
Swift declaration
init()
method · iOS 6.0+

match

TypeScript
match(invite: GKInvite, completionHandler?: (((arg0: (GKMatch) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func match(for invite: GKInvite) async throws -> GKMatch
method · iOS 4.1+

queryActivity

TypeScript
queryActivity(completionHandler?: (((arg0: number, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func queryActivity() async throws -> Int
method · iOS 4.1+

queryPlayerGroupActivity

TypeScript
queryPlayerGroupActivity(playerGroup: number, completionHandler?: (((arg0: number, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func queryPlayerGroupActivity(_ playerGroup: Int) async throws -> Int
method · iOS 17.2+

queryQueueActivity

TypeScript
queryQueueActivity(queueName: string, completionHandler?: (((arg0: number, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func queryQueueActivity(_ queueName: String) async throws -> Int
method · iOS 8.0+

startBrowsingForNearbyPlayers

TypeScript
startBrowsingForNearbyPlayersHandler(reachableHandler?: (((arg0: GKPlayer, arg1: boolean) => void)) | null): void
Swift declaration
func startBrowsingForNearbyPlayers(handler reachableHandler: ((GKPlayer, Bool) -> Void)? = nil)
method · iOS 6.0+ · Deprecated in iOS 8.0

startBrowsingForNearbyPlayers

TypeScript
startBrowsingForNearbyPlayersReachableHandler(reachableHandler?: (((arg0: string, arg1: boolean) => void)) | null): void
Swift declaration
func startBrowsingForNearbyPlayers(reachableHandler: ((String, Bool) -> Void)? = nil)
method · iOS 16.2+

startGroupActivity

TypeScript
startGroupActivity(handler: ((arg0: GKPlayer) => void)): void
Swift declaration
func startGroupActivity(playerHandler handler: @escaping (GKPlayer) -> Void)
method · iOS 6.0+

stopBrowsingForNearbyPlayers

TypeScript
stopBrowsingForNearbyPlayers(): void
Swift declaration
func stopBrowsingForNearbyPlayers()
method · iOS 16.2+

stopGroupActivity

TypeScript
stopGroupActivity(): void
Swift declaration
func stopGroupActivity()

Skipped declarations

No declarations were skipped in this snapshot.

All GameKit types →