challengeComposeController(withPlayers:message:completionHandler:)
Provides a challenge compose view controller with preselected player identifiers and a message.
Declaration
func challengeComposeController(withPlayers playerIDs: [String]?, message: String?, completionHandler: GKChallengeComposeCompletionBlock? = nil) -> UIViewController?Parameters
- playerIDs:
An array of
NSStringobjects that contains the player identifiers that the challenge is to be sent to. - message:
The message that is sent to other players. This message can be edited by the player.
- 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 that contains the player identifiers and the challenge message.
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.
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.