Changes the app's icon.
- iOS 10.3+
- Mac Catalyst 13.0+
- tvOS 10.2+
The name of the alternate icon, as declared in the
CFBundlekey of your app's
nilif you want to display the app's primary icon, which you declare using the
CFBundlekey. Both keys are subentries of the
CFBundlekey in your app's
A handler to be executed with the results. After attempting to change your app's icon, the system reports the results by calling your handler. (The handler is executed on a UIKit-provided queue, and not necessarily on your app's main queue.) The handler has no return value and takes the following parameter:
On success, the value of this parameter is
nil. If an error occurred, this parameter contains the error object indicating what happened and the value of the
alternateproperty remains unchanged.
Use this method to change your app's icon to its primary icon or to one of its alternate icons. You can change the icon only if the value of the
supports property is
You must declare your app's primary and alternate icons using the
CFBundle key of your app's
Info file. For information about how to configure alternate icons for your app, see the description of the
CFBundle key in Information Property List Key Reference.