ISuspensionHost interface¶

Summary¶

         ISuspensionHost represents a standardized version of the events that the
         host operating system publishes. Subscribe to these events in order to
         handle app suspend / resume.
         

classDiagram
class ISuspensionHost
class IReactiveObject {
    <>
}
IReactiveObject <|.. ISuspensionHost
class INotifyPropertyChanged {
    <>
}
INotifyPropertyChanged <|.. ISuspensionHost
class INotifyPropertyChanging {
    <>
}
INotifyPropertyChanging <|.. ISuspensionHost
class IEnableLogger {
    <>
}
IEnableLogger <|.. ISuspensionHost

Implements: IReactiveObject, INotifyPropertyChanged, INotifyPropertyChanging, IEnableLogger

Remarks¶

These observables abstract platform terms such as "Launching", "Activated", and "Closing" into a consistent API so shared code can persist state without branching on specific UI stacks. Most applications call RxSuspension.SuspensionHost.SetupDefaultSuspendResume() during startup to wire default handlers, but the properties are public so advanced hosts can plug in their own monitoring.

AppState represents the serialized model describing the last running session, while CreateNewAppState can be configured to hydrate a fresh instance when a crash or first launch occurs.

Examples¶

<![CDATA[
 var suspensionHost = RxSuspension.SuspensionHost;
 suspensionHost.CreateNewAppState = () => new ShellState();
 
 suspensionHost.IsLaunchingNew.Subscribe(_ =>
 {
 suspensionHost.AppState = suspensionHost.CreateNewAppState!();
 });
 
 suspensionHost.ShouldPersistState.Subscribe(disposable =>
 {
 storageService.Save((ShellState)suspensionHost.AppState!);
 disposable.Dispose();
 });
 ]]>

Properties¶

Extension members¶

• SuspensionHostExtensions.GetAppState
• SuspensionHostExtensions.ObserveAppState
• SuspensionHostExtensions.SetupDefaultSuspendResume