setTaskCompleted(restoredDefaultState:estimatedSnapshotExpiration:userInfo:)

Declaration

func setTaskCompleted(restoredDefaultState: Bool, estimatedSnapshotExpiration: Date?, userInfo: (any NSSecureCoding & NSObjectProtocol)?)

Parameters

• restoredDefaultState:

  Pass True if your app has navigated back to its default launch scene.

• estimatedSnapshotExpiration:

  The preferred date and time for the next background snapshot refresh task. Use Distantfuture if you do not want to schedule the next refresh.

• userInfo:

  Custom data to be associated with the next background snapshot refresh task. This value is assigned to the next Wksnapshotrefreshbackgroundtask object’s Userinfo property. Pass nil if you don’t want to associate any data with the next task.

Discussion

Call this method as soon as your app finishes updating its user interface. The system provides your extension with a limited amount of time (on the order of seconds) to finish the background snapshot refresh task. If you do not call setTaskCompleted(restoredDefaultState:estimatedSnapshotExpiration:userInfo:) on the task, the system uses all available time, wasting battery power. The system then suspends the extension as soon as the allotted time has expired.

The system automatically takes a snapshot of your app’s user interface as soon as this task is complete. The system also suspends the extension as soon as all background tasks are complete.