One Logo Pool Ball
X
Github
Discord

System

GameKit · IOS API REFERENCE

GKTurnBasedMatch

class · iOS 5.0+ · SDK 27.1

class GKTurnBasedMatch

Members (34)

static · iOS 5.0+

find

TypeScript
static find(request: GKMatchRequest, completionHandler: ((arg0: (GKTurnBasedMatch) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func find(for request: GKMatchRequest) async throws -> GKTurnBasedMatch
static · iOS 5.0+

load

TypeScript
static load(matchID: string, completionHandler?: (((arg0: (GKTurnBasedMatch) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
class func load(withID matchID: String) async throws -> GKTurnBasedMatch
static · iOS 5.0+

loadMatches

TypeScript
static loadMatches(completionHandler?: (((arg0: (Array<GKTurnBasedMatch>) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
class func loadMatches() async throws -> [GKTurnBasedMatch]
method · iOS 5.0+

acceptInvite

TypeScript
acceptInvite(completionHandler?: (((arg0: (GKTurnBasedMatch) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func acceptInvite() async throws -> GKTurnBasedMatch
method · iOS 5.0+

declineInvite

TypeScript
declineInvite(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func declineInvite() async throws
method · iOS 5.0+

endMatchInTurn

TypeScript
endMatchInTurnWithMatchCompletionHandler(matchData: ArrayBuffer, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func endMatchInTurn(withMatch matchData: Data) async throws
method · iOS 14.0+

endMatchInTurn

TypeScript
endMatchInTurnWithMatchLeaderboardScoresAchievementsCompletionHandler(matchData: ArrayBuffer, scores: Array<GKLeaderboardScore>, achievements: Array<unknown>, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func endMatchInTurn(withMatch matchData: Data, leaderboardScores scores: [GKLeaderboardScore], achievements: [Any]) async throws
method · iOS 6.0+ · Deprecated in iOS 14.0

endMatchInTurn

TypeScript
endMatchInTurnWithMatchScoresAchievementsCompletionHandler(matchData: ArrayBuffer, scores?: (Array<GKScore>) | null, achievements?: (Array<GKAchievement>) | null, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func endMatchInTurn(withMatch matchData: Data, scores: [GKScore]?, achievements: [GKAchievement]?) async throws
method · iOS 6.0+

endTurn

TypeScript
endTurn(nextParticipants: Array<GKTurnBasedParticipant>, timeout: number, matchData: ArrayBuffer, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func endTurn(withNextParticipants nextParticipants: [GKTurnBasedParticipant], turnTimeout timeout: TimeInterval, match matchData: Data) async throws
init

init

TypeScript
static init(): GKTurnBasedMatch
Swift declaration
init()
method · iOS 5.0+

loadMatchData

TypeScript
loadMatchData(completionHandler?: (((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func loadMatchData() async throws -> Data?
method · iOS 6.0+

participantQuitInTurn

TypeScript
participantQuitInTurn(matchOutcome: GKTurnBasedMatch_Outcome, nextParticipants: Array<GKTurnBasedParticipant>, timeout: number, matchData: ArrayBuffer, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func participantQuitInTurn(with matchOutcome: GKTurnBasedMatch.Outcome, nextParticipants: [GKTurnBasedParticipant], turnTimeout timeout: TimeInterval, match matchData: Data) async throws
method · iOS 5.0+

participantQuitOutOfTurn

TypeScript
participantQuitOutOfTurn(matchOutcome: GKTurnBasedMatch_Outcome, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func participantQuitOutOfTurn(with matchOutcome: GKTurnBasedMatch.Outcome) async throws
method · iOS 6.0+

rematch

TypeScript
rematch(completionHandler?: (((arg0: (GKTurnBasedMatch) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func rematch() async throws -> GKTurnBasedMatch
method · iOS 5.0+

remove

TypeScript
remove(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func remove() async throws
method · iOS 6.0+

saveCurrentTurn

TypeScript
saveCurrentTurn(matchData: ArrayBuffer, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func saveCurrentTurn(withMatch matchData: Data) async throws
method · iOS 7.0+

saveMergedMatch

TypeScript
saveMergedMatch(matchData: ArrayBuffer, exchanges: Array<GKTurnBasedExchange>, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func saveMergedMatch(_ matchData: Data, withResolvedExchanges exchanges: [GKTurnBasedExchange]) async throws
method · iOS 7.0+

sendExchange

TypeScript
sendExchange(participants: Array<GKTurnBasedParticipant>, data: ArrayBuffer, key: string, arguments_: Array<string>, timeout: number, completionHandler?: (((arg0: (GKTurnBasedExchange) | null, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func sendExchange(to participants: [GKTurnBasedParticipant], data: Data, localizableMessageKey key: String, arguments: [String], timeout: TimeInterval) async throws -> GKTurnBasedExchange
method · iOS 7.0+

sendReminder

TypeScript
sendReminder(participants: Array<GKTurnBasedParticipant>, key: string, arguments_: Array<string>, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void
Swift declaration
func sendReminder(to participants: [GKTurnBasedParticipant], localizableMessageKey key: String, arguments: [String]) async throws
method · iOS 7.0+

setLocalizableMessageWithKey

TypeScript
setLocalizableMessageWithKey(key: string, arguments_?: (Array<string>) | null): void
Swift declaration
func setLocalizableMessageWithKey(_ key: String, arguments: [String]?)
get · iOS 7.0+

activeExchanges

TypeScript
get activeExchanges(): (Array<GKTurnBasedExchange>) | null
Swift declaration
var activeExchanges: [GKTurnBasedExchange]? { get }
get · iOS 7.0+

completedExchanges

TypeScript
get completedExchanges(): (Array<GKTurnBasedExchange>) | null
Swift declaration
var completedExchanges: [GKTurnBasedExchange]? { get }
get · iOS 5.0+

creationDate

TypeScript
get creationDate(): globalThis.Date
Swift declaration
var creationDate: Date { get }
get · iOS 5.0+

currentParticipant

TypeScript
get currentParticipant(): (GKTurnBasedParticipant) | null
Swift declaration
var currentParticipant: GKTurnBasedParticipant? { get }
get · iOS 7.0+

exchangeDataMaximumSize

TypeScript
get exchangeDataMaximumSize(): number
Swift declaration
var exchangeDataMaximumSize: Int { get }
get · iOS 7.0+

exchangeMaxInitiatedExchangesPerPlayer

TypeScript
get exchangeMaxInitiatedExchangesPerPlayer(): number
Swift declaration
var exchangeMaxInitiatedExchangesPerPlayer: Int { get }
get · iOS 7.0+

exchanges

TypeScript
get exchanges(): (Array<GKTurnBasedExchange>) | null
Swift declaration
var exchanges: [GKTurnBasedExchange]? { get }
get · iOS 5.0+

matchData

TypeScript
get matchData(): (ArrayBuffer) | null
Swift declaration
var matchData: Data? { get }
get · iOS 6.0+

matchDataMaximumSize

TypeScript
get matchDataMaximumSize(): number
Swift declaration
var matchDataMaximumSize: Int { get }
get · iOS 5.0+

matchID

TypeScript
get matchID(): string
Swift declaration
var matchID: String { get }
get · iOS 5.0+

message

TypeScript
get message(): (string) | null
Swift declaration
var message: String? { get set }
set · iOS 5.0+

message

TypeScript
set message(value: (string) | null)
Swift declaration
var message: String? { get set }
get · iOS 5.0+

participants

TypeScript
get participants(): Array<GKTurnBasedParticipant>
Swift declaration
var participants: [GKTurnBasedParticipant] { get }
get · iOS 5.0+

status

TypeScript
get status(): GKTurnBasedMatch_Status
Swift declaration
var status: GKTurnBasedMatch.Status { get }

Skipped declarations

No declarations were skipped in this snapshot.

All GameKit types →