One Logo Pool Ball
GameKit · IOS API REFERENCE

GKGameSession

class · iOS 10.0+ · Deprecated in iOS 12.0 · SDK 27.1

class GKGameSession

Members (23)

static · iOS 10.0+ · Deprecated in iOS 12.0

add

TypeScript
static add(listener: Implements<GKGameSessionEventListener> | SDKHandle): void
Swift declaration
class func add(listener: any GKGameSessionEventListener)
static · iOS 10.0+ · Deprecated in iOS 12.0

createSession

TypeScript
static createSession(containerName: (string) | null, title: string, maxPlayers: number, completionHandler: ((arg0: (GKGameSession) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func createSession(inContainer containerName: String?, withTitle title: String, maxConnectedPlayers maxPlayers: Int) async throws -> GKGameSession
static · iOS 10.0+ · Deprecated in iOS 12.0

load

TypeScript
static load(identifier: string, completionHandler: ((arg0: (GKGameSession) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func load(withIdentifier identifier: String) async throws -> GKGameSession
static · iOS 10.0+ · Deprecated in iOS 12.0

loadSessions

TypeScript
static loadSessions(containerName: (string) | null, completionHandler: ((arg0: (Array<GKGameSession>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func loadSessions(inContainer containerName: String?) async throws -> [GKGameSession]
static · iOS 10.0+ · Deprecated in iOS 12.0

remove

TypeScript
static removeListener(listener: Implements<GKGameSessionEventListener> | SDKHandle): void
Swift declaration
class func remove(listener: any GKGameSessionEventListener)
static · iOS 10.0+ · Deprecated in iOS 12.0

remove

TypeScript
static removeWithIdentifierCompletionHandler(identifier: string, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
class func remove(withIdentifier identifier: String) async throws
method · iOS 10.0+ · Deprecated in iOS 12.0

clearBadge

TypeScript
clearBadge(players: Array<GKCloudPlayer>, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func clearBadge(for players: [GKCloudPlayer]) async throws
method · iOS 10.0+ · Deprecated in iOS 12.0

getShareURL

TypeScript
getShareURL(completionHandler: ((arg0: (string) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func shareURL() async throws -> URL
init

init

TypeScript
static init(): GKGameSession
Swift declaration
init()
method · iOS 10.0+ · Deprecated in iOS 12.0

loadData

TypeScript
loadData(completionHandler: ((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func loadData() async throws -> Data
method · iOS 10.0+ · Deprecated in iOS 12.0

players

TypeScript
playersWith(state: GKConnectionState): Array<GKCloudPlayer>
Swift declaration
func players(with state: GKConnectionState) -> [GKCloudPlayer]
method · iOS 10.0+ · Deprecated in iOS 12.0

save

TypeScript
save(data: ArrayBuffer, completionHandler: ((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func save(_ data: Data, completionHandler: @escaping (Data?, (any Error)?) -> Void)
method · iOS 10.0+ · Deprecated in iOS 12.0

send

TypeScript
send(data: ArrayBuffer, transport: GKTransportType, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func send(_ data: Data, with transport: GKTransportType) async throws
method · iOS 10.0+ · Deprecated in iOS 12.0

sendMessage

TypeScript
sendMessage(key: string, arguments_: Array<string>, data: (ArrayBuffer) | null, players: Array<GKCloudPlayer>, badgePlayers: boolean, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func sendMessage(withLocalizedFormatKey key: String, arguments: [String], data: Data?, to players: [GKCloudPlayer], badgePlayers: Bool) async throws
method · iOS 10.0+ · Deprecated in iOS 12.0

setConnectionState

TypeScript
setConnectionState(state: GKConnectionState, completionHandler: ((arg0: (NativeError) | null) => void)): void
Swift declaration
func setConnectionState(_ state: GKConnectionState) async throws
get · iOS 10.0+ · Deprecated in iOS 12.0

badgedPlayers

TypeScript
get badgedPlayers(): Array<GKCloudPlayer>
Swift declaration
var badgedPlayers: [GKCloudPlayer] { get }
get · iOS 10.0+ · Deprecated in iOS 12.0

identifier

TypeScript
get identifier(): string
Swift declaration
var identifier: String { get }
get · iOS 10.0+ · Deprecated in iOS 12.0

lastModifiedDate

TypeScript
get lastModifiedDate(): globalThis.Date
Swift declaration
var lastModifiedDate: Date { get }
get · iOS 10.0+ · Deprecated in iOS 12.0

lastModifiedPlayer

TypeScript
get lastModifiedPlayer(): GKCloudPlayer
Swift declaration
var lastModifiedPlayer: GKCloudPlayer { get }
get · iOS 10.0+ · Deprecated in iOS 12.0

maxNumberOfConnectedPlayers

TypeScript
get maxNumberOfConnectedPlayers(): number
Swift declaration
var maxNumberOfConnectedPlayers: Int { get }
get · iOS 10.0+ · Deprecated in iOS 12.0

owner

TypeScript
get owner(): GKCloudPlayer
Swift declaration
var owner: GKCloudPlayer { get }
get · iOS 10.0+ · Deprecated in iOS 12.0

players

TypeScript
get players(): Array<GKCloudPlayer>
Swift declaration
var players: [GKCloudPlayer] { get }
get · iOS 10.0+ · Deprecated in iOS 12.0

title

TypeScript
get title(): string
Swift declaration
var title: String { get }

Skipped declarations

No declarations were skipped in this snapshot.

All GameKit types →