loadCategories(completionHandler:)
Loads the list of leaderboard categories along with their corresponding localized titles.
Declaration
class func loadCategories(completionHandler: (@Sendable ([String]?, [String]?, (any Error)?) -> Void)? = nil)class func loadCategories() async throws -> ([String], [String])Parameters
- completionHandler:
A block to call after retrieving the categories from the server.
The block receives the following parameters:
- categories
An array of
NSStringobjects that provides the categories to your game. If an error occurs, this value may be non-nil. In this case, the array holds whatever data GameKit downloads before the error occurs.- titles
An array of
NSStringobjects that provides localized titles for each category. If an error occurs, this value may be non-nil. In this case, the array holds whatever data GameKit downloads before the error occurs.- error
If an error occurs, this error object describes the error. If the operation completes successfully, the value is
nil.
Discussion
You use this class method to retrieve the category identifiers and titles you configure for your leaderboards in App Store Connect. To create a leaderboard query that targets a particular category, set the category property to one of the strings that this method returns.
When you call this method, it creates a new background task to handle the request. The method then returns control to your game. When the task is complete, GameKit calls your completion handler on the main thread.