iCloud drive undertaking setup tutorial

Let’s begin by creating a brand new undertaking for iOS. You possibly can choose the one view utility template, don’t fret an excessive amount of about doc based mostly apps, as a result of on this tutorial we’re not going to the touch the UIDocument class in any respect. 🤷‍♂️

Step one is to allow iCloud capabilities, which is able to generate a brand new entitlements file for you. Additionally you will must allow the iCloud utility service for the app id on the Apple developer portal. You also needs to assign the iCloud container that is going for use to retailer information. Just some clicks, however you must do that manually. 💩

You want a sound Apple Developer Program membership with the intention to set superior app capabilities like iCloud assist. So you must pay $99/yr. #greed 🤑

So I imagine that now you may have a correct iOS app identifier with iCloud capabilities and utility providers enabled. One final step is forward, you must add these few strains to your Data.plist file with the intention to outline the iCloud drive container (folder identify) that you will use. Word that you may have a number of containers for one app.

<key>NSUbiquitousContainers</key>
<dict>
    <key>iCloud.com.tiborbodecs.teszt</key>
    <dict>
        <key>NSUbiquitousContainerIsDocumentScopePublic</key>
        <true/>
        <key>NSUbiquitousContainerName</key>
        <string>Teszt</string>
        <key>NSUbiquitousContainerSupportedFolderLevels</key>
        <string>Any</string>
    </dict>
</dict>

Lastly we’re prepared to maneuver ahead with some precise coding. 💻

Information inside iCloud drive containers

Working with iCloud recordsdata utilizing Swift is comparatively straightforward. Principally you simply must get the bottom URL of your iCloud drive container, and you are able to do no matter you need. 🤔 Nonetheless I will present you some finest practices & tips.

First you must verify in case your container folder already exists, if not you need to create it by hand utilizing the FileManager class. I’ve additionally made a “shortcut” variable for the container base URL, so I haven’t got to put in writing all these lengthy phrases once more. 😅

var containerUrl: URL? {
    FileManager.default.url(
        forUbiquityContainerIdentifier: nil
    )?.appendingPathComponent("Paperwork")
}

if 
    let url = self.containerUrl, 
    !FileManager.default.fileExists(
        atPath: url.path, 
        isDirectory: nil
    ) {
    do {
        attempt FileManager.default.createDirectory(
            at: url, withIntermediateDirectories: true, 
            attributes: nil
        )
    }
    catch {
        print(error.localizedDescription)
    }
}

Working with paths contained in the iCloud drive container is easy, you’ll be able to append path parts to the bottom URL and use that actual location URL as you need.

let myDocumentUrl = self.containerUrl?
    .appendingPathComponent(subDirectory)
    .appendingPathComponent(fileName)
    .appendingPathExtension(fileExtension)

Selecting current recordsdata can also be fairly simple. You should utilize the built-in doc picker class from UIKit. There are solely two catches right here. 🤦‍♂️

First one is that you could present the kind of the paperwork that you simply’d prefer to entry. Have you ever ever heard about UTI‘s? No? Perhaps sure…? The factor is that you must discover the correct uniform sort identifier for each file sort, as an alternative of offering an extension or mime-type or one thing generally used factor. Sensible one, huh? 🧠

let picker = UIDocumentPickerViewController(
    documentTypes: ["public.json"], 
    in: .open
)
picker.delegate = self
picker.modalPresentationStyle = .fullScreen
self.current(picker, animated: true, completion: nil)

The second catch is that you must “unlock” the picked file earlier than you begin studying it. That may be finished by calling the startAccessingSecurityScopedResource technique. Remember to name the stopAccessingSecurityScopedResource technique, or issues are going to be out of steadiness. You don’t need that, belief me! #snap 🧤

func documentPicker(
    _ controller: UIDocumentPickerViewController, 
    didPickDocumentsAt urls: [URL]
) {
    guard
        controller.documentPickerMode == .open,
        let url = urls.first,
        url.startAccessingSecurityScopedResource()
    else {
        return
    }
    defer {
        url.stopAccessingSecurityScopedResource()
    }
    
}

Every part else works as you’d count on. It can save you recordsdata instantly into the container via file APIs or by utilizing the UIDocumentPickerViewController occasion. Listed below are among the commonest api calls, that you should use to control recordsdata.

attempt string.write(to: url, atomically: true, encoding: .utf8)
attempt String(contentsOf: url)


attempt information.write(to: url, choices: [.atomic])
attempt Knowledge(contentsOf: url)


FileManager.default.copyItem(at: native, to: url)
FileManager.default.removeItem(at: url)

You possibly can learn and write any type of string, information. By utilizing the FileManager you’ll be able to copy, transfer, delete gadgets or change file attributes. All of your paperwork saved inside iCloud drive will likely be magically out there on each system. Clearly you must be logged in together with your iCloud account, and have sufficient free storage. 💰

Debugging

In the event you alter one thing in your settings you may need to increment your construct quantity as effectively with the intention to notify the working system concerning the modifications. 💡

On the mac all of the iCloud drive recordsdata / containers are positioned below the person’s Library folder contained in the Cell Paperwork listing. You possibly can merely use the Terminal or Finder to go there and checklist all of the recordsdata. Professional tip: search for hidden ones as effectively! 😉

cd ~/Library/Cell Paperwork
ls -la
# ls -la|grep tiborbodecs

You can even monitor the exercise of the CloudDocs daemon, by utilizing this command:

# man brctl
brctl log --wait --shorten

The output will let you know what’s really occurring throughout the sync.

I encourage you to verify the guide entry for the brctl command, as a result of there are a couple of extra flags that may make troubleshooting easier. 🤐

This text was closely impressed by Marcin Krzyzanowski‘s actually previous weblog submit. 🍺