Contents

untrashItem(withIdentifier:toParentItemIdentifier:completionHandler:)

Moves an item out of the trash.

Declaration

func untrashItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier, toParentItemIdentifier parentItemIdentifier: NSFileProviderItemIdentifier?, completionHandler: @escaping  @Sendable (NSFileProviderItem?, (any Error)?) -> Void)
func untrashItem(withIdentifier itemIdentifier: NSFileProviderItemIdentifier, toParentItemIdentifier parentItemIdentifier: NSFileProviderItemIdentifier?) async throws -> NSFileProviderItem

Parameters

  • itemIdentifier:

    The item’s persistent identifier.

  • parentItemIdentifier:

    The persistent identifier for the new parent directory, or nil.

  • completionHandler:

    A block that takes the following parameters:

    untrashedItem

    A file provider item that represents the changed item, or nil if an error occurred.

    error

    An error object. If an error occurs, pass in an object that describes the error; otherwise, set it to nil.

Discussion

This method is called when the user removes a document or directory from the trash. Override this method to make any necessary local changes to remove the item from the trash, including updates to the working set. Your implementation should return immediately. Call the completion handler before performing any network activity or other long-running tasks. Defer these tasks to the background. The untrashedItem instance that you pass to the completion handler should match the item’s old file provider item, with only one change: set the item’s isTrashed property to false.

If the parentItemIdentifier parameter is not nil, move the item to the specified parent. Otherwise, return it to its previous location (before being trashed). Undo any other changes that were made when the item was trashed.

The user’s ability to remove an item from the trash is controlled by the new parent directory’s allowsAddingSubItems capability.

See Also

Handling actions