Instance Method

loadDefaultLeaderboardCategoryID(completionHandler:)

Loads the category identifier for the local player’s default leaderboard.

Declaration

func loadDefaultLeaderboardCategoryID(completionHandler: ((String?, Error?) -> Void)? = nil)

Parameters

completionHandler

A block to be called when the request completes.

The block receives the following parameters:

categoryID

The category ID string for the local player’s default leaderboard.

error

If an error occurred, this parameter holds an error object that explains the error. Otherwise, the value of this parameter 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

Deprecated Methods and Properties

func authenticate(completionHandler: ((Error?) -> Void)?)

Authenticates the local player on the device.

Deprecated
var friends: [String]?

An array of NSString objects containing the player identifiers for the local player’s friends.

Deprecated
func loadFriendPlayers(completionHandler: (([GKPlayer]?, Error?) -> Void)?)

Retrieves a list of player identifiers for the local player’s friends.

Deprecated
func loadFriends(completionHandler: (([String]?, Error?) -> Void)?)

Retrieves a list of player identifiers for the local player’s friends.

Deprecated
func setDefaultLeaderboardCategoryID(String?, completionHandler: ((Error?) -> Void)?)

Sets the category identifier for the local player’s default leaderboard.

Deprecated