Overloads
4 ways to call compose().task(). Each is one SwiftUI overload, picked by the arguments you pass.
compose().task<T>({
id: T,
name?: string | null,
executorPreference: SwiftUnsupported<'TaskExecutor'>,
priority?: 'high' | 'medium' | 'low' | 'background' | 'userInitiated' | 'utility',
file?: string,
line?: number,
action: () => void,
})nonisolated func task<T>(
id: T,
name: String? = nil,
executorPreference taskExecutor: any TaskExecutor,
priority: TaskPriority = .userInitiated,
file: String = #fileID,
line: Int = #line,
_ action: sending @escaping @isolated(any) () async -> Void
) -> some View
where T : EquatableParameters
options.id*TThe value to observe for changes. The value must conform to the doc://com.apple.documentation/documentation/Swift/Equatable protocol.
options.namestring | nullHuman readable name for the task. A name will be generated if this argument is
nil.options.executorPreference*SwiftUnsupported<'TaskExecutor'>options.priority'high' | 'medium' | 'low' | 'background' | 'userInitiated' | 'utility'The task priority to use when creating the asynchronous task. The default priority is doc://com.apple.documentation/documentation/Swift/TaskPriority/userInitiated.
options.filestringFile name used in default task name. SwiftUI uses the callsite of .task by default.
options.linenumberLine number used in default task name. SwiftUI uses the callsite of .task by default.
options.action*() => voidA closure that SwiftUI calls as an asynchronous task before the view appears. SwiftUI can automatically cancel the task after the view disappears before the action completes. If the
idvalue changes, SwiftUI cancels and restarts the task.
Return value
A view that runs the specified action asynchronously before the view appears, or restarts the task when the id value changes.
Discussion
This method behaves like View.task(priority:_:), except that it also
cancels and recreates the task when a specified value changes. To detect
a change, the modifier tests whether a new value for the id parameter
equals the previous value. For this to work,
the value's type must conform to the
doc://com.apple.documentation/documentation/Swift/Equatable protocol.
For example, if you define an equatable Server type that posts custom
notifications whenever its state changes --- for example, from signed
out to signed in --- you can use the task modifier to update
the contents of a Text view to reflect the state of the
currently selected server:
Text(status ?? "Signed Out")
.task(id: server) {
let sequence = NotificationCenter.default.notifications(
named: .didUpdateStatus,
object: server
).compactMap {
$0.userInfo?["status"] as? String
}
for await value in sequence {
status = value
}
}This example uses the doc://com.apple.documentation/documentation/Foundation/NotificationCenter/notifications(named:object:) method to create an asynchronous sequence of notifications, given by an doc://com.apple.documentation/documentation/Swift/AsyncSequence instance. The example then maps the notification sequence to a sequence of strings that correspond to values stored with each notification.
Elsewhere, the server defines a custom didUpdateStatus notification:
extension NSNotification.Name {
static var didUpdateStatus: NSNotification.Name {
NSNotification.Name("didUpdateStatus")
}
}Whenever the server status changes, like after the user signs in, the server posts a notification of this custom type:
let notification = Notification(
name: .didUpdateStatus,
object: self,
userInfo: ["status": "Signed In"])
NotificationCenter.default.post(notification)The task attached to the Text view gets and displays the status
value from the notification's user information dictionary. When the user
chooses a different server, SwiftUI cancels the task and creates a new
one, which then waits for notifications from the new server.
See also
More in Events and lifecycle.
- onAppearAdds an action to perform before this view appears.
- onChangeAdds a modifier for this view that fires an action when a specific value changes.
- onContinueUserActivityRegisters a handler to invoke in response to a user activity that your app receives.
- onContinuousHoverAdds an action to perform when the pointer enters, moves within, and exits the view's bounds.
- onDisappearAdds an action to perform after this view disappears.
- onDragActivates this view as the source of a drag and drop operation.
- onDragSessionUpdatedSpecifies an action to perform on each update of an ongoing dragging operation activated by draggable(:) or anther drag modifiers.
- onDropDefines the destination of a drag and drop operation that handles the dropped content with a closure that you specify.
- onDropSessionUpdatedSpecifies an action to perform on each update of an ongoing drop operation activated by dropDestination(:) or other drop modifiers.
- onGeometryChangeAdds an action to be performed when a value, created from a geometry proxy, changes.
- onHingeChangeAdds an action to perform when the hinge context of the view hierarchy changes.
- onHoverAdds an action to perform when the user moves the pointer over or away from the view's frame.