Instance Method

challengeComposeControllerWithMessage:players:completionHandler:

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

Declaration

iOS, Mac Catalyst, tvOS
- (UIViewController *)challengeComposeControllerWithMessage:(NSString *)message players:(NSArray<GKPlayer *> *)players completionHandler:(GKChallengeComposeCompletionBlock)completionHandler;
macOS
- (NSViewController *)challengeComposeControllerWithMessage:(NSString *)message players:(NSArray<GKPlayer *> *)players completionHandler:(GKChallengeComposeCompletionBlock)completionHandler;

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.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software