One Logo Pool Ball
GameKit · IOS API REFERENCE

GKGameActivityDefinition

class · iOS 26.0+ · SDK 27.1

class GKGameActivityDefinition

Members (16)

static · iOS 26.0+

loadGameActivityDefinitions

TypeScript
static loadGameActivityDefinitionsCompletionHandler(completionHandler: ((arg0: (Array<GKGameActivityDefinition>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class var all: [GKGameActivityDefinition] { get async throws }
static · iOS 26.0+

loadGameActivityDefinitions

TypeScript
static loadGameActivityDefinitionsIDsCompletionHandler(activityDefinitionIDs: (Array<string>) | null, completionHandler: ((arg0: (Array<GKGameActivityDefinition>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func loadGameActivityDefinitions(IDs activityDefinitionIDs: [String]?) async throws -> [GKGameActivityDefinition]
method · iOS 26.0+

loadAchievementDescriptions

TypeScript
loadAchievementDescriptions(completionHandler: ((arg0: (Array<GKAchievementDescription>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
var achievementDescriptions: [GKAchievementDescription] { get async throws }
method · iOS 26.0+

loadImage

TypeScript
loadImage(completionHandler: ((arg0: (_UIKit_UIImage) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
var image: UIImage? { get async throws }
method · iOS 26.0+

loadLeaderboards

TypeScript
loadLeaderboards(completionHandler: ((arg0: (Array<GKLeaderboard>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
var leaderboards: [GKLeaderboard] { get async throws }
get · iOS 26.0+

defaultProperties

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

details

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

fallbackURL

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

groupIdentifier

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

identifier

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

playStyle

TypeScript
get playStyle(): GKGameActivityPlayStyle
Swift declaration
var playStyle: GKGameActivityPlayStyle { get }
get · iOS 26.0+

releaseState

TypeScript
get releaseState(): GKReleaseState
Swift declaration
var releaseState: GKReleaseState { get }
get · iOS 26.0+

supportsPartyCode

TypeScript
get supportsPartyCode(): boolean
Swift declaration
var supportsPartyCode: Bool { get }
get · iOS 26.0+

supportsUnlimitedPlayers

TypeScript
get supportsUnlimitedPlayers(): boolean
Swift declaration
var supportsUnlimitedPlayers: Bool { get }
get · iOS 26.0+

title

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

playerRange

TypeScript
get playerRange(): (SDKHandle) | null
Swift declaration
final var playerRange: (any RangeExpression)? { get }

The range of players supported by this type of game activity. This can be nil if neither of minPlayers or maxPlayers are set by the developer, a closed range if both are set, or an open range suggesting this game activity supports an unlimited number of players.

Skipped declarations

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

GKGameActivityDefinition.init()

inherited init: clang: 'init' is unavailable

All GameKit types →