Managing Documents In Your ios Apps

Transcription

1 Session #WWDC18 Managing Documents In Your ios Apps 216 Brandon Tennant, Software Engineer Thomas Deniau, Software Engineer Rony Fadel, Software Engineer 2018 Apple Inc. All rights reserved. Redistribution or public display not permitted without written permission from Apple.

2 Document Management on ios What s new? Using the Document Management API Raising the bar

3 Document Management on ios

4 Document Management on ios What is it? API for application developers File provider API for cloud vendors Files app

5

6

7

8

9

10

11

12

13

14

15 Document Management on ios Client API Document Browser UIDocumentBrowserViewController Document Picker UIDocumentPickerViewController File Coordination NSFileCoordinator, UIDocument File Operations NSFileManager Building Great Document-based Apps in ios 11 WWDC 2017

16 Document Management on ios File Provider API File Provider Extension NSFileProviderExtension File Provider Custom Actions FPUIActionExtensionViewController File Provider Enhancements WWDC 2017

17

18

19 Document Management on ios File Provider UI Sign in to your service using FPUIActionExtensionViewController

20 Your Drive Cancel Sign In or username Password Sign In

21 Your Drive Cancel Your Drive Sign In Cancel Sign In or username Password Sign In

22 Cancel Your Drive Sign In

23 Document Management on ios File Provider adoption Great adoption from cloud vendors and application developers Try adopting UIDocumentBrowserViewController or creating a File Provider extension today!

24 What s New?

25 Document Management on ios File Provider Validation tool NEW File Provider Validation tests your FileProvider Extension and guides you to fix the issues

26 Document Management on ios File Provider Validation tool NEW Download includes Source files to add to your project to enable testing An ios app to run on your ipad Modify your File Provider project Install File Provider Validation on your device and launch it

27 Your Drive Your Drive

28 Your Drive

29 Document Management on ios File Provider Siri Shortcuts NEW Surfaces documents that were recently opened or created in Search and the Lock Screen You can also add a shortcut to Siri

30

31

32 Document Management on ios File Provider Siri Shortcuts NEW Add NSFileProviderUsesUniqueItemIdentifiersAcrossDevices to your File Provider Extension s Info.plist Introduction to Siri Shortcuts Hall 2 Tuesday 5:00PM

33 Document Management on ios File Provider Siri Shortcuts NEW Add NSFileProviderUsesUniqueItemIdentifiersAcrossDevices to your File Provider Extension s Info.plist Introduction to Siri Shortcuts Hall 2 Tuesday 5:00PM

34 Document Management on ios Particles sample app NEW

35 NEW

36 Document Management on ios Particles sample app NEW

37 Document Management on ios Particles sample app NEW Main UI is a UIDocumentBrowserViewController

38 Document Management on ios Particles sample app NEW Main UI is a UIDocumentBrowserViewController Defines a file format

39 Document Management on ios Particles sample app NEW Main UI is a UIDocumentBrowserViewController Defines a file format Implements state restoration

40 Document Management on ios Particles sample app NEW Main UI is a UIDocumentBrowserViewController Defines a file format Implements state restoration Import assets using UIDocumentPickerViewController

41 Document Management on ios Particles sample app NEW Main UI is a UIDocumentBrowserViewController Defines a file format Implements state restoration Import assets using UIDocumentPickerViewController Available at

42 Interacting with Documents in Your App Thomas Deniau, Software Engineer

43 Document picker and document browser

44 Document picker and document browser Demo add a document picker to an existing app

45 Document picker and document browser Demo add a document picker to an existing app Document types

46 Interacting with Documents What does it mean?

47 Interacting with Documents What does it mean? Providing UI to let your customers organize their documents Your app

48 Interacting with Documents What does it mean? Providing UI to let your customers organize their documents Accessing documents stored in the cloud Your app Cloud services

49 Interacting with Documents What does it mean? Providing UI to let your customers organize their documents Accessing documents stored in the cloud Your app Accessing documents from another app Other apps containers Cloud services

50 Document Picker vs Document Browser Document Picker Document Browser

51 Document Picker vs Document Browser Document Picker Document Browser Browse local and cloud storage

52 Document Picker vs Document Browser Document Picker Document Browser Browse local and cloud storage Access files from other apps

53 Document Picker vs Document Browser Document Picker Document Browser Browse local and cloud storage Access files from other apps Use case Quick User Action Main document browsing UI of your app

54 Document Browser Main document browsing UI of a document-based application

55

56 UIDocumentBrowserViewController Starting point of your app

57 UIDocumentBrowserViewController Starting point of your app Full screen

58 UIDocumentBrowserViewController Starting point of your app Full screen Open and organize your documents

59 UIDocumentBrowserViewController Starting point of your app Full screen Open and organize your documents All the features of the Files App

60 UIDocumentBrowserViewController Starting point of your app Full screen Open and organize your documents All the features of the Files App Can be customized

61 UIDocumentBrowserViewController Starting point of your app Full screen Open and organize your documents All the features of the Files App Can be customized With your own buttons

62 UIDocumentBrowserViewController Starting point of your app Full screen Open and organize your documents All the features of the Files App Can be customized With your own buttons To match your app s look

63 UIDocumentBrowserViewController Starting point of your app Full screen Open and organize your documents All the features of the Files App Can be customized With your own buttons To match your app s look Present your own UI on top

64 UIDocumentBrowserViewController The Document Browser is the entry point of your app Best practice is to make it the root view controller

65 UIDocumentBrowserViewController The Document Browser is the entry point of your app Best practice is to make it the root view controller Can also be presented full screen

66 UIDocumentBrowserViewController Getting started

67 UIDocumentBrowserViewController Getting started

68 UIDocumentBrowserViewController Getting started

69 UIDocumentBrowserViewController Customization

70 UIDocumentBrowserViewController Customization Add your own buttons

71 UIDocumentBrowserViewController Customization Add your own buttons Set colors and themes

72 UIDocumentBrowserViewController Customization Add your own buttons Set colors and themes Customize the open/close document animations

73 UIDocumentBrowserViewController Customization Add your own buttons Set colors and themes Customize the open/close document animations Building Great Document-based Apps in ios 11 WWDC 2017

74 UIDocumentBrowserViewController Customization Add your own buttons Set colors and themes Customize the open/close document animations Sample code available Building Great Document-based Apps in ios 11 WWDC 2017

75 Document Picker Open an asset stored in the cloud or in another app

76

77

78

79

80

81

82

83 UIDocumentPickerViewController Documents might be in multiple locations Your container

84 UIDocumentPickerViewController Documents might be in multiple locations Your container Other apps containers Cloud services

85 UIDocumentPickerViewController Documents might be in multiple locations Your container Other apps containers Cloud services

86 UIDocumentPickerViewController Documents might be in multiple locations Access / copy / move documents Your container Other apps containers Cloud services

87 UIDocumentPickerViewController Documents might be in multiple locations Access / copy / move documents Your container Other apps containers Cloud services

88 UIDocumentPickerViewController Documents might be in multiple locations Access / copy / move documents Quick user action Your container Other apps containers Cloud services

89 UIDocumentPickerViewController Your container Use a document picker to Other apps containers Cloud services

90 UIDocumentPickerViewController Your container Use a document picker to Access files in the cloud (.open) Other apps containers Cloud services

91 UIDocumentPickerViewController Your container Use a document picker to Access files in the cloud (.open) Move files to the cloud (.movetoservice) Other apps containers Cloud services

92 UIDocumentPickerViewController Your container Use a document picker to Access files in the cloud (.open) Move files to the cloud (.movetoservice) Copy from/to the cloud (.import,.exporttoservice) Other apps containers Cloud services

93 Example Access a Video from the Cloud Create a UIDocumentPickerViewController and present it let picker = UIDocumentPickerViewController(documentTypes: [kuttypevideo as String], in:.open) picker.delegate = self self.present(picker, animated: true) Get the selected file URL override func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL]) { // use the retrieved URLs }

94 Example Access a Video from the Cloud Create a UIDocumentPickerViewController and present it let picker = UIDocumentPickerViewController(documentTypes: [kuttypevideo as String], in:.open) picker.delegate = self self.present(picker, animated: true) Get the selected file URL override func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL]) { // use the retrieved URLs }

95 Example Access a Video from the Cloud Create a UIDocumentPickerViewController and present it let picker = UIDocumentPickerViewController(documentTypes: [kuttypevideo as String], in:.open) picker.delegate = self self.present(picker, animated: true) Get the selected file URL override func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL]) { // use the retrieved URLs }

96 Example Access a Video from the Cloud Create a UIDocumentPickerViewController and present it let picker = UIDocumentPickerViewController(documentTypes: [kuttypevideo as String], in:.open) picker.delegate = self self.present(picker, animated: true) Get the selected file URL override func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL]) { // use the retrieved URLs }

97 Example Access a Video from the Cloud Create a UIDocumentPickerViewController and present it let picker = UIDocumentPickerViewController(documentTypes: [kuttypevideo as String], in:.open) picker.delegate = self self.present(picker, animated: true) Get the selected file URL override func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL]) { // use the retrieved URLs }

98 Demo

99 Document Types Document Types let the system know which files your application handles

100 Document Types

101 Document Types Important! They let ios

102 Document Types Important! They let ios open your app when a file is tapped in the Files app

103 Document Types Important! They let ios open your app when a file is tapped in the Files app show your app in the Share Sheet

104 Document Types Important! They let ios open your app when a file is tapped in the Files app show your app in the Share Sheet use the proper icon for your documents

105

106

107 Document Types Two steps Declaring the type if it is not already declared by ios Claiming that you can view or edit files of this type

108 Declaring a Type Do you need to declare it?

109 Declaring a Type Do you need to declare it? Standard file type

110 Declaring a Type Do you need to declare it? Standard file type Already declared by ios?

111 Declaring a Type Do you need to declare it? Standard file type Already declared by ios? DeclaredUniformTypeIdentifiers.html

112 Declaring a Type Do you need to declare it? Standard file type Already declared by ios? Yes Nothing to do DeclaredUniformTypeIdentifiers.html

113 Declaring a Type Do you need to declare it? Standard file type Already declared Your own file type by ios? Yes Nothing to do Declare as exported DeclaredUniformTypeIdentifiers.html

114 Declaring a New File Type Info.plist Use the Xcode UI

115 Declaring a New File Type A type definition is An identifier (UTTypeIdentifier)

116 Declaring a New File Type A type definition is An identifier (UTTypeIdentifier)

117 Declaring a New File Type A type definition is Parent types (the type conforms to them) (UTTypeConformsTo)

118 Declaring a New File Type A type definition is Parent types (the type conforms to them) (UTTypeConformsTo)

119 Type Conformance Types form a tree

120 Type Conformance Types form a tree public.jpeg

121 Type Conformance Types form a tree public.jpeg public.heif-standard

122 Type Conformance Types form a tree public.image public.jpeg public.heif-standard

123 Type Conformance Types form a tree public.content public.image public.jpeg public.heif-standard

124 Type Conformance Types form a tree public.content public.spreadsheet public.image public.jpeg public.heif-standard

125 Type Conformance Types form a tree public.content public.spreadsheet public.image com.example.particles public.jpeg public.heif-standard

126 Type Conformance Types form a tree public.content public.spreadsheet public.image com.example.particles public.jpeg public.heif-standard

127 Type Conformance Second tree to describe the on-disk format public.content particles

128 Type Conformance Second tree to describe the on-disk format public.content public.data Single file on disk particles

129 Type Conformance Second tree to describe the on-disk format public.data com.apple.package public.content Single file on disk File package particles

130 Type Conformance Second tree to describe the on-disk format public.data com.apple.package public.content Single file on disk File package particles

131 Type Conformance public.item Root type Second tree to describe the on-disk format public.data com.apple.package public.content Single file on disk File package particles

132 Declaring a New File Type My type conforms to public.data, public.content

133 Declaring a New File Type My type conforms to public.data, public.content

134 Declaring a New File Type Declaring a file extension (UTTypeTagSpecification) Files with the.particles extension are of this type

135 Declaring a New File Type Declaring a file extension (UTTypeTagSpecification) Files with the.particles extension are of this type

136 Declaration done!

137 Declaring a Type Do you need to declare it? Standard file type Already declared Your own file type by ios? Yes Nothing to do Declare as exported

138 Declaring a Type Do you need to declare it? Standard file type Already declared Your own file type by ios? Yes Nothing to do Declare as exported

139 Declaring a Type Do you need to declare it? Standard file type Already declared by ios? Owned by another app Your own file type Yes Nothing to do Declare as exported

140 Declaring a Type Do you need to declare it? Standard file type Already declared by ios? Owned by another app Your own file type Yes Nothing to do Declare as imported Declare as exported

141 Declaring a Type Do you need to declare it? Standard file type Already declared by ios? Owned by another app Your own file type Yes No Nothing to do Declare as imported Declare as exported

142 Claiming Support for a Type Once the type is defined, you need to claim support for it in Info.plist

143 Claiming Support for a Type Type identifier defined previously

144 Claiming Support for a Type Type identifier defined previously

145 Claiming Support for a Type Handler Rank

146 Claiming Support for a Type Handler Rank

147 Claiming Support for a Type Handler Rank Three choices

148 Claiming Support for a Type Handler Rank Three choices Owner if you own this type

149 Claiming Support for a Type Handler Rank Three choices Owner if you own this type Default if you can edit this type

150 Claiming Support for a Type Handler Rank Three choices Owner if you own this type Default if you can edit this type Alternate if you can read it

151 Claiming Support for a Type Handler Rank Three choices Owner if you own this type Default if you can edit this type Alternate if you can read it Rules are different on macos

152 Claiming Support for a Type Be as specific as possible Don't claim support for catch-alls like public.data or public.content

153 What Can You Do?

154 What Can You Do? Use a Document Browser or Document Picker to access documents

155 What Can You Do? Use a Document Browser or Document Picker to access documents Your customers can access their favorite cloud vendor

156 What Can You Do? Use a Document Browser or Document Picker to access documents Your customers can access their favorite cloud vendor Consider using UIDocumentBrowserViewController instead of your custom browser

157 What Can You Do? Use a Document Browser or Document Picker to access documents Your customers can access their favorite cloud vendor Consider using UIDocumentBrowserViewController instead of your custom browser Configure the Document Types supported by your app in Xcode

158 Raising the Bar Rony Fadel, Software Engineer

159

160

161 Your App and the Sandbox // MARK: UIDocumentBrowserViewControllerDelegate func documentbrowser(_ controller: UIDocumentBrowserViewController, didpickdocumenturls documenturls: [URL]) // MARK: UIDocumentPickerDelegate func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL])

162 Your App and the Sandbox // MARK: UIDocumentBrowserViewControllerDelegate func documentbrowser(_ controller: UIDocumentBrowserViewController, didpickdocumenturls documenturls: [URL]) // MARK: UIDocumentPickerDelegate func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL])

163 Your App and the Sandbox // MARK: UIDocumentBrowserViewControllerDelegate func documentbrowser(_ controller: UIDocumentBrowserViewController, didpickdocumenturls documenturls: [URL]) // MARK: UIDocumentPickerDelegate func documentpicker(_ controller: UIDocumentPickerViewController, didpickdocumentsat urls: [URL])

164 Your App and the Sandbox Document Picker Your App URL

165 Your App and the Sandbox URL Your App

166 Your App and the Sandbox URL Your App Error Domain=NSCocoaErrorDomain Code=257 "The file <filename> couldn t be opened because you don t have permission to view it." UserInfo={NSFilePath=<path-todocument>, NSUnderlyingError=0xFFFFFFFFF {Error Domain=NSPOSIXErrorDomain Code=1 "Operation not permitted"}}

167 Your App and the Sandbox App Container Your App Other App Cloud Service Container App Container Cloud Service

168 Your App and the Sandbox App Container Your App Other App Unrestricted access Cloud Service Container App Container Cloud Service

169 Your App and the Sandbox App Container Your App Restricted access Other App Unrestricted access Cloud Service Container App Container Cloud Service

170 Your App and the Sandbox Your App App Container Restricted Unrestricted access access App Container Other App

171 Your App and the Sandbox Your App URL App Container Restricted Unrestricted access access App Container Other App

172 Your App and the Sandbox Security URL URLscoped Your App resource App Container Restricted Unrestricted access access App Container Other App

173 Your App and the Sandbox Security URL URLscoped Your App resource App Container Restricted Unrestricted access access App Container Other App func startaccessingsecurityscopedresource() -> Bool func stopaccessingsecurityscopedresource()

174 Your App and the Sandbox Security URL URLscoped Your App resource App Container Access Unrestricted granted access App Container Other App func startaccessingsecurityscopedresource() -> Bool func stopaccessingsecurityscopedresource()

175 Your App and the Sandbox Security URL URLscoped Your App resource App Container Restricted Unrestricted access access App Container Other App func startaccessingsecurityscopedresource() -> Bool func stopaccessingsecurityscopedresource()

176 Your App and the Sandbox

177 Your App and the Sandbox let didstartaccessing = url.startaccessingsecurityscopedresource() defer { if didstartaccessing { url.stopaccessingsecurityscopedresource() } } // do something with URL

178 Your App and the Sandbox let didstartaccessing = url.startaccessingsecurityscopedresource() defer { if didstartaccessing { url.stopaccessingsecurityscopedresource() } } // do something with URL

179 Your App and the Sandbox let didstartaccessing = url.startaccessingsecurityscopedresource() defer { if didstartaccessing { url.stopaccessingsecurityscopedresource() } } // do something with URL

180 Your App and the Sandbox let didstartaccessing = url.startaccessingsecurityscopedresource() defer { if didstartaccessing { url.stopaccessingsecurityscopedresource() } } // do something with URL Balance start/stopaccessing calls

181 Your App and the Sandbox let didstartaccessing = url.startaccessingsecurityscopedresource() defer { if didstartaccessing { url.stopaccessingsecurityscopedresource() } } // do something with URL Balance start/stopaccessing calls Only call stopaccessing if startaccessing returns true

182 Your App and the Sandbox let didstartaccessing = url.startaccessingsecurityscopedresource() defer { if didstartaccessing { url.stopaccessingsecurityscopedresource() } } // do something with URL Balance start/stopaccessing calls Only call stopaccessing if startaccessing returns true Keep resource access time as small as possible

183 Your App and the Sandbox let didstartaccessing = url.startaccessingsecurityscopedresource() defer { if didstartaccessing { url.stopaccessingsecurityscopedresource() } } // do something with URL Balance start/stopaccessing calls Only call stopaccessing if startaccessing returns true Keep resource access time as small as possible When in doubt, call these APIs

184 Coordinating File Access Your App Other App Cloud Service Container Cloud Service

185 Coordinating File Access Your App Other App Cloud Service Container Cloud Service

186 Coordinating File Access Your App Other App Cloud Service Container Cloud Service

187 Coordinating File Access

188 Coordinating File Access File Coordination NSFileCoordinator and NSFilePresenter

189 Coordinating File Access File Coordination NSFileCoordinator and NSFilePresenter System-wide multiple reader/single writer lock

190 Coordinating File Access File Coordination NSFileCoordinator and NSFilePresenter System-wide multiple reader/single writer lock Instructs the system to download the document

191 Make My Life Simpler! UIDocument

192 Make My Life Simpler! UIDocument Available since ios 5

193 Make My Life Simpler! UIDocument Available since ios 5 Recommended way for displaying and editing your documents

194 Make My Life Simpler! UIDocument Available since ios 5 Recommended way for displaying and editing your documents No need to call start/stopaccessingsecurityscopedresource

195 Make My Life Simpler! UIDocument Available since ios 5 Recommended way for displaying and editing your documents No need to call start/stopaccessingsecurityscopedresource Handles file coordination for you

196 Make My Life Simpler! UIDocument Available since ios 5 Recommended way for displaying and editing your documents No need to call start/stopaccessingsecurityscopedresource Handles file coordination for you Building Document Based Apps WWDC 2015

197

198

199 Your App Foreground

200 Your App Foreground Background

201 Your App Foreground Background Suspended

202 Your App Memory Pressure Foreground Background Suspended Terminated

203 Your App Memory Pressure Foreground Background Suspended Terminated Relaunched

204 Your App Memory Pressure Foreground Background Suspended Terminated Relaunched Restore the UI State

205 State Restoration How do we implement it? URL Cloud Service Container Cloud Service

206 State Restoration How do we implement it? URL Cloud Service Container Cloud Service

207 State Restoration How do we implement it? URL Cloud Service Container Cloud Service

208 State Restoration How do we implement it? URL Cloud Service Container Cloud Service Document could have been moved or renamed

209 State Restoration How do we implement it? URL Cloud Service Container Cloud Service Document could have been moved or renamed URL loses security scope when encoded

210 State Restoration How do we implement it? Bookmark Cloud Service Container Cloud Service

211 State Restoration How do we implement it? Bookmark Cloud Service Container Cloud Service

212 State Restoration How do we implement it? // Save security scoped bookmark let bookmarkdata = try? url.bookmarkdata() // Restore security scoped bookmark var bookmarkdataisstale = false let documenturl = try? URL(resolvingBookmarkData: bookmarkdata, bookmarkdataisstale: &bookmarkdataisstale)

213 State Restoration How do we implement it? // Save security scoped bookmark let bookmarkdata = try? url.bookmarkdata() // Restore security scoped bookmark var bookmarkdataisstale = false let documenturl = try? URL(resolvingBookmarkData: bookmarkdata, bookmarkdataisstale: &bookmarkdataisstale)

214 State Restoration How do we implement it? // Save security scoped bookmark let bookmarkdata = try? url.bookmarkdata() // Restore security scoped bookmark var bookmarkdataisstale = false let documenturl = try? URL(resolvingBookmarkData: bookmarkdata, bookmarkdataisstale: &bookmarkdataisstale)

215 Demo

216 Copy to

217 Copy to

218

219 Open in place

220 Open in place

221 Open In Place Adoption

222 Open In Place Adoption Already enabled in "Document Based App" template

223 Open In Place Adoption Already enabled in "Document Based App" template Add LSSupportsOpeningDocumentsInPlace key to Info.plist

224 Open In Place Adoption

225 Open In Place Adoption func application(_ app: UIApplication, open inputurl: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool

226 Open In Place Adoption func application(_ app: UIApplication, open inputurl: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool Document Browser based apps func revealdocument(at url: URL, importifneeded: Bool, completion: ((URL?, Error?) -> Void)? = nil) // Present the document in the completion handler

227

228 Progress reporting

229 Progress reporting Support cancellation

230 Open In Place Progress reporting

231 Open In Place Progress reporting Free when you call revealdocument on UIDocumentBrowserViewController

232 Open In Place Progress reporting Free when you call revealdocument on UIDocumentBrowserViewController UIDocument conforms to ProgressReporting extension UIDocument: ProgressReporting { } var progress: Progress? { get }

233 Open In Place Progress reporting Free when you call revealdocument on UIDocumentBrowserViewController UIDocument conforms to ProgressReporting extension UIDocument: ProgressReporting { } var progress: Progress? { get }

234 Ship it!

235 Raising the Bar

236 Raising the Bar Adopt UIDocument

237 Raising the Bar Adopt UIDocument Adopt start/stopaccessing best practices

238 Raising the Bar Adopt UIDocument Adopt start/stopaccessing best practices Coordinate file access

239 Raising the Bar Adopt UIDocument Adopt start/stopaccessing best practices Coordinate file access Implement state restoration

240 Raising the Bar Adopt UIDocument Adopt start/stopaccessing best practices Coordinate file access Implement state restoration Implement Open In Place and report progress

241 Summary

242 Summary What did we see today?

243 Summary What did we see today? Document browser and document picker

244 Summary What did we see today? Document browser and document picker Raising the bar

245 Summary What did we see today? Document browser and document picker Raising the bar Siri Shortcuts

246 Summary What did we see today? Document browser and document picker Raising the bar Siri Shortcuts FileProvider and FileProviderUI

247 More Information Introduction to Siri Shortcuts WWDC 2018

248