GitHub - ArtSabintsev/Zephyr: Effortlessly synchronize UserDefaults over iCloud.
source link: https://github.com/ArtSabintsev/Zephyr
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
Zephyr ?️
Effortlessly sync UserDefaults over iCloud
About
Zephyr synchronizes specific keys and/or all of your UserDefaults over iCloud using NSUbiquitousKeyValueStore.
Zephyr has built in monitoring, allowing it to sync specific keys in the background as they change.
For the latest updates, refer to the Releases tab.
Features
- CocoaPods Support
- Syncs all your UserDefaults (if you wish)
- Syncs only specific keys in UserDefaults
- Background monitoring and synchronization between UserDefaults and NSUbiquitousKeyValueStore
- Detailed Logging
- Documentation at http://sabintsev.com/Zephyr/
Installation Instructions
Swift Version Branch Name Will Continue to Receive Updates? 4.1 master Yes 3.2 swift3.2 No 3.1 swift3.1 NoCocoaPods
For Swift 4 support:
pod 'Zephyr'
For Swift 3.2 support:
pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift3.2'
For Swift 3.1 support:
pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift3.1'
Carthage
For Swift 4.1 support:
github "ArtSabintsev/Zephyr"
For Swift 3.2 support:
github "ArtSabintsev/Zephyr", "swift3.2"
For Swift 3.1 support:
github "ArtSabintsev/Zephyr", "swift3.1"
Swift Package Manager
.Package(url: "https://github.com/ArtSabintsev/Zephyr.git", majorVersion: 3)
Manual
- Download Zephyr
- Copy
Zephyr.swift
into your project.
Setup
Turn on iCloud Sync in Xcode
In Xcode, open your app's project/workspace file:
- Click on your Project
- Click on one of your Targets
- Click on Capabilities
- Turn on iCloud syncing
- Under Services, make sure to check
Key-value storage
- Repeat for all Targets (if necessary)
Integrate Zephyr into your App
Before performing each sync, Zephyr automatically checks to see if the data in UserDefaults or NSUbiquitousKeyValueStore is newer. To make sure there's no overwriting going on in a fresh installation of your app on a new device that's connected to the same iCloud account, make sure that your UserDefaults are registered BEFORE calling any of the Zephyr methods. One way to easily achieve this is by using the UserDefaults Register API.
Sync all UserDefaults
Zephyr.sync()
Sync a specific key or keys (Variadic Option)
Zephyr.sync(keys: "MyFirstKey", "MySecondKey", ...)
Sync a specific key or keys (Array Option)
Zephyr.sync(keys: ["MyFirstKey", "MySecondKey"])
Add/Remove Keys for Background Monitoring (Variadic Option)
Zephyr.addKeysToBeMonitored(keys: "MyFirstKey", "MySecondKey", ...) Zephyr.removeKeysFromBeingMonitored(keys: "MyFirstKey", "MySecondKey", ...)
Add/Remove Keys for Background Monitoring (Array Option)
Zephyr.addKeysToBeMonitored(keys: ["MyFirstKey", "MySecondKey"]) Zephyr.removeKeysFromBeingMonitored(keys: ["MyFirstKey", "MySecondKey"])
Toggle Automatic Calling of NSUbiquitousKeyValueStore's Synchronization method
Zephyr.syncUbiquitousKeyValueStoreOnChange = true // Default
Zephyr.syncUbiquitousKeyValueStoreOnChange = false // Turns off instantaneous synchronization
Debug Logging
Zephyr.debugEnabled = true // Must be called before sync(_:) Zephyr.sync()
Sample App
Please ignore the Sample App as I did not add any demo code in the Sample App. It's only in this repo to add support for Carthage.
Created and maintained by
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK