GameKit · IOS API REFERENCE

GKAchievement

class · iOS 4.1+ · SDK 27.1

class GKAchievement

Members (22)

static · iOS 4.1+

loadAchievements

TypeScript

static loadAchievements(completionHandler?: (((arg0: (Array<GKAchievement>) | null, arg1: (NativeError) | null) => void)) | null): void

Swift declaration

class func loadAchievements() async throws -> [GKAchievement]

static · iOS 6.0+

report

TypeScript

static reportWithCompletionHandler(achievements: Array<GKAchievement>, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void

Swift declaration

class func report(_ achievements: [GKAchievement]) async throws

static · iOS 7.0+ · Deprecated in iOS 26.0

report

TypeScript

static reportWithEligibleChallengesWithCompletionHandler(achievements: Array<GKAchievement>, challenges: Array<GKChallenge>, completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void

Swift declaration

class func report(_ achievements: [GKAchievement], withEligibleChallenges challenges: [GKChallenge]) async throws

static · iOS 4.1+

resetAchievements

TypeScript

static resetAchievements(completionHandler?: (((arg0: (NativeError) | null) => void)) | null): void

Swift declaration

class func resetAchievements() async throws

method · iOS 17.0+ · Deprecated in iOS 26.0

challengeComposeController

TypeScript

challengeComposeControllerWithMessagePlayersCompletion(message: (string) | null, players: Array<GKPlayer>, completionHandler?: (((arg0: _UIKit_UIViewController, arg1: boolean, arg2: (Array<GKPlayer>) | null) => void)) | null): _UIKit_UIViewController

Swift declaration

func challengeComposeController(withMessage message: String?, players: [GKPlayer], completion completionHandler: GKChallengeComposeHandler? = nil) -> UIViewController

method · iOS 8.0+ · Deprecated in iOS 17.0

challengeComposeController

TypeScript

challengeComposeControllerWithMessagePlayersCompletionHandler(message: (string) | null, players: Array<GKPlayer>, completionHandler?: (((arg0: _UIKit_UIViewController, arg1: boolean, arg2: (Array<string>) | null) => void)) | null): _UIKit_UIViewController

Swift declaration

func challengeComposeController(withMessage message: String?, players: [GKPlayer], completionHandler: GKChallengeComposeCompletionBlock? = nil) -> UIViewController

method · iOS 7.0+ · Deprecated in iOS 8.0

challengeComposeController

TypeScript

challengeComposeControllerWithPlayersMessageCompletionHandler(playerIDs?: (Array<string>) | null, message?: (string) | null, completionHandler?: (((arg0: _UIKit_UIViewController, arg1: boolean, arg2: (Array<string>) | null) => void)) | null): (_UIKit_UIViewController) | null

Swift declaration

func challengeComposeController(withPlayers playerIDs: [String]?, message: String?, completionHandler: GKChallengeComposeCompletionBlock? = nil) -> UIViewController?

init · iOS 4.1+

init

TypeScript

static initIdentifier(identifier: string): GKAchievement

Swift declaration

init(identifier: String)

init · iOS 7.0+ · Deprecated in iOS 8.0

init

TypeScript

static initIdentifierForPlayer(identifier: (string) | null, playerID: string): (GKAchievement) | null

Swift declaration

init?(identifier: String?, forPlayer playerID: String)

init · iOS 8.0+

init

TypeScript

static initIdentifierPlayer(identifier: string, player: GKPlayer): GKAchievement

Swift declaration

init(identifier: String, player: GKPlayer)

method · iOS 6.0+ · Deprecated in iOS 8.0

selectChallengeablePlayerIDs

TypeScript

selectChallengeablePlayerIDs(playerIDs?: (Array<string>) | null, completionHandler?: (((arg0: (Array<string>) | null, arg1: (NativeError) | null) => void)) | null): void

Swift declaration

func selectChallengeablePlayerIDs(_ playerIDs: [String]?, withCompletionHandler completionHandler: (@Sendable ([String]?, (any Error)?) -> Void)? = nil)

method · iOS 8.0+ · Deprecated in iOS 26.0

selectChallengeablePlayers

TypeScript

selectChallengeablePlayers(players: Array<GKPlayer>, completionHandler?: (((arg0: (Array<GKPlayer>) | null, arg1: (NativeError) | null) => void)) | null): void

Swift declaration

func selectChallengeablePlayers(_ players: [GKPlayer]) async throws -> [GKPlayer]

get · iOS 4.1+

isCompleted

TypeScript

get isCompleted(): boolean

Swift declaration

var isCompleted: Bool { get }

get · iOS 4.1+

identifier

TypeScript

get identifier(): string

Swift declaration

var identifier: String { get set }

set · iOS 4.1+

identifier

TypeScript

set identifier(value: string)

Swift declaration

var identifier: String { get set }

get · iOS 4.1+

lastReportedDate

TypeScript

get lastReportedDate(): globalThis.Date

Swift declaration

var lastReportedDate: Date { get }

get · iOS 4.1+

percentComplete

TypeScript

get percentComplete(): number

Swift declaration

var percentComplete: Double { get set }

set · iOS 4.1+

percentComplete

TypeScript

set percentComplete(value: number)

Swift declaration

var percentComplete: Double { get set }

get · iOS 8.0+

player

TypeScript

get player(): GKPlayer

Swift declaration

var player: GKPlayer { get }

get · iOS 7.0+ · Deprecated in iOS 8.0

playerID

TypeScript

get playerID(): (string) | null

Swift declaration

var playerID: String? { get }

get · iOS 5.0+

showsCompletionBanner

TypeScript

get showsCompletionBanner(): boolean

Swift declaration

var showsCompletionBanner: Bool { get set }

set · iOS 5.0+

showsCompletionBanner

TypeScript

set showsCompletionBanner(value: boolean)

Swift declaration

var showsCompletionBanner: Bool { get set }

Skipped declarations

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

GKAchievement.init()

inherited init: cannot prove legal (class declares 3 custom initializers)

All GameKit types →