Classes
-The following classes are available globally.
- -Zephyr Docs (78% documented)
-The following classes are available globally.
- -Zephyr Docs (78% documented)
-@objcMembers
-public final class Zephyr : NSObject
-
- Undocumented
- -
-
-
- debugEnabled
-
- A debug flag.
- -If true, then this will enable console log statements.
- -By default, this flag is set to false.
- -Swift
-public static var debugEnabled: Bool
-
-
-
-
- syncUbiquitousKeyValueStoreOnChange
-
- If true, then NSUbiquitousKeyValueStore.synchronize()
will be called immediately after any change is made.
Swift
-public static var syncUbiquitousKeyValueStoreOnChange: Bool
-
-
-
-
- keysDidChangeOnCloudNotification
-
- A string containing the notification name that will be posted when Zephyr receives updated data from iCloud.
- -Swift
-public static let keysDidChangeOnCloudNotification: Notification.Name
-
-
-
-
- sync(keys:)
-
- Zephyr’s synchronization method.
- -Zephyr will synchronize all UserDefaults
with NSUbiquitousKeyValueStore
.
If one or more keys are passed, only those keys will be synchronized.
- -Swift
-public static func sync(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- If you pass a one or more keys, only those key will be synchronized. If no keys are passed, than all |
-
-
-
- sync(keys:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
This method will synchronize an array of keys between UserDefaults
and NSUbiquitousKeyValueStore
.
Swift
-public static func sync(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- An array of keys that should be synchronized between |
-
-
-
- sync(keys:userDefaults:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
If a custom UserDefaults object is passed in, Zephyr will synchronize that rather than UserDefaults.standard
.
Swift
-public static func sync(keys: String..., userDefaults: UserDefaults = UserDefaults.standard)
-
-
-
- userDefaults
-
- |
-
-
-
- The |
-
-
- keys
-
- |
-
-
-
- If you pass a one or more keys, only those key will be synchronized. If no keys are passed, than all |
-
-
-
- sync(keys:userDefaults:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
If a custom UserDefaults object is passed in, Zephyr will synchronize that rather than UserDefaults.standard
.
Swift
-public static func sync(keys: [String], userDefaults: UserDefaults = UserDefaults.standard)
-
-
-
- userDefaults
-
- |
-
-
-
- The |
-
-
- keys
-
- |
-
-
-
- An array of keys that should be synchronized between |
-
-
-
- addKeysToBeMonitored(keys:)
-
- Add specific keys to be monitored in the background. Monitored keys will automatically -be synchronized between both data stores whenever a change is detected
- -Swift
-public static func addKeysToBeMonitored(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to begin monitoring. - |
-
-
-
- addKeysToBeMonitored(keys:)
-
- Overloaded version of the addKeysToBeMonitored(keys:) method.
- -Add specific keys to be monitored in the background. Monitored keys will automatically -be synchronized between both data stores whenever a change is detected
- -Swift
-public static func addKeysToBeMonitored(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to begin monitoring. - |
-
-
-
- removeKeysFromBeingMonitored(keys:)
-
- Remove specific keys from being monitored in the background.
- -Swift
-public static func removeKeysFromBeingMonitored(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to stop monitoring. - |
-
-
-
- removeKeysFromBeingMonitored(keys:)
-
- Overloaded version of the removeKeysFromBeingMonitored(keys:) method.
- -Remove specific keys from being monitored in the background.
- -Swift
-public static func removeKeysFromBeingMonitored(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to stop monitoring. - |
-
-
-
- observeValue(forKeyPath:of:change:context:)
-
- Undocumented
- -Swift
-public override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?)
-
- Docs (100% documented)
-The following classes are available globally.
- -Docs (100% documented)
-@objcMembers
-public final class Zephyr : NSObject
-
-
-
-
- debugEnabled
-
- A debug flag.
- -If true, then this will enable console log statements.
- -By default, this flag is set to false.
- -Swift
-public static var debugEnabled: Bool
-
-
-
-
- syncUbiquitousKeyValueStoreOnChange
-
- If true, then NSUbiquitousKeyValueStore.synchronize()
will be called immediately after any change is made.
Swift
-public static var syncUbiquitousKeyValueStoreOnChange: Bool
-
-
-
-
- sync(keys:)
-
- Zephyr’s synchronization method.
- -Zephyr will synchronize all UserDefaults
with NSUbiquitousKeyValueStore
.
If one or more keys are passed, only those keys will be synchronized.
- -Swift
-public static func sync(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- If you pass a one or more keys, only those key will be synchronized. If no keys are passed, than all |
-
-
-
- sync(keys:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
This method will synchronize an array of keys between UserDefaults
and NSUbiquitousKeyValueStore
.
Swift
-public static func sync(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- An array of keys that should be synchronized between |
-
-
-
- sync(keys:userDefaults:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
If a custom UserDefaults object is passed in, Zephyr will synchronize that rather than UserDefaults.standard
.
Swift
-public static func sync(keys: String..., userDefaults: UserDefaults = UserDefaults.standard)
-
-
-
- userDefaults
-
- |
-
-
-
- The |
-
-
- keys
-
- |
-
-
-
- If you pass a one or more keys, only those key will be synchronized. If no keys are passed, than all |
-
-
-
- sync(keys:userDefaults:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
If a custom UserDefaults object is passed in, Zephyr will synchronize that rather than UserDefaults.standard
.
Swift
-public static func sync(keys: [String], userDefaults: UserDefaults = UserDefaults.standard)
-
-
-
- userDefaults
-
- |
-
-
-
- The |
-
-
- keys
-
- |
-
-
-
- An array of keys that should be synchronized between |
-
-
-
- addKeysToBeMonitored(keys:)
-
- Add specific keys to be monitored in the background. Monitored keys will automatically -be synchronized between both data stores whenever a change is detected
- -Swift
-public static func addKeysToBeMonitored(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to begin monitoring. - |
-
-
-
- addKeysToBeMonitored(keys:)
-
- Overloaded version of the addKeysToBeMonitored(keys:) method.
- -Add specific keys to be monitored in the background. Monitored keys will automatically -be synchronized between both data stores whenever a change is detected
- -Swift
-public static func addKeysToBeMonitored(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to begin monitoring. - |
-
-
-
- removeKeysFromBeingMonitored(keys:)
-
- Remove specific keys from being monitored in the background.
- -Swift
-public static func removeKeysFromBeingMonitored(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to stop monitoring. - |
-
-
-
- removeKeysFromBeingMonitored(keys:)
-
- Overloaded version of the removeKeysFromBeingMonitored(keys:) method.
- -Remove specific keys from being monitored in the background.
- -Swift
-public static func removeKeysFromBeingMonitored(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to stop monitoring. - |
-
-
-
- observeValue(forKeyPath:of:change:context:)
-
- Swift
-public override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?)
-
- Docs (100% documented)
-t |
A debug flag.
","parent_name":"Zephyr"},"Classes/Zephyr.html#/c:@M@Zephyr@objc(cs)Zephyr(cpy)syncUbiquitousKeyValueStoreOnChange":{"name":"syncUbiquitousKeyValueStoreOnChange","abstract":"If true, then NSUbiquitousKeyValueStore.synchronize()
will be called immediately after any change is made.
Zephyr’s synchronization method.
","parent_name":"Zephyr"},"Classes/Zephyr.html#/c:@M@Zephyr@objc(cs)Zephyr(cm)syncWithKeys:":{"name":"sync(keys:)","abstract":"Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
Add specific keys to be monitored in the background. Monitored keys will automatically","parent_name":"Zephyr"},"Classes/Zephyr.html#/s:6ZephyrAAC20addKeysToBeMonitoredySS4keysd_tFZ":{"name":"addKeysToBeMonitored(keys:)","abstract":"
Overloaded version of the addKeysToBeMonitored(keys:) method.
","parent_name":"Zephyr"},"Classes/Zephyr.html#/c:@M@Zephyr@objc(cs)Zephyr(cm)removeKeysFromBeingMonitoredWithKeys:":{"name":"removeKeysFromBeingMonitored(keys:)","abstract":"Remove specific keys from being monitored in the background.
","parent_name":"Zephyr"},"Classes/Zephyr.html#/s:6ZephyrAAC28removeKeysFromBeingMonitoredySS4keysd_tFZ":{"name":"removeKeysFromBeingMonitored(keys:)","abstract":"Overloaded version of the removeKeysFromBeingMonitored(keys:) method.
","parent_name":"Zephyr"},"Classes/Zephyr.html#/c:@CM@Zephyr@objc(cs)Zephyr(im)observeValueForKeyPath:ofObject:change:context:":{"name":"observeValue(forKeyPath:of:change:context:)","parent_name":"Zephyr"},"Classes/Zephyr.html":{"name":"Zephyr"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"}} \ No newline at end of file diff --git a/docs/docsets/.docset/Contents/Resources/docSet.dsidx b/docs/docsets/.docset/Contents/Resources/docSet.dsidx deleted file mode 100644 index 3978922..0000000 Binary files a/docs/docsets/.docset/Contents/Resources/docSet.dsidx and /dev/null differ diff --git a/docs/docsets/.tgz b/docs/docsets/.tgz deleted file mode 100644 index 4aa2ff5..0000000 Binary files a/docs/docsets/.tgz and /dev/null differ diff --git a/docs/docsets/Zephyr.docset/Contents/Info.plist b/docs/docsets/Zephyr.docset/Contents/Info.plist deleted file mode 100644 index 81b2d1c..0000000 --- a/docs/docsets/Zephyr.docset/Contents/Info.plist +++ /dev/null @@ -1,20 +0,0 @@ - - -Zephyr Docs (78% documented)
-Zephyr Docs (78% documented)
-@objcMembers
-public final class Zephyr : NSObject
-
- Undocumented
- -
-
-
- debugEnabled
-
- A debug flag.
- -If true, then this will enable console log statements.
- -By default, this flag is set to false.
- -Swift
-public static var debugEnabled: Bool
-
-
-
-
- syncUbiquitousKeyValueStoreOnChange
-
- If true, then NSUbiquitousKeyValueStore.synchronize()
will be called immediately after any change is made.
Swift
-public static var syncUbiquitousKeyValueStoreOnChange: Bool
-
-
-
-
- keysDidChangeOnCloudNotification
-
- A string containing the notification name that will be posted when Zephyr receives updated data from iCloud.
- -Swift
-public static let keysDidChangeOnCloudNotification: Notification.Name
-
-
-
-
- sync(keys:)
-
- Zephyr’s synchronization method.
- -Zephyr will synchronize all UserDefaults
with NSUbiquitousKeyValueStore
.
If one or more keys are passed, only those keys will be synchronized.
- -Swift
-public static func sync(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- If you pass a one or more keys, only those key will be synchronized. If no keys are passed, than all |
-
-
-
- sync(keys:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
This method will synchronize an array of keys between UserDefaults
and NSUbiquitousKeyValueStore
.
Swift
-public static func sync(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- An array of keys that should be synchronized between |
-
-
-
- sync(keys:userDefaults:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
If a custom UserDefaults object is passed in, Zephyr will synchronize that rather than UserDefaults.standard
.
Swift
-public static func sync(keys: String..., userDefaults: UserDefaults = UserDefaults.standard)
-
-
-
- userDefaults
-
- |
-
-
-
- The |
-
-
- keys
-
- |
-
-
-
- If you pass a one or more keys, only those key will be synchronized. If no keys are passed, than all |
-
-
-
- sync(keys:userDefaults:)
-
- Overloaded version of Zephyr’s synchronization method, sync(keys:)
.
If a custom UserDefaults object is passed in, Zephyr will synchronize that rather than UserDefaults.standard
.
Swift
-public static func sync(keys: [String], userDefaults: UserDefaults = UserDefaults.standard)
-
-
-
- userDefaults
-
- |
-
-
-
- The |
-
-
- keys
-
- |
-
-
-
- An array of keys that should be synchronized between |
-
-
-
- addKeysToBeMonitored(keys:)
-
- Add specific keys to be monitored in the background. Monitored keys will automatically -be synchronized between both data stores whenever a change is detected
- -Swift
-public static func addKeysToBeMonitored(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to begin monitoring. - |
-
-
-
- addKeysToBeMonitored(keys:)
-
- Overloaded version of the addKeysToBeMonitored(keys:) method.
- -Add specific keys to be monitored in the background. Monitored keys will automatically -be synchronized between both data stores whenever a change is detected
- -Swift
-public static func addKeysToBeMonitored(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to begin monitoring. - |
-
-
-
- removeKeysFromBeingMonitored(keys:)
-
- Remove specific keys from being monitored in the background.
- -Swift
-public static func removeKeysFromBeingMonitored(keys: [String])
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to stop monitoring. - |
-
-
-
- removeKeysFromBeingMonitored(keys:)
-
- Overloaded version of the removeKeysFromBeingMonitored(keys:) method.
- -Remove specific keys from being monitored in the background.
- -Swift
-public static func removeKeysFromBeingMonitored(keys: String...)
-
-
-
- keys
-
- |
-
-
-
- Pass one or more keys that you would like to stop monitoring. - |
-
-
-
- observeValue(forKeyPath:of:change:context:)
-
- Undocumented
- -Swift
-public override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey : Any]?, context: UnsafeMutableRawPointer?)
-
- Zephyr Docs (78% documented)
-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.
-UserDefaults
keys or all of your UserDefaults
.UserDefaults
and NSUbiquitousKeyValueStore
Swift Version | -Branch Name | -Will Continue to Receive Updates? | -
---|---|---|
5.1 | -swift5.1 | -Yes | -
5.0 | -swift5.0 | -No | -
4.2 | -swift4.2 | -No | -
4.1 | -swift4.1 | -No | -
3.2 | -swift3.2 | -No | -
3.1 | -swift3.1 | -No | -
pod 'Zephyr' # Swift 5.1
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift5.0' # Swift 5.0
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift4.2' # Swift 4.2
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift4.1' # Swift 4.1
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift3.2' # Swift 3.2
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift3.1' # Swift 3.1
-
-github "ArtSabintsev/Zephyr" // Swift 5.1
-github "ArtSabintsev/Zephyr" "swift5.0" // Swift 5.0
-github "ArtSabintsev/Zephyr" "swift4.2" // Swift 4.2
-github "ArtSabintsev/Zephyr" "swift4.1" // Swift 4.1
-github "ArtSabintsev/Zephyr" "swift3.2" // Swift 3.2
-github "ArtSabintsev/Zephyr" "swift3.1" // Swift 3.1
-
-.Package(url: "https://github.com/ArtSabintsev/Zephyr.git", majorVersion: 3)
-
-Zephyr.swift
into your project.In Xcode, open your app’s project/workspace file:
- -Key-value storage
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()
-
-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.
-Zephyr Docs (78% documented)
-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.
-UserDefaults
keys or all of your UserDefaults
.UserDefaults
and NSUbiquitousKeyValueStore
Swift Version | -Branch Name | -Will Continue to Receive Updates? | -
---|---|---|
5.1 | -swift5.1 | -Yes | -
5.0 | -swift5.0 | -No | -
4.2 | -swift4.2 | -No | -
4.1 | -swift4.1 | -No | -
3.2 | -swift3.2 | -No | -
3.1 | -swift3.1 | -No | -
pod 'Zephyr' # Swift 5.1
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift5.0' # Swift 5.0
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift4.2' # Swift 4.2
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift4.1' # Swift 4.1
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift3.2' # Swift 3.2
-pod 'Zephyr', :git => 'https://github.com/ArtSabintsev/Zephyr.git', :branch => 'swift3.1' # Swift 3.1
-
-github "ArtSabintsev/Zephyr" // Swift 5.1
-github "ArtSabintsev/Zephyr" "swift5.0" // Swift 5.0
-github "ArtSabintsev/Zephyr" "swift4.2" // Swift 4.2
-github "ArtSabintsev/Zephyr" "swift4.1" // Swift 4.1
-github "ArtSabintsev/Zephyr" "swift3.2" // Swift 3.2
-github "ArtSabintsev/Zephyr" "swift3.1" // Swift 3.1
-
-.Package(url: "https://github.com/ArtSabintsev/Zephyr.git", majorVersion: 3)
-
-Zephyr.swift
into your project.In Xcode, open your app’s project/workspace file:
- -Key-value storage
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()
-
-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.
-