One Logo Pool Ball
X
Github
Discord

System

GameKit · IOS API REFERENCE

GKGameActivity

class · iOS 26.0+ · SDK 27.1

class GKGameActivity

Members (35)

static · iOS 26.0+

checkPendingGameActivityExistence

TypeScript
static checkPendingGameActivityExistence(completionHandler: ((arg0: boolean) => void)): void
Swift declaration
class var hasPendingGameActivities: Bool { get async }
static · iOS 26.0+

isValidPartyCode

TypeScript
static isValidPartyCode(partyCode: string): boolean
Swift declaration
class func isValidPartyCode(_ partyCode: String) -> Bool
static · iOS 26.0+

start

TypeScript
static startDefinition(activityDefinition: GKGameActivityDefinition): GKGameActivity
Swift declaration
class func start(definition activityDefinition: GKGameActivityDefinition) throws -> GKGameActivity
static · iOS 26.0+

start

TypeScript
static startDefinitionPartyCode(activityDefinition: GKGameActivityDefinition, partyCode: string): GKGameActivity
Swift declaration
class func start(definition activityDefinition: GKGameActivityDefinition, partyCode: String) throws -> GKGameActivity
get · iOS 26.0+

validPartyCodeAlphabet

TypeScript
static get validPartyCodeAlphabet(): Array<string>
Swift declaration
class var validPartyCodeAlphabet: [String] { get }
method · iOS 26.0+

end

TypeScript
end(): void
Swift declaration
func end()
method · iOS 26.0+

findMatch

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

findPlayersForHostedMatch

TypeScript
findPlayersForHostedMatch(completionHandler: ((arg0: (Array<GKPlayer>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func findPlayersForHostedMatch() async throws -> [GKPlayer]
method · iOS 26.0+

progress

TypeScript
progress(achievement: GKAchievement): number
Swift declaration
func progress(on achievement: GKAchievement) -> Double
method · iOS 26.0+

score

TypeScript
score(leaderboard: GKLeaderboard): (GKLeaderboardScore) | null
Swift declaration
func score(on leaderboard: GKLeaderboard) -> GKLeaderboardScore?
init · iOS 26.0+

init

TypeScript
static init(activityDefinition: GKGameActivityDefinition): GKGameActivity
Swift declaration
init(definition activityDefinition: GKGameActivityDefinition)
method · iOS 26.0+

makeMatchRequest

TypeScript
makeMatchRequest(): (GKMatchRequest) | null
Swift declaration
func makeMatchRequest() -> GKMatchRequest?
method · iOS 26.0+

pause

TypeScript
pause(): void
Swift declaration
func pause()
method · iOS 26.0+

removeAchievements

TypeScript
removeAchievements(achievements: Array<GKAchievement>): void
Swift declaration
func removeAchievements(_ achievements: [GKAchievement])
method · iOS 26.0+

removeScores

TypeScript
removeScores(leaderboards: Array<GKLeaderboard>): void
Swift declaration
func removeScores(from leaderboards: [GKLeaderboard])
method · iOS 26.0+

resume

TypeScript
resume(): void
Swift declaration
func resume()
method · iOS 26.0+

setAchievementCompleted

TypeScript
setAchievementCompleted(achievement: GKAchievement): void
Swift declaration
func setAchievementCompleted(_ achievement: GKAchievement)
method · iOS 26.0+

setProgress

TypeScript
setProgress(achievement: GKAchievement, percentComplete: number): void
Swift declaration
func setProgress(on achievement: GKAchievement, to percentComplete: Double)
method · iOS 26.0+

setScore

TypeScript
setScoreOnTo(leaderboard: GKLeaderboard, score: number): void
Swift declaration
func setScore(on leaderboard: GKLeaderboard, to score: Int)
method · iOS 26.0+

setScore

TypeScript
setScoreOnToContext(leaderboard: GKLeaderboard, score: number, context: number): void
Swift declaration
func setScore(on leaderboard: GKLeaderboard, to score: Int, context: Int)
method · iOS 26.0+

start

TypeScript
start(): void
Swift declaration
func start()
get · iOS 26.0+

achievements

TypeScript
get achievements(): Array<GKAchievement>
Swift declaration
var achievements: Set<GKAchievement> { get }
get · iOS 26.0+

activityDefinition

TypeScript
get activityDefinition(): GKGameActivityDefinition
Swift declaration
var activityDefinition: GKGameActivityDefinition { get }
get · iOS 26.0+

creationDate

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

duration

TypeScript
get duration(): number
Swift declaration
var duration: TimeInterval { get }
get · iOS 26.0+

endDate

TypeScript
get endDate(): (globalThis.Date) | null
Swift declaration
var endDate: Date? { get }
get · iOS 26.0+

identifier

TypeScript
get identifier(): string
Swift declaration
var identifier: String { get }
get · iOS 26.0+

lastResumeDate

TypeScript
get lastResumeDate(): (globalThis.Date) | null
Swift declaration
var lastResumeDate: Date? { get }
get · iOS 26.0+

leaderboardScores

TypeScript
get leaderboardScores(): Array<GKLeaderboardScore>
Swift declaration
var leaderboardScores: Set<GKLeaderboardScore> { get }
get · iOS 26.0+

partyCode

TypeScript
get partyCode(): (string) | null
Swift declaration
var partyCode: String? { get }
get · iOS 26.0+

partyURL

TypeScript
get partyURL(): (string) | null
Swift declaration
var partyURL: URL? { get }
get · iOS 26.0+

properties

TypeScript
get properties(): Record<string, string>
Swift declaration
var properties: [String : String] { get set }
set · iOS 26.0+

properties

TypeScript
set properties(value: Record<string, string>)
Swift declaration
var properties: [String : String] { get set }
get · iOS 26.0+

startDate

TypeScript
get startDate(): (globalThis.Date) | null
Swift declaration
var startDate: Date? { get }
get · iOS 26.0+

state

TypeScript
get state(): GKGameActivity_State
Swift declaration
var state: GKGameActivity.State { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

GKGameActivity.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All GameKit types →