Tutorialwork/cloud_kit

CloudKit

CloudKit is a simple Flutter package to access on iOS devices the iCloud using the Apple CloudKit Api. You can save with the package key value pairs in the private database of the users iCloud.

📝 Usage

Simply create a new instance of the CloudKit class with the container id of the CloudKit container you created. And then, if the user is signed in to their iCloud account, you can store and delete key-value pairs.

First, instantiate a CloudKit instance to use the plugin. To do this, you will need to pass your container id, which you will need to create in order to use CloudKit. More information about creating a container can be found in the Setup section of this page.

CloudKit cloudKit = CloudKit('iCloud.dev.tutorialwork.cloudkitExample'); // Enter your container id

Before start using CloudKit you need to check if the user is logged in, otherwise the process of saving and getting value will fail.

CloudKitAccountStatus accountStatus = await cloudKit.getAccountStatus()
if (accountStatus == CloudKitAccountStatus.available) {
  // User is logged in to iCloud, you can start using the plugin
}

Once the instance has been created, you can access it to retrieve, save and delete entries.

cloudKit.save('key', 'value'); // both must be strings, if you want to save objects use the JSON format
cloudKit.get('key'); // returns a string with the value or null if the key was not found or you are not on iOS
cloudKit.delete('key'); // returns a boolean if it was successful

You can also delete the entire user database with a single command.

cloudKit.clearDatabase(); // also returns a boolean if successful

And if you want to check what's in the database, you can also get all entries.

cloudKit.getAll(); // return a map with all key-value pairs -> {key: value, secondKey: secondValue}

💻 Setup

• Add the iCloud capability to your XCode project and tick all the three options and create with the plus icon a new CloudKit container and select it.

• Then it's important for the next step that you are creating your first entry. You can do this with the example app in this repository or with your own app by saving your first key value pair.

https://raw.githubusercontent.com/Tutorialwork/cloud_kit/main/images/step3.png

• After that please open the CloudKit Dashboard and select your created CloudKit container and then open the "Indexes" page. And select on these page the "StorageItem"

https://raw.githubusercontent.com/Tutorialwork/cloud_kit/main/images/step4.png

• Click on "Add Basic Index" and select "recordName" and "Queryable" and then make sure you don't forgot to save your changes.

https://raw.githubusercontent.com/Tutorialwork/cloud_kit/main/images/step5.png

• Make sure before you are deploying your app, you need to deploy the database schema using the "Deploy Schema Changes…" button.

https://raw.githubusercontent.com/Tutorialwork/cloud_kit/main/images/step6.png