Cancels an exchange.
- iOS 7.0+
- macOS 10.10+
- Mac Catalyst 13.0+Beta
- tvOS 9.0+
- watchOS 3.0+
A string in the Localizable.strings file for the current localization.
An array of objects to be substituted using the format string.
A block to be called after the cancel event has been sent.
The block receives the following parameters:
If an error occurred, this error object describes the error. If the operation was completed successfully, the value is
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.
It is possible to cancel both active and complete exchanges. When an exchange is cancelled, a push notification is sent to each participant using the localizable message. An error is returned if the exchange has previously been cancelled.