Instance Method

loadLeaderboardsWithCompletionHandler:

Load all of the leaderboards for the current leaderboard set.

Declaration

- (void)loadLeaderboardsWithCompletionHandler:(void (^)(NSArray<GKLeaderboard *> *leaderboards, NSError *error))completionHandler;

Parameters

completionHandler

A block that is called when the categories have been retrieved from the server.

The block receives the following parameters:

leaderboards

An array of GKLeaderboard objects that provides the leaderboards for your game. If an error occurred, this value may be non-nil. In this case, the array holds whatever data Game Kit was able to download before the error occurred.

error

If an error occurred, this error object describes the error. If the operation completed successfully, the value is nil.

Discussion

When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls your completion handler. The completion handler is always called on the main thread.

See Also

Loading the Leaderboard Sets

- loadImageWithCompletionHandler:

Load the image associated with the leaderboard set.

+ loadLeaderboardSetsWithCompletionHandler:

Load all of the leaderboard sets for the current game.

title

Localized title for the leaderboard set.

identifier

The identifier for the leaderboard set.

groupIdentifier

Identifies the group that the leaderboard set belongs to.