Instance Method

challengeComposeController(withMessage:players:completionHandler:)

Provides a challenge compose view controller with pre-selected player identifiers and a preformatted, player-editable message.

Declaration

iOS, Mac Catalyst, tvOS
func challengeComposeController(withMessage message: String?, players: [GKPlayer]?, completionHandler: GKChallengeComposeCompletionBlock? = nil) -> UIViewController
macOS
func challengeComposeController(withMessage message: String?, players: [GKPlayer]?, completionHandler: GKChallengeComposeCompletionBlock? = nil) -> NSViewController

Parameters

message

The preformatted, player-editable message that is being sent to other players.

players

An array of GKPlayer objects that contains the player identifiers that the challenge is to be sent to.

completionHandler

A block to be called after the view controller has been displayed. Contains the reason the handler was called and all player identifiers that the challenge was sent to.

Return Value

A UIViewController view containing the player identifiers and a player-editable message.

Discussion

The view controller returned is presented modally from the top view controller. After the view controller is displayed and the player sends or cancels the challenge, the completion handler block is called.

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, GameKit calls your completion handler. The completion handler is always called on the main thread.