UIDocumentInteractionController — ano ito, Open In at mga dokumento

Ano ang UIDocumentInteractionController?

UIDocumentInteractionController — ay isang klase ng UIKit na nagbibigay ng system interface para sa pagtatrabaho sa mga dokumento. Hindi tulad ng UIDocumentPickerViewController na pumipili ng mga file, ang controller na ito ay gumagana sa isang umiiral nang file ng app at nag-aalok ng mga aksyon sa user: preview, buksan sa ibang app, i-print, o ipadala.

Ang controller ay hindi ViewController — hindi ito tinatawag sa pamamagitan ng present. Sa halip, nagpapakita ito ng system action menu sa pamamagitan ng method na presentOptionsMenu o presentPreview. Ipinapakita ng menu ang lahat ng app na nakarehistro para sa pagproseso ng ganitong uri ng file.

Ang UIDocumentInteractionController ay available mula noong iOS 2.0 at isa sa mga pinakalumang API para sa pagtatrabaho sa mga dokumento. Sa kabila ng edad nito, nananatiling may kaugnayan para sa pagpapatupad ng function na Open In at built-in na preview nang hindi gumagamit ng mga third-party na library.

Mode Preview: built-in na viewer ng dokumento

Preview — ay isang built-in na viewer ng dokumento na ibinibigay ng UIDocumentInteractionController. Sinusuportahan nito ang PDF, mga larawan, text file, at mga dokumento sa opisina (kabilang ang .doc, .xls, .ppt). Ipinapakita ang Preview na may transition animation na katulad ng standard na Quick Look.

Para simulan ang Preview, tawagan ang method na presentPreview. Ang controller ay nangangailangan ng delegate na may implementasyon ng method na previewControllerForDocumentInteractionController, na nagbabalik ng UIViewController para sa pagpapakita ng dokumento. Karaniwang nagbabalik ng self o navigation controller.

Ang built-in na Preview ay hindi nangangailangan ng mga karagdagang framework o lisensya. Gumagana ito sa anumang file na ang URL ay naipasa sa property na url. Maaaring i-flip ng user ang mga pahina ng PDF, i-scale ang mga larawan, at kopyahin ang text mula sa mga dokumento.

Mode Open In: paglilipat ng file sa pagitan ng mga app

Open In — ang pangunahing function ng UIDocumentInteractionController. Ipinapakita nito ang listahan ng mga app na maaaring magbukas ng ganitong uri ng file. Pinipili ng user ang target na app, at kinokopya ng iOS ang file sa sandbox nito, inilulunsad ang app para sa pagtatrabaho sa dokumento.

Ang listahan ng mga app ay awtomatikong nabubuo batay sa nakarehistrong Document Type sa Info.plist ng ibang mga app. Kung ang isang app ay nagrehistro ng suporta para sa PDF, lalabas ito sa menu ng Open In para sa mga PDF file. Ipinapakita rin ng system ang mga standard na aksyon: i-print, ipadala sa email, i-save sa Files.

Ang Open In ay kinokopya ang file — ang target na app ay tumatanggap ng sarili nitong kopya, kaya ang mga pagbabago ay hindi nai-save pabalik sa orihinal na app. Kung kinakailangan ang pag-edit na may pag-save, gamitin ang UIDocumentPickerViewController sa export mode na may security-scoped na URL.

Pagsasaayos ng UIActivityViewController bilang alternatibo

Mula noong iOS 6, available ang UIActivityViewController, na sumusuporta din sa pagpapadala ng file. Hindi tulad ng UIDocumentInteractionController, ang UIActivityViewController ay nagpapakita ng system action sheet na may suporta para sa AirDrop, email, mensahe, at custom na UIActivity. Para sa simpleng pagpapadala ng file, inirerekomenda ang UIActivityViewController bilang mas modernong API.

Halimbawa ng code: Open In sa Swift

Ang implementasyon ng Open In sa pamamagitan ng UIDocumentInteractionController ay nangangailangan lamang ng ilang linya ng code: gumawa ng instance, itakda ang URL at delegate, tawagan ang presentOptionsMenu. Awtomatikong kinokolekta ng controller ang listahan ng mga available na app batay sa uri ng file.

class DocumentViewController: UIViewController {

    lazy var interactionController = UIDocumentInteractionController()

    func shareFile(url: URL) {
        interactionController.url = url
        interactionController.uti = url.utiType()
        interactionController.delegate = self
        interactionController.presentOptionsMenu(
            from: self.view.bounds,
            in: self.view,
            animated: true
        )
    }
}

Pagsisimula ng Preview sa halip ng menu

Para ipakita ang built-in na viewer sa halip ng menu ng Open In, gamitin ang method na presentPreview. Ipapakita ng controller ang dokumento sa buong screen na may kakayahang mag-flip. Ang delegate ay dapat magpatupad ng method na previewControllerForDocumentInteractionController na nagbabalik ng UIViewController para sa pagpapakita.

UIDocumentInteractionControllerDelegate at lifecycle

UIDocumentInteractionControllerDelegate namamahala ng pagpapakita at pagtatago ng menu at Preview. Ang delegate ay nagpapatupad ng mga opsyonal na method: documentInteractionControllerWillPresentOpenInMenu para sa animation ng paglitaw, documentInteractionControllerDidDismissOpenInMenu para sa paglilinis ng resources pagkatapos isara ang menu.

Mahalagang method para sa Preview — previewControllerForDocumentInteractionController, na dapat magbalik ng UIViewController para sa pagpapakita ng dokumento. Kung ang method ay hindi naipatupad o nagbalik ng nil, hindi magsisimula ang Preview. Karaniwang nagbabalik ng self o UINavigationController na naglalaman ng self.

Sinusuportahan din ng controller ang method na documentInteractionController:didEndSendingToApplication, na tinatawag pagkatapos ng matagumpay na paglipat ng file sa ibang app. Pinapayagan nito ang paglilinis ng pansamantalang file o pag-update ng interface pagkatapos bumalik sa app.

Mga pagkakaiba sa UIDocumentPickerViewController

UIDocumentInteractionController at UIDocumentPickerViewController ay lumulutas ng magkakaibang gawain, bagaman pareho silang gumagana sa mga dokumento. Ang pangunahing pagkakaiba: ang UIDocumentInteractionController ay naglilipat ng umiiral na file sa ibang app, habang ang UIDocumentPickerViewController ay pumipili ng file mula sa panlabas na source para sa kasalukuyang app.

Ang UIDocumentInteractionController ay hindi nangangailangan ng delegate para sa pangunahing trabaho — lalabas ang menu kahit walang implementasyon ng mga method. Ang UIDocumentPickerViewController na walang delegate ay walang silbi — hindi mapoproseso ang resulta ng pagpili. Ang pagpili ng API ay depende sa senaryo: pagpapadala ng file → UIDocumentInteractionController, pagtanggap ng file → UIDocumentPickerViewController.