apple.uikit.protocol

Interface UIStateRestoring

All Known Implementing Classes:

ABNewPersonViewController, ABPeoplePickerNavigationController, ABPersonViewController, ABUnknownPersonViewController, ASAccountAuthenticationModificationViewController, ASCredentialProviderViewController, AUViewController, AVPictureInPictureVideoCallViewController, AVPlayerViewController, CABTMIDICentralViewController, CABTMIDILocalPeripheralViewController, CNContactPickerViewController, CNContactViewController, EKCalendarChooser, EKEventEditViewController, EKEventViewController, FPUIActionExtensionViewController, GCEventViewController, GKAchievementViewController, GKFriendRequestComposeViewController, GKGameCenterViewController, GKLeaderboardViewController, GKMatchmakerViewController, GKTurnBasedMatchmakerViewController, GLKViewController, ILClassificationUIExtensionViewController, INUIAddVoiceShortcutViewController, INUIEditVoiceShortcutViewController, MCBrowserViewController, MFMailComposeViewController, MFMessageComposeViewController, MPMediaPickerController, MPMoviePlayerViewController, MSMessagesAppViewController, MSStickerBrowserViewController, PHPickerViewController, PKAddPassesViewController, PKAddPaymentPassViewController, PKAddSecureElementPassViewController, PKPaymentAuthorizationViewController, QLPreviewController, RPBroadcastActivityViewController, RPPreviewViewController, SFSafariViewController, SKCloudServiceSetupViewController, SKStoreProductViewController, SLComposeServiceViewController, SLComposeViewController, STWebpageController, TWTweetComposeViewController, UIActivityViewController, UIAlertController, UICloudSharingController, UICollectionViewController, UIColorPickerViewController, UIDocumentBrowserViewController, UIDocumentMenuViewController, UIDocumentPickerExtensionViewController, UIDocumentPickerViewController, UIFontPickerViewController, UIImagePickerController, UIInputViewController, UINavigationController, UIPageViewController, UIReferenceLibraryViewController, UISearchContainerViewController, UISearchController, UISplitViewController, UITabBarController, UITableViewController, UIVideoEditorController, UIViewController, VNDocumentCameraViewController

public interface UIStateRestoring

Conform to this protocol if you want your objects to participate in state restoration.

To participate in state restoration, the function registerObjectForStateRestoration must be called for the object.

Method Summary

Modifier and Type	Method and Description
default void	applicationFinishedRestoringState() applicationFinishedRestoringState is called on all restored objects that implement the method *after* all other object decoding has been done (including the application delegate).
default void	decodeRestorableStateWithCoder(NSCoder coder)
default void	encodeRestorableStateWithCoder(NSCoder coder) Methods to save and restore state for the object.
default UIObjectRestoration	objectRestorationClass() The restoration class specifies a class which is consulted during restoration to find/create the object, rather than trying to look it up implicitly
default UIStateRestoring	restorationParent() The parent property is used to scope the restoration identifier path for an object, to disambiguate it from other objects that might be using the same identifier.

Method Detail

applicationFinishedRestoringState

default void applicationFinishedRestoringState()

applicationFinishedRestoringState is called on all restored objects that implement the method *after* all other object decoding has been done (including the application delegate). This allows an object to complete setup after state restoration, knowing that all objects from the restoration archive have decoded their state.

decodeRestorableStateWithCoder

default void decodeRestorableStateWithCoder(NSCoder coder)

encodeRestorableStateWithCoder

default void encodeRestorableStateWithCoder(NSCoder coder)

Methods to save and restore state for the object. If these aren't implemented, the object can still be referenced by other objects in state restoration archives, but it won't save/restore any state of its own.

objectRestorationClass

default UIObjectRestoration objectRestorationClass()

The restoration class specifies a class which is consulted during restoration to find/create the object, rather than trying to look it up implicitly

restorationParent

default UIStateRestoring restorationParent()

The parent property is used to scope the restoration identifier path for an object, to disambiguate it from other objects that might be using the same identifier. The parent must be a restorable object or a view controller, else it will be ignored.