Instance Method

importDocument(at:nextToDocumentAt:mode:completionHandler:)

Imports a document into the same location as an existing document.

Declaration

func importDocument(at documentURL: URL, nextToDocumentAt neighbourURL: URL, mode importMode: UIDocumentBrowserViewController.ImportMode, completionHandler completion: @escaping (URL?, Error?) -> Void)

Parameters

documentURL

The URL of the document's initial location.

neighborURL

The URL of a document that is already managed by a file provider (the local file provider, the iCloud file provider, or a third-party file provider). The system imports the document into the same file provider and directory as this URL.

importMode

The mode used when importing the document. For a list of import modes, see UIDocumentBrowserViewController.ImportMode.

completionHandler
importedDocumentURL

The URL of the newly imported document, or nil if an error occurred.

error

An object that describes the error, if one occurred; otherwise, it is set to nil.

Discussion

Use this method to import a document into the same file provider and directory as an existing document.

For example, to duplicate a document that's already managed by a file provider:

  1. Create a duplicate of the original file in the user's temporary directory. Be sure to give it a unique name.

  2. Call importDocument(at:nextToDocumentAt:mode:completionHandler:), passing in the temporary file's URL as the documentURL parameter and the original file's URL as the neighborURL parameter.

The system imports the duplicate into the same file provider (the local file provider, the iCloud file provider, or a third-party file provider) and the same directory as the original file.

See Also

Responding to Browser Events

protocol UIDocumentBrowserViewControllerDelegate

The protocol you implement to respond as the user interacts with the document browser.