cancel(withLocalizableMessageKey:arguments:completionHandler:)

Declaration

func cancel(withLocalizableMessageKey key: String, arguments: [String], completionHandler: (@Sendable ((any Error)?) -> Void)? = nil)

func cancel(withLocalizableMessageKey key: String, arguments: [String]) async throws

Parameters

• key:

  The identifier for looking up the translated cancel message in the default Localized.strings file. If you use a formatted string with specifiers, provide the arguments.

• arguments:

  A list of arguments to substitute into the localized string if it’s formatted and contains specifiers.

• completionHandler:

  The block that GameKit calls when it completes the request.

  The block receives the following parameter:

  error

  Describes an error if it occurs, or nil if the operation completes. An error occurs if you previously cancel this exchange request.

Mentioned in

• Exchanging data between players in turn-based games

Discussion

You can cancel both an active and completed exchange request.

If your game isn’t running or is in the background on recipient devices, a notification containing the localized message you provide appears. When the participant taps or clicks the notification, GameKit launches or brings the game to the foreground and then invokes the player(_:receivedExchangeCancellation:for:) protocol method.