Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Arthur Ariel Sabintsev
|
a3c7cfa26d | ||
|
Arthur Ariel Sabintsev
|
8477f5fbe6 | ||
|
Arthur Ariel Sabintsev
|
3c036ce559 | ||
 Thi
|
212e68969a | ||
|
Arthur Ariel Sabintsev
|
56a834ee41 | ||
|
Arthur Ariel Sabintsev
|
df6174ba06 | ||
|
Arthur Ariel Sabintsev
|
a11b7f0600 | ||
 Ryoh Tsukahara
|
de971bf52f | ||
|
Arthur Ariel Sabintsev
|
5f00463928 | ||
|
Arthur Ariel Sabintsev
|
cf4274fb16 | ||
|
Arthur Ariel Sabintsev
|
a2cd55d83b | ||
|
Arthur Ariel Sabintsev
|
3c064ffa4e | ||
|
Arthur Ariel Sabintsev
|
84301d4ba2 | ||
|
Arthur Ariel Sabintsev
|
e226f934c0 | ||
|
Arthur Ariel Sabintsev
|
33b6e60862 | ||
|
Arthur Ariel Sabintsev
|
fc64e7aca7 | ||
|
Arthur Ariel Sabintsev
|
f976791460 | ||
|
Arthur Ariel Sabintsev
|
2a948f0133 | ||
 Morgan Dock
|
2253c339ff |
@@ -5,11 +5,6 @@ notifications:
|
||||
email: false
|
||||
env:
|
||||
- LC_CTYPE=en_US.UTF-8 LANG=en_US.UTF-8
|
||||
before_install:
|
||||
- rvm install ruby-2.4.1
|
||||
- gem install cocoapods
|
||||
- gem install xcpretty -N
|
||||
- brew update
|
||||
script:
|
||||
- set -o pipefail
|
||||
- xcodebuild -project Example/Example.xcodeproj -scheme Example -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO | xcpretty -c
|
||||
|
||||
@@ -16,6 +16,7 @@
|
||||
8E01817E21B379DD006DED05 /* PresentationManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E01817B21B379DD006DED05 /* PresentationManager.swift */; };
|
||||
8E01818021B379DD006DED05 /* RulesManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E01817D21B379DD006DED05 /* RulesManager.swift */; };
|
||||
8E01818221B37B43006DED05 /* AlertAction.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E01818121B37B43006DED05 /* AlertAction.swift */; };
|
||||
8E065BA122054E5A00188D4E /* PerformCheck.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E065BA022054E5A00188D4E /* PerformCheck.swift */; };
|
||||
8E1635A91E6A0B9C0060CE27 /* SirenTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EE6C74C1E6A0AE100DBE454 /* SirenTests.swift */; };
|
||||
8E171DDE215B26B4006FBBCC /* BundleExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DD1215B26B4006FBBCC /* BundleExtension.swift */; };
|
||||
8E171DDF215B26B4006FBBCC /* DateExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DD2215B26B4006FBBCC /* DateExtension.swift */; };
|
||||
@@ -57,6 +58,7 @@
|
||||
8E01817B21B379DD006DED05 /* PresentationManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PresentationManager.swift; sourceTree = "<group>"; };
|
||||
8E01817D21B379DD006DED05 /* RulesManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RulesManager.swift; sourceTree = "<group>"; };
|
||||
8E01818121B37B43006DED05 /* AlertAction.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AlertAction.swift; sourceTree = "<group>"; };
|
||||
8E065BA022054E5A00188D4E /* PerformCheck.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PerformCheck.swift; sourceTree = "<group>"; };
|
||||
8E171DD1215B26B4006FBBCC /* BundleExtension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = BundleExtension.swift; sourceTree = "<group>"; };
|
||||
8E171DD2215B26B4006FBBCC /* DateExtension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DateExtension.swift; sourceTree = "<group>"; };
|
||||
8E171DD7215B26B4006FBBCC /* LookupModel.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LookupModel.swift; sourceTree = "<group>"; };
|
||||
@@ -161,6 +163,7 @@
|
||||
8E5061EA21C9CDF000A28DE0 /* AlertConstants.swift */,
|
||||
8E171DE5215B2701006FBBCC /* Localization.swift */,
|
||||
8E171DD7215B26B4006FBBCC /* LookupModel.swift */,
|
||||
8E065BA022054E5A00188D4E /* PerformCheck.swift */,
|
||||
8E01817821B379AF006DED05 /* Results.swift */,
|
||||
4D729C4521A213B4002F73AB /* Rules.swift */,
|
||||
);
|
||||
@@ -425,6 +428,7 @@
|
||||
8EEF4AB121AA6DDF00C83AAA /* DataParser.swift in Sources */,
|
||||
4D729C4621A213B4002F73AB /* Rules.swift in Sources */,
|
||||
8E171DE4215B26B4006FBBCC /* SirenViewController.swift in Sources */,
|
||||
8E065BA122054E5A00188D4E /* PerformCheck.swift in Sources */,
|
||||
8E171DE6215B2701006FBBCC /* Localization.swift in Sources */,
|
||||
8EE1FAF521B4E6B8009112A8 /* APIManager.swift in Sources */,
|
||||
8E171DDE215B26B4006FBBCC /* BundleExtension.swift in Sources */,
|
||||
|
||||
@@ -22,6 +22,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
|
||||
|
||||
// defaultExample()
|
||||
defaultExampleUsingCompletionHandler()
|
||||
// manualExampleWithCompletionHandler()
|
||||
// minimalCustomizationPresentationExample()
|
||||
// forceLocalizationCustomizationPresentationExample()
|
||||
// customMessagingPresentationExample()
|
||||
@@ -63,6 +64,21 @@ private extension AppDelegate {
|
||||
}
|
||||
}
|
||||
|
||||
/// Rather than waiting for `didBecomeActive` state changes (e.g., app launching/relaunching),
|
||||
/// Siren's version checking and alert presentation methods will be triggered each time this method is called.
|
||||
func manualExampleWithCompletionHandler() {
|
||||
Siren.shared.wail(performCheck: .onDemand) { (results, error) in
|
||||
if let results = results {
|
||||
print("AlertAction ", results.alertAction)
|
||||
print("Localization ", results.localization)
|
||||
print("LookupModel ", results.lookupModel)
|
||||
print("UpdateType ", results.updateType)
|
||||
} else if let error = error {
|
||||
print(error.localizedDescription)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Minor customization to Siren's update alert presentation.
|
||||
func minimalCustomizationPresentationExample() {
|
||||
let siren = Siren.shared
|
||||
|
||||
+12
-12
@@ -1,8 +1,8 @@
|
||||
GIT
|
||||
remote: https://www.github.com/realm/jazzy.git
|
||||
revision: 916cf729525040c43ea31fc55a3730dee04f1a29
|
||||
revision: 04b0cd720f6c25c1582939020757b96331e9472f
|
||||
specs:
|
||||
jazzy (0.9.4)
|
||||
jazzy (0.9.5)
|
||||
cocoapods (~> 1.5.3)
|
||||
mustache (~> 1.1.0)
|
||||
open4
|
||||
@@ -16,7 +16,7 @@ GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
CFPropertyList (3.0.0)
|
||||
activesupport (4.2.10)
|
||||
activesupport (4.2.11)
|
||||
i18n (~> 0.7)
|
||||
minitest (~> 5.1)
|
||||
thread_safe (~> 0.3, >= 0.3.4)
|
||||
@@ -47,21 +47,21 @@ GEM
|
||||
activesupport (>= 4.0.2, < 6)
|
||||
fuzzy_match (~> 2.0.4)
|
||||
nap (~> 1.0)
|
||||
cocoapods-deintegrate (1.0.2)
|
||||
cocoapods-deintegrate (1.0.3)
|
||||
cocoapods-downloader (1.2.2)
|
||||
cocoapods-plugins (1.0.0)
|
||||
nap
|
||||
cocoapods-search (1.0.0)
|
||||
cocoapods-stats (1.0.0)
|
||||
cocoapods-stats (1.1.0)
|
||||
cocoapods-trunk (1.3.1)
|
||||
nap (>= 0.8, < 2.0)
|
||||
netrc (~> 0.11)
|
||||
cocoapods-try (1.1.0)
|
||||
colored2 (3.1.2)
|
||||
concurrent-ruby (1.0.5)
|
||||
concurrent-ruby (1.1.4)
|
||||
escape (0.0.4)
|
||||
executable-hooks (1.6.0)
|
||||
ffi (1.9.25)
|
||||
ffi (1.10.0)
|
||||
fourflusher (2.0.1)
|
||||
fuzzy_match (2.0.4)
|
||||
gh_inspector (1.1.3)
|
||||
@@ -76,11 +76,11 @@ GEM
|
||||
netrc (0.11.0)
|
||||
open4 (1.3.4)
|
||||
rb-fsevent (0.10.3)
|
||||
rb-inotify (0.9.10)
|
||||
ffi (>= 0.5.0, < 2)
|
||||
rb-inotify (0.10.0)
|
||||
ffi (~> 1.0)
|
||||
redcarpet (3.4.0)
|
||||
rouge (3.3.0)
|
||||
ruby-macho (1.3.1)
|
||||
ruby-macho (1.4.0)
|
||||
rubygems-bundler (1.4.5)
|
||||
bundler-unload (>= 1.0.2)
|
||||
executable-hooks (>= 1.5.0)
|
||||
@@ -95,7 +95,7 @@ GEM
|
||||
thread_safe (~> 0.1)
|
||||
xcinvoke (0.3.0)
|
||||
liferaft (~> 0.0.6)
|
||||
xcodeproj (1.7.0)
|
||||
xcodeproj (1.8.1)
|
||||
CFPropertyList (>= 2.3.3, < 4.0)
|
||||
atomos (~> 0.1.3)
|
||||
claide (>= 1.0.2, < 2.0)
|
||||
@@ -111,4 +111,4 @@ DEPENDENCIES
|
||||
rubygems-bundler
|
||||
|
||||
BUNDLED WITH
|
||||
1.17.1
|
||||
1.17.3
|
||||
|
||||
@@ -54,6 +54,8 @@ Siren is built to work with the [**Semantic Versioning**](https://semver.org/) s
|
||||
### Future Features
|
||||
A list of future development work can be found on [Siren's Kanban Board](https://github.com/ArtSabintsev/Siren/projects/1).
|
||||
|
||||
---
|
||||
|
||||
## Screenshots
|
||||
- The **left picture** forces the user to update the app.
|
||||
- The **center picture** gives the user the option to update the app.
|
||||
@@ -74,6 +76,8 @@ A list of future development work can be found on [Siren's Kanban Board](https:/
|
||||
- [**Gant Laborde's Siren library**](https://github.com/GantMan/react-native-siren)
|
||||
- The Siren Swift library inspired the React Native library.
|
||||
|
||||
---
|
||||
|
||||
# Installation and Integration
|
||||
|
||||
## Installation Instructions
|
||||
@@ -131,8 +135,8 @@ final class AppDelegate: UIResponder, UIApplicationDelegate {
|
||||
```
|
||||
|
||||
Siren also has plenty of customization options. All examples can be found in the Example Project's [**AppDelegate**](https://github.com/ArtSabintsev/Siren/blob/master/Example/Example/AppDelegate.swift) file. Uncomment the example you'd like to test.
|
||||
|
||||
**WARNING**: Siren should ONLY be placed in [UIApplication.didFinishLaunchingWithOptions](https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622921-application) and only after the `window?.makeKeyAndVisible()` call. Siren initializes a listener on [didBecomeActiveNotification](https://developer.apple.com/reference/foundation/nsnotification.name/1622953-uiapplicationdidbecomeactive) to perform version checks.
|
||||
|
||||
---
|
||||
|
||||
# Device-Specific Checks
|
||||
|
||||
@@ -146,13 +150,15 @@ If your user's device is set to one of the supported locales, an update message
|
||||
You may want the update dialog to *always* appear in a certain language, ignoring the user's device-specific setting. You can enable it like so:
|
||||
|
||||
```swift
|
||||
// In this example, we force the `russian` language.
|
||||
// In this example, we force the `Russian` language.
|
||||
Siren.shared.presentationManager = PresentationManager(forceLanguageLocalization: .russian)
|
||||
```
|
||||
|
||||
## Device Compatibility
|
||||
If an app update is available, Siren checks to make sure that the version of iOS on the user's device is compatible with the one that is required by the app update. For example, if a user has iOS 11 installed on their device, but the app update requires iOS 12, an alert will not be shown. This takes care of the *false positive* case regarding app updating.
|
||||
|
||||
---
|
||||
|
||||
# Testing
|
||||
|
||||
## Testing Siren Locally
|
||||
@@ -163,6 +169,8 @@ If you currently don't have an app in the store, change your bundleID to one tha
|
||||
## Words of Caution
|
||||
Occasionally, the iTunes JSON will update faster than the App Store CDN, meaning the JSON may state that the new version of the app has been released, while no new binary is made available for download via the App Store. It is for this reason that Siren will, by default, wait 1 day (24 hours) after the JSON has been updated to prompt the user to update. To change the default setting, please modify the value of `showAlertAfterCurrentVersionHasBeenReleasedForDays`.
|
||||
|
||||
---
|
||||
|
||||
# App Submission
|
||||
|
||||
## App Store Review
|
||||
@@ -175,7 +183,10 @@ In 2017, Apple announced the [ability to rollout app updates gradually (a.k.a. P
|
||||
- You can set `showAlertAfterCurrentVersionHasBeenReleasedForDays` to `7`, and Siren will not prompt any users until the latest version is 7 days old, after the phased rollout is complete.
|
||||
- You can remotely disable Siren until the rollout is done using your own API / backend logic.
|
||||
|
||||
---
|
||||
|
||||
# Attribution
|
||||
|
||||
## Special Thanks
|
||||
A massive shout-out and thank you goes to the following folks:
|
||||
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
Pod::Spec.new do |s|
|
||||
# Version
|
||||
s.version = "4.0.2"
|
||||
s.version = "4.2.2"
|
||||
s.swift_version = '4.2'
|
||||
|
||||
# Meta
|
||||
|
||||
@@ -6,7 +6,6 @@
|
||||
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
import UIKit
|
||||
|
||||
// `UIAlertController` Extension for Siren.
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
import UIKit
|
||||
|
||||
/// PresentationManager for Siren
|
||||
public struct PresentationManager {
|
||||
@@ -135,7 +135,7 @@ extension PresentationManager {
|
||||
}
|
||||
|
||||
// If the alertType is .none, an alert will not be presented.
|
||||
// If the `updaterWindow` is not hidden, than an alert is already presented.
|
||||
// If the `updaterWindow` is not hidden, then an alert is already presented.
|
||||
// The latter prevents `UIAlertControllers` from appearing on top of each other.
|
||||
if rules.alertType != .none && updaterWindow.isHidden {
|
||||
alertController?.show(window: updaterWindow)
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
//
|
||||
// PerformCheck.swift
|
||||
// Siren
|
||||
//
|
||||
// Created by Arthur Sabintsev on 2/1/19.
|
||||
// Copyright © 2019 Sabintsev iOS Projects. All rights reserved.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
|
||||
/// The type of check to perform when Siren's `wail` method is performed.
|
||||
///
|
||||
/// - Note: Alert presentation will still respct the settings that are set
|
||||
/// for `UpdatePromptFrequency` and `showAlertAfterCurrentVersionHasBeenReleasedForDays`
|
||||
public enum PerformCheck {
|
||||
/// Performs a version check only when Siren's `wail` method is called,
|
||||
/// as the `UIApplication.didBecomeActiveNotification` is ignored.
|
||||
case onDemand
|
||||
|
||||
/// (DEFAULT) Perform a version check whenever the app enters the foreground.
|
||||
/// This value must be set when Siren's `wail` method is called to enable the
|
||||
/// `UIApplication.didBecomeActiveNotification` observer.
|
||||
case onForeground
|
||||
}
|
||||
@@ -15,10 +15,10 @@ public struct Results {
|
||||
public var alertAction: AlertAction = .unknown
|
||||
|
||||
/// The Siren-supported locale that was used for the string in the update alert.
|
||||
public var localization: Localization
|
||||
public let localization: Localization
|
||||
|
||||
/// The Swift-mapped API model, if a successful version check was performed.
|
||||
public var lookupModel: LookupModel
|
||||
public let lookupModel: LookupModel
|
||||
|
||||
/// The type of update that was returned for the API.
|
||||
public var updateType: RulesManager.UpdateType = .unknown
|
||||
|
||||
@@ -46,6 +46,11 @@ public struct Rules {
|
||||
return Rules(promptFrequency: .daily, forAlertType: .skip)
|
||||
}
|
||||
|
||||
/// Performs a version check weekly, but allows the user to skip updating the app until the next time the app becomes active.
|
||||
public static var hinting: Rules {
|
||||
return Rules(promptFrequency: .weekly, forAlertType: .option)
|
||||
}
|
||||
|
||||
/// Performs a version check daily, but allows the user to skip updating the app until the next time the app becomes active.
|
||||
public static var persistent: Rules {
|
||||
return Rules(promptFrequency: .daily, forAlertType: .option)
|
||||
|
||||
+70
-26
@@ -43,11 +43,14 @@ public final class Siren: NSObject {
|
||||
/// The retained `NotificationCenter` observer that listens for `UIApplication.didBecomeActiveNotification` notifications.
|
||||
var didBecomeActiveObserver: NSObjectProtocol?
|
||||
|
||||
/// The retained `NotificationCenter` observer that listens for `UIApplication.willResignActiveNotification` notifications.
|
||||
var willResignActiveObserver: NSObjectProtocol?
|
||||
|
||||
/// The retained `NotificationCenter` observer that listens for `UIApplication.didEnterBackgroundNotification` notifications.
|
||||
var didEnterBackgroundObserver: NSObjectProtocol?
|
||||
|
||||
/// The last date that an alert was presented to the user.
|
||||
private var alertPresentationDate: Date?
|
||||
private var alertPresentationDate: Date? = UserDefaults.alertPresentationDate
|
||||
|
||||
/// The App Store's unique identifier for an app.
|
||||
private var appID: Int?
|
||||
@@ -55,9 +58,11 @@ public final class Siren: NSObject {
|
||||
/// The completion handler used to return the results or errors returned by Siren.
|
||||
private var resultsHandler: ResultsHandler?
|
||||
|
||||
/// The initialization method.
|
||||
private override init() {
|
||||
alertPresentationDate = UserDefaults.alertPresentationDate
|
||||
/// The deinitialization method that clears out all observers,
|
||||
deinit {
|
||||
presentationManager.alertController?.dismiss(animated: true, completion: nil)
|
||||
removeForegroundObservers()
|
||||
removeBackgroundObservers()
|
||||
}
|
||||
}
|
||||
|
||||
@@ -66,10 +71,23 @@ public final class Siren: NSObject {
|
||||
public extension Siren {
|
||||
/// This method executes the Siren version checking and alert presentation flow.
|
||||
///
|
||||
/// - Parameter handler: Returns the metadata around a successful version check and interaction with the update modal or it returns nil.
|
||||
func wail(completion handler: ResultsHandler? = nil) {
|
||||
/// - Parameters:
|
||||
/// - performCheck: Defines how the version check flow is entered. Defaults to `.onForeground`.
|
||||
/// - handler: Returns the metadata around a successful version check and interaction with the update modal or it returns nil.
|
||||
func wail(performCheck: PerformCheck = .onForeground,
|
||||
completion handler: ResultsHandler? = nil) {
|
||||
resultsHandler = handler
|
||||
addObservers()
|
||||
|
||||
switch performCheck {
|
||||
case .onDemand:
|
||||
removeForegroundObservers()
|
||||
performVersionCheck()
|
||||
case .onForeground:
|
||||
addForegroundObservers()
|
||||
}
|
||||
|
||||
// Add background app state change observers.
|
||||
addBackgroundObservers()
|
||||
}
|
||||
|
||||
/// Launches the AppStore in two situations when the user clicked the `Update` button in the UIAlertController modal.
|
||||
@@ -172,7 +190,7 @@ private extension Siren {
|
||||
if let previouslySkippedVersion = UserDefaults.storedSkippedVersion,
|
||||
let currentInstalledVersion = currentInstalledVersion,
|
||||
!currentAppStoreVersion.isEmpty,
|
||||
currentAppStoreVersion != previouslySkippedVersion {
|
||||
currentAppStoreVersion == previouslySkippedVersion {
|
||||
resultsHandler?(nil, .skipVersionUpdate(installedVersion: currentInstalledVersion, appStoreVersion: currentAppStoreVersion))
|
||||
return
|
||||
}
|
||||
@@ -219,17 +237,11 @@ private extension Siren {
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Observers
|
||||
// MARK: - Add Observers
|
||||
|
||||
private extension Siren {
|
||||
/// Add app state observers
|
||||
func addObservers() {
|
||||
addForegroundObserver()
|
||||
addBackgroundObserver()
|
||||
}
|
||||
|
||||
/// Adds an observer that listens for app launching/relaunching.
|
||||
func addForegroundObserver() {
|
||||
func addForegroundObservers() {
|
||||
guard didBecomeActiveObserver == nil else { return }
|
||||
didBecomeActiveObserver = NotificationCenter
|
||||
.default
|
||||
@@ -241,16 +253,48 @@ private extension Siren {
|
||||
}
|
||||
}
|
||||
|
||||
/// Adds an observer that listens for when the app is sent to the background.
|
||||
func addBackgroundObserver() {
|
||||
guard didEnterBackgroundObserver == nil else { return }
|
||||
didEnterBackgroundObserver = NotificationCenter
|
||||
.default
|
||||
.addObserver(forName: UIApplication.didEnterBackgroundNotification,
|
||||
object: nil,
|
||||
queue: nil) { [weak self] _ in
|
||||
guard let self = self else { return }
|
||||
self.presentationManager.alertController?.dismiss(animated: true, completion: nil)
|
||||
/// Adds an observer that listens for when the user enters the app switcher
|
||||
/// and when the app is sent to the background.
|
||||
func addBackgroundObservers() {
|
||||
if willResignActiveObserver == nil {
|
||||
didBecomeActiveObserver = NotificationCenter
|
||||
.default
|
||||
.addObserver(forName: UIApplication.willResignActiveNotification,
|
||||
object: nil,
|
||||
queue: nil) { [weak self] _ in
|
||||
guard let self = self else { return }
|
||||
self.presentationManager.alertController?.dismiss(animated: true, completion: nil)
|
||||
}
|
||||
}
|
||||
|
||||
if didEnterBackgroundObserver == nil {
|
||||
didEnterBackgroundObserver = NotificationCenter
|
||||
.default
|
||||
.addObserver(forName: UIApplication.didEnterBackgroundNotification,
|
||||
object: nil,
|
||||
queue: nil) { [weak self] _ in
|
||||
guard let self = self else { return }
|
||||
self.presentationManager.alertController?.dismiss(animated: true, completion: nil)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Remove Observers
|
||||
|
||||
private extension Siren {
|
||||
/// Removes the observer that listens for app launching/relaunching.
|
||||
func removeForegroundObservers() {
|
||||
NotificationCenter.default.removeObserver(didBecomeActiveObserver as Any)
|
||||
didBecomeActiveObserver = nil
|
||||
}
|
||||
|
||||
/// Remove the observers that list to app resignation and app backgrounding.
|
||||
func removeBackgroundObservers() {
|
||||
NotificationCenter.default.removeObserver(willResignActiveObserver as Any)
|
||||
willResignActiveObserver = nil
|
||||
|
||||
NotificationCenter.default.removeObserver(didEnterBackgroundObserver as Any)
|
||||
didEnterBackgroundObserver = nil
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
import UIKit
|
||||
|
||||
/// Version parsing functions for Siren.
|
||||
struct DataParser {
|
||||
|
||||
@@ -30,7 +30,7 @@ public enum KnownError: LocalizedError {
|
||||
case missingBundleID
|
||||
/// No new update available.
|
||||
case noUpdateAvailable
|
||||
/// Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the `UpdatePromptFrequency.immediately` rule in `RulesManager`
|
||||
/// Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the `UpdatePromptFrequency.immediately` rule in `RulesManager`
|
||||
case recentlyPrompted
|
||||
/// The app has been released for X days, but Siren cannot prompt the user until Y (where Y > X) days have passed.
|
||||
case releasedTooSoon(daysSinceRelease: Int, releasedForDays: Int)
|
||||
@@ -63,7 +63,7 @@ public enum KnownError: LocalizedError {
|
||||
case .noUpdateAvailable:
|
||||
return "\(KnownError.sirenError) No new update available."
|
||||
case .recentlyPrompted:
|
||||
return "\(KnownError.sirenError) Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the `\(Rules.UpdatePromptFrequency.self).immediately` rule in `\(RulesManager.self)`"
|
||||
return "\(KnownError.sirenError) Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the `\(Rules.UpdatePromptFrequency.self).immediately` rule in `\(RulesManager.self)`"
|
||||
case .releasedTooSoon(let daysSinceRelease, let releasedForDays):
|
||||
return "\(KnownError.sirenError) The app has been released for \(daysSinceRelease) days, but Siren cannot prompt the user until \(releasedForDays) days have passed."
|
||||
case .skipVersionUpdate(let installedVersion, let appStoreVersion):
|
||||
|
||||
@@ -6,7 +6,6 @@
|
||||
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
|
||||
//
|
||||
|
||||
import Foundation
|
||||
import UIKit
|
||||
|
||||
/// `UIViewController` Extension for Siren
|
||||
|
||||
Vendored
+74
-4
@@ -14,12 +14,12 @@
|
||||
<a title="Classes Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="index.html">in-acl Reference</a>
|
||||
<a href="index.html">Siren Reference</a>
|
||||
<img id="carat" src="img/carat.png" />
|
||||
Classes Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -132,11 +170,43 @@
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/c:@M@Siren@objc(cs)SirenViewController"></a>
|
||||
<a name="//apple_ref/swift/Class/SirenViewController" class="dashAnchor"></a>
|
||||
<a class="token" href="#/c:@M@Siren@objc(cs)SirenViewController">SirenViewController</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p><code>UIViewController</code> Extension for Siren</p>
|
||||
|
||||
<a href="Classes/SirenViewController.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">final</span> <span class="kd">class</span> <span class="kt">SirenViewController</span> <span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+637
-8
@@ -14,12 +14,12 @@
|
||||
<a title="Siren Class Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
Siren Class Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -255,6 +293,222 @@ skipping the update all together until another version is released.</p>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC23currentInstalledVersionSSSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/currentInstalledVersion" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC23currentInstalledVersionSSSgvp">currentInstalledVersion</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The current installed version of your app.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">lazy</span> <span class="k">var</span> <span class="nv">currentInstalledVersion</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC23didBecomeActiveObserverSo8NSObject_pSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/didBecomeActiveObserver" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC23didBecomeActiveObserverSo8NSObject_pSgvp">didBecomeActiveObserver</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The retained <code>NotificationCenter</code> observer that listens for <code>UIApplication.didBecomeActiveNotification</code> notifications.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">didBecomeActiveObserver</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC24willResignActiveObserverSo8NSObject_pSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/willResignActiveObserver" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC24willResignActiveObserverSo8NSObject_pSgvp">willResignActiveObserver</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The retained <code>NotificationCenter</code> observer that listens for <code>UIApplication.willResignActiveNotification</code> notifications.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">willResignActiveObserver</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC26didEnterBackgroundObserverSo8NSObject_pSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/didEnterBackgroundObserver" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC26didEnterBackgroundObserverSo8NSObject_pSgvp">didEnterBackgroundObserver</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The retained <code>NotificationCenter</code> observer that listens for <code>UIApplication.didEnterBackgroundNotification</code> notifications.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">didEnterBackgroundObserver</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC21alertPresentationDate33_7DFB1BC200A6C64FBED860A3A8153B65LL10Foundation0D0VSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/alertPresentationDate" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC21alertPresentationDate33_7DFB1BC200A6C64FBED860A3A8153B65LL10Foundation0D0VSgvp">alertPresentationDate</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The last date that an alert was presented to the user.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="k">var</span> <span class="nv">alertPresentationDate</span><span class="p">:</span> <span class="kt">Date</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC5appID33_7DFB1BC200A6C64FBED860A3A8153B65LLSiSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/appID" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC5appID33_7DFB1BC200A6C64FBED860A3A8153B65LLSiSgvp">appID</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The App Store’s unique identifier for an app.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="k">var</span> <span class="nv">appID</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC14resultsHandler33_7DFB1BC200A6C64FBED860A3A8153B65LLyAA7ResultsVSg_AA10KnownErrorOSgtcSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/resultsHandler" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC14resultsHandler33_7DFB1BC200A6C64FBED860A3A8153B65LLyAA7ResultsVSg_AA10KnownErrorOSgtcSgvp">resultsHandler</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The completion handler used to return the results or errors returned by Siren.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="k">var</span> <span class="nv">resultsHandler</span><span class="p">:</span> <span class="kt">Siren</span><span class="o">.</span><span class="kt"><a href="../Classes/Siren.html#/s:5SirenAAC14ResultsHandlera">ResultsHandler</a></span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/c:@M@Siren@objc(cs)Siren(im)dealloc"></a>
|
||||
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
|
||||
<a class="token" href="#/c:@M@Siren@objc(cs)Siren(im)dealloc">deinit</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The deinitialization method that clears out all observers,</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
@@ -269,9 +523,9 @@ skipping the update all together until another version is released.</p>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC4wail10completionyyAA7ResultsVSg_AA10KnownErrorOSgtcSg_tF"></a>
|
||||
<a name="//apple_ref/swift/Method/wail(completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC4wail10completionyyAA7ResultsVSg_AA10KnownErrorOSgtcSg_tF">wail(completion:)</a>
|
||||
<a name="/s:5SirenAAC4wail12performCheck10completionyAA07PerformD0O_yAA7ResultsVSg_AA10KnownErrorOSgtcSgtF"></a>
|
||||
<a name="//apple_ref/swift/Method/wail(performCheck:completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC4wail12performCheck10completionyAA07PerformD0O_yAA7ResultsVSg_AA10KnownErrorOSgtcSgtF">wail(performCheck:completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
@@ -286,7 +540,8 @@ skipping the update all together until another version is released.</p>
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">wail</span><span class="p">(</span><span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren.html#/s:5SirenAAC14ResultsHandlera">ResultsHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">wail</span><span class="p">(</span><span class="nv">performCheck</span><span class="p">:</span> <span class="kt"><a href="../Enums/PerformCheck.html">PerformCheck</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">onForeground</span><span class="p">,</span>
|
||||
<span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren.html#/s:5SirenAAC14ResultsHandlera">ResultsHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -294,6 +549,18 @@ skipping the update all together until another version is released.</p>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>performCheck</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Defines how the version check flow is entered. Defaults to <code>.onForeground</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
@@ -344,11 +611,373 @@ instead of using Siren’s prebuilt update alert.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Version%20Check%20and%20Alert%20Presentation%20Flow"></a>
|
||||
<a name="//apple_ref/swift/Section/Version Check and Alert Presentation Flow" class="dashAnchor"></a>
|
||||
<a href="#/Version%20Check%20and%20Alert%20Presentation%20Flow">
|
||||
<h3 class="section-name">Version Check and Alert Presentation Flow</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC19performVersionCheck33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/performVersionCheck()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC19performVersionCheck33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">performVersionCheck()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initiates the unidirectional version checking flow.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">performVersionCheck</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC8validate33_7DFB1BC200A6C64FBED860A3A8153B65LL5modelyAA11LookupModelV_tF"></a>
|
||||
<a name="//apple_ref/swift/Method/validate(model:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC8validate33_7DFB1BC200A6C64FBED860A3A8153B65LL5modelyAA11LookupModelV_tF">validate(model:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Validates the parsed and mapped iTunes Lookup Model
|
||||
to guarantee all the relevant data was returned before
|
||||
attempting to present an alert.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">validate</span><span class="p">(</span><span class="nv">model</span><span class="p">:</span> <span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>model</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The iTunes Lookup Model.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC45determineIfAlertPresentationRulesAreSatisfied33_7DFB1BC200A6C64FBED860A3A8153B65LL25forCurrentAppStoreVersion14andLookupModelySS_AA0wX0VtF"></a>
|
||||
<a name="//apple_ref/swift/Method/determineIfAlertPresentationRulesAreSatisfied(forCurrentAppStoreVersion:andLookupModel:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC45determineIfAlertPresentationRulesAreSatisfied33_7DFB1BC200A6C64FBED860A3A8153B65LL25forCurrentAppStoreVersion14andLookupModelySS_AA0wX0VtF">determineIfAlertPresentationRulesAreSatisfied(forCurrentAppStoreVersion:andLookupModel:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Determines if the update alert can be presented based on the
|
||||
rules set in the <code><a href="../Structs/RulesManager.html">RulesManager</a></code> and the the skip version settings.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">determineIfAlertPresentationRulesAreSatisfied</span><span class="p">(</span><span class="n">forCurrentAppStoreVersion</span> <span class="nv">currentAppStoreVersion</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">andLookupModel</span> <span class="nv">model</span><span class="p">:</span> <span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>currentAppStoreVersion</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The curren version of the app in the App Store.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>model</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The iTunes Lookup Model.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC12presentAlert33_7DFB1BC200A6C64FBED860A3A8153B65LL9withRules25forCurrentAppStoreVersion5model13andUpdateTypeyAA0M0V_SSAA11LookupModelVAA0M7ManagerV0uV0OtF"></a>
|
||||
<a name="//apple_ref/swift/Method/presentAlert(withRules:forCurrentAppStoreVersion:model:andUpdateType:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC12presentAlert33_7DFB1BC200A6C64FBED860A3A8153B65LL9withRules25forCurrentAppStoreVersion5model13andUpdateTypeyAA0M0V_SSAA11LookupModelVAA0M7ManagerV0uV0OtF">presentAlert(withRules:forCurrentAppStoreVersion:model:andUpdateType:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Presents the update alert to the end user.
|
||||
Upon tapping a value on the alert view, a completion handler will return all relevant metadata to the app.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">presentAlert</span><span class="p">(</span><span class="n">withRules</span> <span class="nv">rules</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules.html">Rules</a></span><span class="p">,</span>
|
||||
<span class="n">forCurrentAppStoreVersion</span> <span class="nv">currentAppStoreVersion</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
|
||||
<span class="nv">model</span><span class="p">:</span> <span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span><span class="p">,</span>
|
||||
<span class="n">andUpdateType</span> <span class="nv">updateType</span><span class="p">:</span> <span class="kt"><a href="../Structs/RulesManager.html">RulesManager</a></span><span class="o">.</span><span class="kt">UpdateType</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>rules</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The rules for how to present the alert.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>currentAppStoreVersion</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The current version of the app in the App Store.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>model</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The iTunes Lookup Model.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>updateType</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The type of update that is available based on the version found in the App Store.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Add%20Observers"></a>
|
||||
<a name="//apple_ref/swift/Section/Add Observers" class="dashAnchor"></a>
|
||||
<a href="#/Add%20Observers">
|
||||
<h3 class="section-name">Add Observers</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC22addForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/addForegroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC22addForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">addForegroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Adds an observer that listens for app launching/relaunching.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addForegroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC22addBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/addBackgroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC22addBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">addBackgroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Adds an observer that listens for when the user enters the app switcher
|
||||
and when the app is sent to the background.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addBackgroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Remove%20Observers"></a>
|
||||
<a name="//apple_ref/swift/Section/Remove Observers" class="dashAnchor"></a>
|
||||
<a href="#/Remove%20Observers">
|
||||
<h3 class="section-name">Remove Observers</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC25removeForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/removeForegroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC25removeForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">removeForegroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Removes the observer that listens for app launching/relaunching.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeForegroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC25removeBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/removeBackgroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC25removeBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">removeBackgroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Remove the observers that list to app resignation and app backgrounding.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeBackgroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -175,8 +178,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
Vendored
+80
-4
@@ -14,12 +14,12 @@
|
||||
<a title="Enumerations Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="index.html">in-acl Reference</a>
|
||||
<a href="index.html">Siren Reference</a>
|
||||
<img id="carat" src="img/carat.png" />
|
||||
Enumerations Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -132,6 +170,44 @@
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12PerformCheckO"></a>
|
||||
<a name="//apple_ref/swift/Enum/PerformCheck" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12PerformCheckO">PerformCheck</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The type of check to perform when Siren’s <code>wail</code> method is performed.</p>
|
||||
<div class="aside aside-note">
|
||||
<p class="aside-title">Note</p>
|
||||
Alert presentation will still respct the settings that are set
|
||||
for <code>UpdatePromptFrequency</code> and <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code>
|
||||
|
||||
</div>
|
||||
|
||||
<a href="Enums/PerformCheck.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">PerformCheck</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
@@ -167,8 +243,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="AlertAction Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
AlertAction Enumeration Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -221,8 +259,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="KnownError Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
KnownError Enumeration Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -391,7 +429,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the <code>UpdatePromptFrequency.immediately</code> rule in <code><a href="../Structs/RulesManager.html">RulesManager</a></code></p>
|
||||
<p>Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the <code>UpdatePromptFrequency.immediately</code> rule in <code><a href="../Structs/RulesManager.html">RulesManager</a></code></p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -486,13 +524,40 @@
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10KnownErrorO05sirenC033_B3C911EAD28C83CC211C07566B0F499ALLSSvpZ"></a>
|
||||
<a name="//apple_ref/swift/Variable/sirenError" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10KnownErrorO05sirenC033_B3C911EAD28C83CC211C07566B0F499ALLSSvpZ">sirenError</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>An easily identifiable prefix for all errors thrown by Siren.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">sirenError</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,224 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>PerformCheck Enumeration Reference</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
||||
<meta charset='utf-8'>
|
||||
<script src="../js/jquery.min.js" defer></script>
|
||||
<script src="../js/jazzy.js" defer></script>
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<a name="//apple_ref/swift/Enum/PerformCheck" class="dashAnchor"></a>
|
||||
<a title="PerformCheck Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
PerformCheck Enumeration Reference
|
||||
</p>
|
||||
</div>
|
||||
<div class="content-wrapper">
|
||||
<nav class="sidebar">
|
||||
<ul class="nav-groups">
|
||||
<li class="nav-group-name">
|
||||
<a href="../Classes.html">Classes</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Enums.html">Enumerations</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/AlertAction.html">AlertAction</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Structs.html">Structures</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization/Language.html">– Language</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/PresentationManager.html">PresentationManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Results.html">Results</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Rules.html">Rules</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Rules/AlertType.html">– AlertType</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Rules/UpdatePromptFrequency.html">– UpdatePromptFrequency</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/RulesManager.html">RulesManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/RulesManager/UpdateType.html">– UpdateType</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<article class="main-content">
|
||||
<section>
|
||||
<section class="section">
|
||||
<h1>PerformCheck</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">PerformCheck</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>The type of check to perform when Siren’s <code>wail</code> method is performed.</p>
|
||||
<div class="aside aside-note">
|
||||
<p class="aside-title">Note</p>
|
||||
Alert presentation will still respct the settings that are set
|
||||
for <code>UpdatePromptFrequency</code> and <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code>
|
||||
|
||||
</div>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12PerformCheckO8onDemandyA2CmF"></a>
|
||||
<a name="//apple_ref/swift/Element/onDemand" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12PerformCheckO8onDemandyA2CmF">onDemand</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Performs a version check only when Siren’s <code>wail</code> method is called,
|
||||
as the <code>UIApplication.didBecomeActiveNotification</code> is ignored.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">onDemand</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12PerformCheckO12onForegroundyA2CmF"></a>
|
||||
<a name="//apple_ref/swift/Element/onForeground" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12PerformCheckO12onForegroundyA2CmF">onForeground</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>(DEFAULT) Perform a version check whenever the app enters the foreground.
|
||||
This value must be set when Siren’s <code>wail</code> method is called to enable the
|
||||
<code>UIApplication.didBecomeActiveNotification</code> observer.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">onForeground</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
</body>
|
||||
</div>
|
||||
</html>
|
||||
Vendored
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -262,8 +265,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -423,8 +426,8 @@ if the aforementioned values are nil.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -310,8 +313,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -247,8 +250,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -239,8 +242,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -170,33 +173,6 @@
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:So14NSUserDefaultsC5SirenE43shouldPerformVersionCheckOnSubsequentLaunchSbvpZ"></a>
|
||||
<a name="//apple_ref/swift/Variable/shouldPerformVersionCheckOnSubsequentLaunch" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE43shouldPerformVersionCheckOnSubsequentLaunchSbvpZ">shouldPerformVersionCheckOnSubsequentLaunch</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Sets and Gets a <code>UserDefault</code> around performing a version check on a subsequent launch.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">static</span> <span class="k">var</span> <span class="nv">shouldPerformVersionCheckOnSubsequentLaunch</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -256,8 +232,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -230,8 +233,8 @@ the Siren alert the next time the user launches the app.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
Vendored
+74
-4
@@ -14,12 +14,12 @@
|
||||
<a title="Structures Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="index.html">in-acl Reference</a>
|
||||
<a href="index.html">Siren Reference</a>
|
||||
<img id="carat" src="img/carat.png" />
|
||||
Structures Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -356,11 +394,43 @@
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10DataParserV"></a>
|
||||
<a name="//apple_ref/swift/Struct/DataParser" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10DataParserV">DataParser</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Version parsing functions for Siren.</p>
|
||||
|
||||
<a href="Structs/DataParser.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">DataParser</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="APIManager Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
APIManager Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -108,6 +146,92 @@
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10APIManagerV9Constants33_8071139324B24E2065F4037045A8D960LLV"></a>
|
||||
<a name="//apple_ref/swift/Struct/Constants" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10APIManagerV9Constants33_8071139324B24E2065F4037045A8D960LLV">Constants</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Constants used in the <code><a href="../Structs/APIManager.html">APIManager</a></code>.</p>
|
||||
|
||||
<a href="../Structs/APIManager/Constants.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">struct</span> <span class="kt">Constants</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10APIManagerV17CompletionHandlera"></a>
|
||||
<a name="//apple_ref/swift/Alias/CompletionHandler" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10APIManagerV17CompletionHandlera">CompletionHandler</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Return results or errors obtained from performing a version check with Siren.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">CompletionHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span><span class="p">?,</span> <span class="kt"><a href="../Enums/KnownError.html">KnownError</a></span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10APIManagerV11countryCodeSSSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/countryCode" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10APIManagerV11countryCodeSSSgvp">countryCode</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The region or country of an App Store in which the app is available.
|
||||
By default, all version check requests are performed against the US App Store.
|
||||
If the app is not available in the US App Store, set it to the identifier of at least one App Store region within which it is available.</p>
|
||||
|
||||
<p><a href="https://help.apple.com/app-store-connect/#/dev997f9cf7c">List of country codes</a></p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">countryCode</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -189,11 +313,182 @@ If the app is not available in the US App Store, set it to the identifier of at
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10APIManagerV26performVersionCheckRequest10completionyyAA11LookupModelVSg_AA10KnownErrorOSgtcSg_tF"></a>
|
||||
<a name="//apple_ref/swift/Method/performVersionCheckRequest(completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10APIManagerV26performVersionCheckRequest10completionyyAA11LookupModelVSg_AA10KnownErrorOSgtcSg_tF">performVersionCheckRequest(completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Creates and performs a URLRequest against the iTunes Lookup API.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">performVersionCheckRequest</span><span class="p">(</span><span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Structs/APIManager.html#/s:5Siren10APIManagerV17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>handler</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The completion handler for the iTunes Lookup API request.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10APIManagerV26processVersionCheckResults33_8071139324B24E2065F4037045A8D960LL8withData8response5error10completiony10Foundation0M0VSg_So13NSURLResponseCSgs5Error_pSgyAA11LookupModelVSg_AA05KnownS0OSgtcSgtF"></a>
|
||||
<a name="//apple_ref/swift/Method/processVersionCheckResults(withData:response:error:completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10APIManagerV26processVersionCheckResults33_8071139324B24E2065F4037045A8D960LL8withData8response5error10completiony10Foundation0M0VSg_So13NSURLResponseCSgs5Error_pSgyAA11LookupModelVSg_AA05KnownS0OSgtcSgtF">processVersionCheckResults(withData:response:error:completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Parses and maps the the results from the iTunes Lookup API request.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">processVersionCheckResults</span><span class="p">(</span><span class="n">withData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span>
|
||||
<span class="nv">response</span><span class="p">:</span> <span class="kt">URLResponse</span><span class="p">?,</span>
|
||||
<span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?,</span>
|
||||
<span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Structs/APIManager.html#/s:5Siren10APIManagerV17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>data</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The JSON data returned from the request.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>response</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The response metadata returned from the request.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>error</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The error returned from the request.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>handler</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The completion handler to call once the results of the request has been processed.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren10APIManagerV13makeITunesURL33_8071139324B24E2065F4037045A8D960LL10Foundation0E0VyKF"></a>
|
||||
<a name="//apple_ref/swift/Method/makeITunesURL()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren10APIManagerV13makeITunesURL33_8071139324B24E2065F4037045A8D960LL10Foundation0E0VyKF">makeITunesURL()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Creates the URL that points to the iTunes Lookup API.</p>
|
||||
<div class="aside aside-throws">
|
||||
<p class="aside-title">Throws</p>
|
||||
An error if the URL cannot be created.
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">makeITunesURL</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">URL</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>The iTunes Lookup API URL.</p>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -202,8 +205,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="AlertConstants Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
AlertConstants Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -248,8 +286,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -375,8 +378,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="Localization Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
Localization Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -139,6 +177,120 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12LocalizationV7appName33_2FDBEF65899237DA36B11FA5846AD0EALLSSvp"></a>
|
||||
<a name="//apple_ref/swift/Property/appName" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12LocalizationV7appName33_2FDBEF65899237DA36B11FA5846AD0EALLSSvp">appName</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The name of the app as defined by the <code>Info.plist</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="k">var</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12LocalizationV13forceLanguage33_2FDBEF65899237DA36B11FA5846AD0EALLAC0D0OSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/forceLanguage" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12LocalizationV13forceLanguage33_2FDBEF65899237DA36B11FA5846AD0EALLAC0D0OSgvp">forceLanguage</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Overrides the default localization of a user’s device when presenting the update message and button titles in the alert.</p>
|
||||
|
||||
<p>See the Siren.Localization.Language enum for more details.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="k">let</span> <span class="nv">forceLanguage</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization/Language.html">Language</a></span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12LocalizationV7appName016andForceLanguageB0ACSSSg_AC0G0OSgtcfc"></a>
|
||||
<a name="//apple_ref/swift/Method/init(appName:andForceLanguageLocalization:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12LocalizationV7appName016andForceLanguageB0ACSSSg_AC0G0OSgtcfc">init(appName:andForceLanguageLocalization:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Initializes</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="n">andForceLanguageLocalization</span> <span class="nv">forceLanguage</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization/Language.html">Language</a></span><span class="p">?)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>appName</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Overrides the default name of the app. This is optional and defaults to the app that is defined in the <code>Info.plist</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>forceLanguage</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The language the alert to which the alert should be set. If <code>nil</code>, it falls back to the device’s preferred locale.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -299,8 +451,8 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="Language Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../../index.html">in-acl Reference</a>
|
||||
<a href="../../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../../img/carat.png" />
|
||||
Language Enumeration Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -1250,8 +1288,8 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="LookupModel Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
LookupModel Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -108,6 +146,34 @@
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren11LookupModelV10CodingKeys33_F2A9942F3CA9D99FD9845937489F40B8LLO"></a>
|
||||
<a name="//apple_ref/swift/Enum/CodingKeys" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren11LookupModelV10CodingKeys33_F2A9942F3CA9D99FD9845937489F40B8LLO">CodingKeys</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Codable Coding Keys for the Top-Level iTunes Lookup API JSON response.</p>
|
||||
|
||||
<a href="../Structs/LookupModel/CodingKeys.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">enum</span> <span class="kt">CodingKeys</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CodingKey</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -168,8 +234,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -175,8 +178,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="Results Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../../index.html">in-acl Reference</a>
|
||||
<a href="../../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../../img/carat.png" />
|
||||
Results Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -108,6 +146,34 @@
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren11LookupModelV7ResultsV10CodingKeys33_F2A9942F3CA9D99FD9845937489F40B8LLO"></a>
|
||||
<a name="//apple_ref/swift/Enum/CodingKeys" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren11LookupModelV7ResultsV10CodingKeys33_F2A9942F3CA9D99FD9845937489F40B8LLO">CodingKeys</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Codable Coding Keys for the Results array in the iTunes Lookup API JSON response.</p>
|
||||
|
||||
<a href="../../Structs/LookupModel/Results/CodingKeys.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">enum</span> <span class="kt">CodingKeys</span> <span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CodingKey</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -248,8 +314,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -283,8 +286,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="PresentationManager Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
PresentationManager Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -108,6 +146,276 @@
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV17CompletionHandlera"></a>
|
||||
<a name="//apple_ref/swift/Alias/CompletionHandler" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV17CompletionHandlera">CompletionHandler</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Return results or errors obtained from performing a version check with Siren.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">typealias</span> <span class="kt">CompletionHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="../Enums/AlertAction.html">AlertAction</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV12localizationAA12LocalizationVvp"></a>
|
||||
<a name="//apple_ref/swift/Property/localization" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV12localizationAA12LocalizationVvp">localization</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The localization data structure that will be used to construct localized strings for the update alert.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">localization</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization.html">Localization</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV9tintColorSo7UIColorCSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/tintColor" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV9tintColorSo7UIColorCSgvp">tintColor</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The tint color of the <code>UIAlertController</code> buttons.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">tintColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV12alertMessageSSvp"></a>
|
||||
<a name="//apple_ref/swift/Property/alertMessage" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV12alertMessageSSvp">alertMessage</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The descriptive update message of the <code>UIAlertController</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">alertMessage</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV10alertTitleSSvp"></a>
|
||||
<a name="//apple_ref/swift/Property/alertTitle" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV10alertTitleSSvp">alertTitle</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The main message of the <code>UIAlertController</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">alertTitle</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV19nextTimeButtonTitleSSvp"></a>
|
||||
<a name="//apple_ref/swift/Property/nextTimeButtonTitle" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV19nextTimeButtonTitleSSvp">nextTimeButtonTitle</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <q>Next time</q> button text of the <code>UIAlertController</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">nextTimeButtonTitle</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV15skipButtonTitleSSvp"></a>
|
||||
<a name="//apple_ref/swift/Property/skipButtonTitle" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV15skipButtonTitleSSvp">skipButtonTitle</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <q>Skip this version</q> button text of the <code>UIAlertController</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">skipButtonTitle</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV17updateButtonTitleSSvp"></a>
|
||||
<a name="//apple_ref/swift/Property/updateButtonTitle" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV17updateButtonTitleSSvp">updateButtonTitle</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <q>Update</q> button text of the <code>UIAlertController</code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">updateButtonTitle</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV15alertControllerSo07UIAlertE0CSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/alertController" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV15alertControllerSo07UIAlertE0CSgvp">alertController</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The instance of the <code>UIAlertController</code> used to present the update alert.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertController</span><span class="p">:</span> <span class="kt">UIAlertController</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV13updaterWindow33_CEF2109017F934DAB33AED8753BA096CLLSo8UIWindowCvp"></a>
|
||||
<a name="//apple_ref/swift/Property/updaterWindow" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV13updaterWindow33_CEF2109017F934DAB33AED8753BA096CLLSo8UIWindowCvp">updaterWindow</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>UIWindow</code> instance that presents the <code><a href="../Classes/SirenViewController.html">SirenViewController</a></code>.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="k">var</span> <span class="nv">updaterWindow</span><span class="p">:</span> <span class="kt">UIWindow</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -130,11 +438,11 @@
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">alertTintColor</span> <span class="nv">tintColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
|
||||
<span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
|
||||
<span class="nv">alertTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n">alertTitle</span><span class="p">,</span>
|
||||
<span class="nv">alertMessage</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n">alertMessage</span><span class="p">,</span>
|
||||
<span class="nv">updateButtonTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n">updateButtonTitle</span><span class="p">,</span>
|
||||
<span class="nv">nextTimeButtonTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n">nextTimeButtonTitle</span><span class="p">,</span>
|
||||
<span class="nv">skipButtonTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n">skipButtonTitle</span><span class="p">,</span>
|
||||
<span class="nv">alertTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV10alertTitleSSvp">alertTitle</a></span><span class="p">,</span>
|
||||
<span class="nv">alertMessage</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV12alertMessageSSvp">alertMessage</a></span><span class="p">,</span>
|
||||
<span class="nv">updateButtonTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV17updateButtonTitleSSvp">updateButtonTitle</a></span><span class="p">,</span>
|
||||
<span class="nv">nextTimeButtonTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV19nextTimeButtonTitleSSvp">nextTimeButtonTitle</a></span><span class="p">,</span>
|
||||
<span class="nv">skipButtonTitle</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt"><a href="../Structs/AlertConstants.html">AlertConstants</a></span><span class="o">.</span><span class="n"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV15skipButtonTitleSSvp">skipButtonTitle</a></span><span class="p">,</span>
|
||||
<span class="n">forceLanguageLocalization</span> <span class="nv">forceLanguage</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization.html">Localization</a></span><span class="o">.</span><span class="kt">Language</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
@@ -282,11 +590,276 @@
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV12presentAlert9withRules25forCurrentAppStoreVersion10completionyAA0G0V_SSyAA0E6ActionOcSgtF"></a>
|
||||
<a name="//apple_ref/swift/Method/presentAlert(withRules:forCurrentAppStoreVersion:completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV12presentAlert9withRules25forCurrentAppStoreVersion10completionyAA0G0V_SSyAA0E6ActionOcSgtF">presentAlert(withRules:forCurrentAppStoreVersion:completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Constructs the localized update alert <code>UIAlertController</code> object.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">mutating</span> <span class="kd">func</span> <span class="nf">presentAlert</span><span class="p">(</span><span class="n">withRules</span> <span class="nv">rules</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules.html">Rules</a></span><span class="p">,</span>
|
||||
<span class="n">forCurrentAppStoreVersion</span> <span class="nv">currentAppStoreVersion</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
|
||||
<span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>rules</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The rules that are used to define the type of alert that should be presented.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>currentAppStoreVersion</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The current version of the app in the App Store.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>handler</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The completion handler that returns the an <code><a href="../Enums/AlertAction.html">AlertAction</a></code> depending on the type of action the end-user took.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV17updateAlertAction33_CEF2109017F934DAB33AED8753BA096CLL10completionSo07UIAlertF0CyAA0eF0OcSg_tF"></a>
|
||||
<a name="//apple_ref/swift/Method/updateAlertAction(completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV17updateAlertAction33_CEF2109017F934DAB33AED8753BA096CLL10completionSo07UIAlertF0CyAA0eF0OcSg_tF">updateAlertAction(completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>UIAlertAction</code> that is executed when the <code>Update</code> option is selected.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">updateAlertAction</span><span class="p">(</span><span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span> <span class="o">-></span> <span class="kt">UIAlertAction</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>handler</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The completion handler that returns the <code>.update</code> option.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>The <code>Update</code> alert action.</p>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV19nextTimeAlertAction33_CEF2109017F934DAB33AED8753BA096CLL10completionSo07UIAlertG0CyAA0fG0OcSg_tF"></a>
|
||||
<a name="//apple_ref/swift/Method/nextTimeAlertAction(completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV19nextTimeAlertAction33_CEF2109017F934DAB33AED8753BA096CLL10completionSo07UIAlertG0CyAA0fG0OcSg_tF">nextTimeAlertAction(completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>UIAlertAction</code> that is executed when the <code>Next time</code> option is selected.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">nextTimeAlertAction</span><span class="p">(</span><span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span> <span class="o">-></span> <span class="kt">UIAlertAction</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>handler</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The completion handler that returns the <code>.nextTime</code> option.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>The <code>Next time</code> alert action.</p>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV15skipAlertAction33_CEF2109017F934DAB33AED8753BA096CLL25forCurrentAppStoreVersion10completionSo07UIAlertF0CSS_yAA0eF0OcSgtF"></a>
|
||||
<a name="//apple_ref/swift/Method/skipAlertAction(forCurrentAppStoreVersion:completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV15skipAlertAction33_CEF2109017F934DAB33AED8753BA096CLL25forCurrentAppStoreVersion10completionSo07UIAlertF0CSS_yAA0eF0OcSgtF">skipAlertAction(forCurrentAppStoreVersion:completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code>UIAlertAction</code> that is executed when the <code>Skip this version</code> option is selected.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">skipAlertAction</span><span class="p">(</span><span class="n">forCurrentAppStoreVersion</span> <span class="nv">currentAppStoreVersion</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV17CompletionHandlera">CompletionHandler</a></span><span class="p">?)</span> <span class="o">-></span> <span class="kt">UIAlertAction</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>currentAppStoreVersion</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The current version of the app in the App Store.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>handler</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The completion handler that returns the <code>.skip</code> option.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>The <code>Skip this version</code> alert action.</p>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren19PresentationManagerV22cleanUpAlertController33_CEF2109017F934DAB33AED8753BA096CLLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/cleanUpAlertController()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren19PresentationManagerV22cleanUpAlertController33_CEF2109017F934DAB33AED8753BA096CLLyyF">cleanUpAlertController()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Removes the <code><a href="../Structs/PresentationManager.html#/s:5Siren19PresentationManagerV15alertControllerSo07UIAlertE0CSgvp">alertController</a></code> from memory.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">func</span> <span class="nf">cleanUpAlertController</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="Results Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
Results Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -156,7 +194,7 @@ Defaults to <code>unknown</code> until an alert is actually presented.</p>
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">localization</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization.html">Localization</a></span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">localization</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization.html">Localization</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -183,7 +221,7 @@ Defaults to <code>unknown</code> until an alert is actually presented.</p>
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lookupModel</span><span class="p">:</span> <span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">lookupModel</span><span class="p">:</span> <span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -222,8 +260,8 @@ Defaults to <code>unknown</code> until an alert is actually presented.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+124
-4
@@ -14,12 +14,12 @@
|
||||
<a title="Rules Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
Rules Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -108,6 +146,61 @@
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren5RulesV9alertTypeAC05AlertD0Ovp"></a>
|
||||
<a name="//apple_ref/swift/Property/alertType" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren5RulesV9alertTypeAC05AlertD0Ovp">alertType</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The type of alert that should be presented.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">alertType</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules/AlertType.html">AlertType</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren5RulesV9frequencyAC21UpdatePromptFrequencyOvp"></a>
|
||||
<a name="//apple_ref/swift/Property/frequency" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren5RulesV9frequencyAC21UpdatePromptFrequencyOvp">frequency</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The frequency in which a the user is prompted to update the app
|
||||
once a new version is available in the App Store and if they have not updated yet.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">frequency</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules/UpdatePromptFrequency.html">UpdatePromptFrequency</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -251,6 +344,33 @@ the next time the app becomes active or skipping the update all together until a
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren5RulesV7hintingACvpZ"></a>
|
||||
<a name="//apple_ref/swift/Variable/hinting" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren5RulesV7hintingACvpZ">hinting</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Performs a version check weekly, but allows the user to skip updating the app until the next time the app becomes active.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">hinting</span><span class="p">:</span> <span class="kt">Rules</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -372,8 +492,8 @@ once a new version is available in the App Store and if they have not updated ye
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="AlertType Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../../index.html">in-acl Reference</a>
|
||||
<a href="../../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../../img/carat.png" />
|
||||
AlertType Enumeration Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -222,8 +260,8 @@ Use this option if you would like to present a custom alert to the end-user.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="UpdatePromptFrequency Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../../index.html">in-acl Reference</a>
|
||||
<a href="../../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../../img/carat.png" />
|
||||
UpdatePromptFrequency Enumeration Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -195,8 +233,8 @@ once a new version is available in the App Store and if they have not updated ye
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="RulesManager Structure Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">in-acl Reference</a>
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
RulesManager Structure Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -108,6 +146,144 @@
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12RulesManagerV15releasedForDaysSivp"></a>
|
||||
<a name="//apple_ref/swift/Property/releasedForDays" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12RulesManagerV15releasedForDaysSivp">releasedForDays</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The alert will only show up if the current version has already been released for X days.</p>
|
||||
|
||||
<p>This value defaults to 1 day (in <code>RulesManager</code>‘s initializer) to avoid an issue where
|
||||
Apple updates the JSON faster than the app binary propogates to the App Store.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">releasedForDays</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12RulesManagerV011majorUpdateB0AA0B0Vvp"></a>
|
||||
<a name="//apple_ref/swift/Property/majorUpdateRules" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12RulesManagerV011majorUpdateB0AA0B0Vvp">majorUpdateRules</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code><a href="../Structs/Rules.html">Rules</a></code> that should be used when the App Store version of the app signifies that it is a <strong>major</strong> version update (A.b.c.d).</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">majorUpdateRules</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules.html">Rules</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12RulesManagerV011minorUpdateB0AA0B0Vvp"></a>
|
||||
<a name="//apple_ref/swift/Property/minorUpdateRules" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12RulesManagerV011minorUpdateB0AA0B0Vvp">minorUpdateRules</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code><a href="../Structs/Rules.html">Rules</a></code> that should be used when the App Store version of the app signifies that it is a <strong>minor</strong> version update (a.B.c.d).</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">minorUpdateRules</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules.html">Rules</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12RulesManagerV011patchUpdateB0AA0B0Vvp"></a>
|
||||
<a name="//apple_ref/swift/Property/patchUpdateRules" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12RulesManagerV011patchUpdateB0AA0B0Vvp">patchUpdateRules</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code><a href="../Structs/Rules.html">Rules</a></code> that should be used when the App Store version of the app signifies that it is a <strong>patch</strong> version update (a.b.C.d).</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">patchUpdateRules</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules.html">Rules</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12RulesManagerV014revisionUpdateB0AA0B0Vvp"></a>
|
||||
<a name="//apple_ref/swift/Property/revisionUpdateRules" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12RulesManagerV014revisionUpdateB0AA0B0Vvp">revisionUpdateRules</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The <code><a href="../Structs/Rules.html">Rules</a></code> that should be used when the App Store version of the app signifies that it is a <strong>revision</strong> version update (a.b.c.D).</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">revisionUpdateRules</span><span class="p">:</span> <span class="kt"><a href="../Structs/Rules.html">Rules</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -124,12 +300,12 @@
|
||||
<p>Initializer that sets update-specific <code><a href="../Structs/Rules.html">Rules</a></code> for all updates (e.g., major, minor, patch, revision).
|
||||
This means that each of the four update types can have their own specific update rules.</p>
|
||||
|
||||
<p>By default, the <code>releasedForDays</code> parameter delays the update alert from being presented for <em>1 day</em>
|
||||
<p>By default, the <code><a href="../Structs/RulesManager.html#/s:5Siren12RulesManagerV15releasedForDaysSivp">releasedForDays</a></code> parameter delays the update alert from being presented for <em>1 day</em>
|
||||
to avoid an issue where the <em>iTunes Lookup</em> API response is updated faster than the time it takes for the binary
|
||||
to become available on App Store CDNs across all regions. Usually it takes 6-24 hours, hence the <em>1 day</em> delay.</p>
|
||||
<div class="aside aside-warning">
|
||||
<p class="aside-title">Warning</p>
|
||||
<p>Setting <code>releasedForDays</code> to <em>0 days</em> causes the alert to appear right away, even if the binary isn’t available.
|
||||
<p>Setting <code><a href="../Structs/RulesManager.html#/s:5Siren12RulesManagerV15releasedForDaysSivp">releasedForDays</a></code> to <em>0 days</em> causes the alert to appear right away, even if the binary isn’t available.
|
||||
If this value is set to <em>0 days</em>, and an <code>AlertType</code> of type <code>.force</code> is set, it will cause your app to infinitely send the
|
||||
end-user to the App Store to download a version that’s not there and lock them out of your application until the binary is
|
||||
is available to be downloaded.</p>
|
||||
@@ -199,12 +375,12 @@ is available to be downloaded.</p>
|
||||
<p>Initializer that sets the same update <code><a href="../Structs/Rules.html">Rules</a></code> for all types of updates (e.g., major, minor, patch, revision).
|
||||
This means that all four update types will use the same presentation rules.</p>
|
||||
|
||||
<p>By default, the <code>releasedForDays</code> parameter delays the update alert from being presented for <em>1 day</em>
|
||||
<p>By default, the <code><a href="../Structs/RulesManager.html#/s:5Siren12RulesManagerV15releasedForDaysSivp">releasedForDays</a></code> parameter delays the update alert from being presented for <em>1 day</em>
|
||||
to avoid an issue where the <em>iTunes Lookup</em> API response is updated faster than the time it takes for the binary
|
||||
to become available on App Store CDNs across all regions. Usually it takes 6-24 hours, hence the <em>1 day</em> delay.</p>
|
||||
<div class="aside aside-warning">
|
||||
<p class="aside-title">Warning</p>
|
||||
<p>Setting <code>releasedForDays</code> to <em>0 days</em> causes the alert to appear right away, even if the binary isn’t available.
|
||||
<p>Setting <code><a href="../Structs/RulesManager.html#/s:5Siren12RulesManagerV15releasedForDaysSivp">releasedForDays</a></code> to <em>0 days</em> causes the alert to appear right away, even if the binary isn’t available.
|
||||
If this value is set to <em>0 days</em>, and an <code>AlertType</code> of type <code>.force</code> is set, it will cause your app to infinitely send the
|
||||
end-user to the App Store to download a version that’s not there and lock them out of your application until the binary is
|
||||
is available to be downloaded.</p>
|
||||
@@ -255,6 +431,56 @@ is available to be downloaded.</p>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12RulesManagerV04loadB13ForUpdateTypeyAA0B0VAC0fG0OF"></a>
|
||||
<a name="//apple_ref/swift/Method/loadRulesForUpdateType(_:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12RulesManagerV04loadB13ForUpdateTypeyAA0B0VAC0fG0OF">loadRulesForUpdateType(_:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Returns the appropriate update rules based on the type of version that is returned from the API.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">loadRulesForUpdateType</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Structs/RulesManager/UpdateType.html">UpdateType</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Structs/Rules.html">Rules</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>type</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The type of app update.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Return Value</h4>
|
||||
<p>The appropriate rule based on the type of app update that is returned by the API.</p>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -337,8 +563,8 @@ the appropriate ruleset is used to present the update alert.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -14,12 +14,12 @@
|
||||
<a title="UpdateType Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../../index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../../index.html">in-acl Reference</a>
|
||||
<a href="../../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../../img/carat.png" />
|
||||
UpdateType Enumeration Reference
|
||||
</p>
|
||||
@@ -33,6 +33,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -44,6 +47,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -52,9 +81,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -64,6 +99,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -257,8 +295,8 @@ the appropriate ruleset is used to present the update alert.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+9
-6
@@ -150,7 +150,7 @@ header {
|
||||
margin-left: 246px;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
padding-bottom: 60px;
|
||||
padding-bottom: 20px;
|
||||
top: 70px;
|
||||
width: 734px; }
|
||||
.main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
|
||||
@@ -216,10 +216,12 @@ header {
|
||||
.item code {
|
||||
background-color: transparent;
|
||||
padding: 0; }
|
||||
.item .token {
|
||||
.item .token, .item .direct-link {
|
||||
padding-left: 3px;
|
||||
margin-left: 15px;
|
||||
font-size: 11.9px; }
|
||||
.item .discouraged {
|
||||
text-decoration: line-through; }
|
||||
.item .declaration-note {
|
||||
font-size: .85em;
|
||||
color: gray;
|
||||
@@ -283,9 +285,9 @@ header {
|
||||
.language .aside-title {
|
||||
color: #4b8afb; }
|
||||
|
||||
.aside-warning {
|
||||
.aside-warning, .aside-deprecated, .aside-unavailable {
|
||||
border-left: 5px solid #ff6666; }
|
||||
.aside-warning .aside-title {
|
||||
.aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title {
|
||||
color: #ff0000; }
|
||||
|
||||
.graybox {
|
||||
@@ -310,8 +312,9 @@ header {
|
||||
font-size: 0.9em; }
|
||||
|
||||
#footer {
|
||||
position: absolute;
|
||||
bottom: 10px;
|
||||
position: relative;
|
||||
top: 10px;
|
||||
bottom: 0px;
|
||||
margin-left: 25px; }
|
||||
#footer p {
|
||||
margin: 0;
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -202,8 +205,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -344,6 +347,33 @@ skipping the update all together until another version is released.</p>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC24willResignActiveObserverSo8NSObject_pSgvp"></a>
|
||||
<a name="//apple_ref/swift/Property/willResignActiveObserver" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC24willResignActiveObserverSo8NSObject_pSgvp">willResignActiveObserver</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The retained <code>NotificationCenter</code> observer that listens for <code>UIApplication.willResignActiveNotification</code> notifications.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">willResignActiveObserver</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span><span class="p">?</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -455,9 +485,9 @@ skipping the update all together until another version is released.</p>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/c:@M@Siren@objc(cs)Siren(im)init"></a>
|
||||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/c:@M@Siren@objc(cs)Siren(im)init">init()</a>
|
||||
<a name="/c:@M@Siren@objc(cs)Siren(im)dealloc"></a>
|
||||
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
|
||||
<a class="token" href="#/c:@M@Siren@objc(cs)Siren(im)dealloc">deinit</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
@@ -465,14 +495,14 @@ skipping the update all together until another version is released.</p>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The initialization method.</p>
|
||||
<p>The deinitialization method that clears out all observers,</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">private</span> <span class="k">override</span> <span class="nf">init</span><span class="p">()</span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -493,9 +523,9 @@ skipping the update all together until another version is released.</p>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC4wail10completionyyAA7ResultsVSg_AA10KnownErrorOSgtcSg_tF"></a>
|
||||
<a name="//apple_ref/swift/Method/wail(completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC4wail10completionyyAA7ResultsVSg_AA10KnownErrorOSgtcSg_tF">wail(completion:)</a>
|
||||
<a name="/s:5SirenAAC4wail12performCheck10completionyAA07PerformD0O_yAA7ResultsVSg_AA10KnownErrorOSgtcSgtF"></a>
|
||||
<a name="//apple_ref/swift/Method/wail(performCheck:completion:)" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC4wail12performCheck10completionyAA07PerformD0O_yAA7ResultsVSg_AA10KnownErrorOSgtcSgtF">wail(performCheck:completion:)</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
@@ -510,7 +540,8 @@ skipping the update all together until another version is released.</p>
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">wail</span><span class="p">(</span><span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren.html#/s:5SirenAAC14ResultsHandlera">ResultsHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">wail</span><span class="p">(</span><span class="nv">performCheck</span><span class="p">:</span> <span class="kt"><a href="../Enums/PerformCheck.html">PerformCheck</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">onForeground</span><span class="p">,</span>
|
||||
<span class="n">completion</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren.html#/s:5SirenAAC14ResultsHandlera">ResultsHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -518,6 +549,18 @@ skipping the update all together until another version is released.</p>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>performCheck</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>Defines how the version check flow is entered. Defaults to <code>.onForeground</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
@@ -801,46 +844,19 @@ Upon tapping a value on the alert view, a completion handler will return all rel
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Observers"></a>
|
||||
<a name="//apple_ref/swift/Section/Observers" class="dashAnchor"></a>
|
||||
<a href="#/Observers">
|
||||
<h3 class="section-name">Observers</h3>
|
||||
<a name="/Add%20Observers"></a>
|
||||
<a name="//apple_ref/swift/Section/Add Observers" class="dashAnchor"></a>
|
||||
<a href="#/Add%20Observers">
|
||||
<h3 class="section-name">Add Observers</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC12addObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/addObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC12addObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">addObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Add app state observers</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC21addForegroundObserver33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/addForegroundObserver()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC21addForegroundObserver33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">addForegroundObserver()</a>
|
||||
<a name="/s:5SirenAAC22addForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/addForegroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC22addForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">addForegroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
@@ -855,7 +871,7 @@ Upon tapping a value on the alert view, a completion handler will return all rel
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addForegroundObserver</span><span class="p">()</span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addForegroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -865,9 +881,9 @@ Upon tapping a value on the alert view, a completion handler will return all rel
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC21addBackgroundObserver33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/addBackgroundObserver()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC21addBackgroundObserver33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">addBackgroundObserver()</a>
|
||||
<a name="/s:5SirenAAC22addBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/addBackgroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC22addBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">addBackgroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
@@ -875,14 +891,80 @@ Upon tapping a value on the alert view, a completion handler will return all rel
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Adds an observer that listens for when the app is sent to the background.</p>
|
||||
<p>Adds an observer that listens for when the user enters the app switcher
|
||||
and when the app is sent to the background.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addBackgroundObserver</span><span class="p">()</span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addBackgroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<div class="task-name-container">
|
||||
<a name="/Remove%20Observers"></a>
|
||||
<a name="//apple_ref/swift/Section/Remove Observers" class="dashAnchor"></a>
|
||||
<a href="#/Remove%20Observers">
|
||||
<h3 class="section-name">Remove Observers</h3>
|
||||
</a>
|
||||
</div>
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC25removeForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/removeForegroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC25removeForegroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">removeForegroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Removes the observer that listens for app launching/relaunching.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeForegroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5SirenAAC25removeBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF"></a>
|
||||
<a name="//apple_ref/swift/Method/removeBackgroundObservers()" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5SirenAAC25removeBackgroundObservers33_7DFB1BC200A6C64FBED860A3A8153B65LLyyF">removeBackgroundObservers()</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Remove the observers that list to app resignation and app backgrounding.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeBackgroundObservers</span><span class="p">()</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -894,8 +976,8 @@ Upon tapping a value on the alert view, a completion handler will return all rel
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -175,8 +178,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -167,6 +170,44 @@
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12PerformCheckO"></a>
|
||||
<a name="//apple_ref/swift/Enum/PerformCheck" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12PerformCheckO">PerformCheck</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The type of check to perform when Siren’s <code>wail</code> method is performed.</p>
|
||||
<div class="aside aside-note">
|
||||
<p class="aside-title">Note</p>
|
||||
Alert presentation will still respct the settings that are set
|
||||
for <code>UpdatePromptFrequency</code> and <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code>
|
||||
|
||||
</div>
|
||||
|
||||
<a href="Enums/PerformCheck.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">PerformCheck</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
@@ -202,8 +243,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -256,8 +259,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -426,7 +429,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the <code>UpdatePromptFrequency.immediately</code> rule in <code><a href="../Structs/RulesManager.html">RulesManager</a></code></p>
|
||||
<p>Siren will not present an update alert if it performed one too recently. If you would like to present an alert every time Siren is called, please consider setting the <code>UpdatePromptFrequency.immediately</code> rule in <code><a href="../Structs/RulesManager.html">RulesManager</a></code></p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -553,8 +556,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,224 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>PerformCheck Enumeration Reference</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
||||
<meta charset='utf-8'>
|
||||
<script src="../js/jquery.min.js" defer></script>
|
||||
<script src="../js/jazzy.js" defer></script>
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<a name="//apple_ref/swift/Enum/PerformCheck" class="dashAnchor"></a>
|
||||
<a title="PerformCheck Enumeration Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="../index.html">Siren Reference</a>
|
||||
<img id="carat" src="../img/carat.png" />
|
||||
PerformCheck Enumeration Reference
|
||||
</p>
|
||||
</div>
|
||||
<div class="content-wrapper">
|
||||
<nav class="sidebar">
|
||||
<ul class="nav-groups">
|
||||
<li class="nav-group-name">
|
||||
<a href="../Classes.html">Classes</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Enums.html">Enumerations</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/AlertAction.html">AlertAction</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="../Structs.html">Structures</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Localization/Language.html">– Language</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/PresentationManager.html">PresentationManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Results.html">Results</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Rules.html">Rules</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Rules/AlertType.html">– AlertType</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/Rules/UpdatePromptFrequency.html">– UpdatePromptFrequency</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/RulesManager.html">RulesManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Structs/RulesManager/UpdateType.html">– UpdateType</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<article class="main-content">
|
||||
<section>
|
||||
<section class="section">
|
||||
<h1>PerformCheck</h1>
|
||||
<div class="declaration">
|
||||
<div class="language">
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">PerformCheck</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>The type of check to perform when Siren’s <code>wail</code> method is performed.</p>
|
||||
<div class="aside aside-note">
|
||||
<p class="aside-title">Note</p>
|
||||
Alert presentation will still respct the settings that are set
|
||||
for <code>UpdatePromptFrequency</code> and <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code>
|
||||
|
||||
</div>
|
||||
|
||||
</section>
|
||||
<section class="section task-group-section">
|
||||
<div class="task-group">
|
||||
<ul>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12PerformCheckO8onDemandyA2CmF"></a>
|
||||
<a name="//apple_ref/swift/Element/onDemand" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12PerformCheckO8onDemandyA2CmF">onDemand</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Performs a version check only when Siren’s <code>wail</code> method is called,
|
||||
as the <code>UIApplication.didBecomeActiveNotification</code> is ignored.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">onDemand</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren12PerformCheckO12onForegroundyA2CmF"></a>
|
||||
<a name="//apple_ref/swift/Element/onForeground" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren12PerformCheckO12onForegroundyA2CmF">onForeground</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>(DEFAULT) Perform a version check whenever the app enters the foreground.
|
||||
This value must be set when Siren’s <code>wail</code> method is called to enable the
|
||||
<code>UIApplication.didBecomeActiveNotification</code> observer.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">onForeground</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
</body>
|
||||
</div>
|
||||
</html>
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -262,8 +265,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -423,8 +426,8 @@ if the aforementioned values are nil.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -310,8 +313,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -247,8 +250,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -239,8 +242,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-29
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -170,33 +173,6 @@
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:So14NSUserDefaultsC5SirenE43shouldPerformVersionCheckOnSubsequentLaunchSbvpZ"></a>
|
||||
<a name="//apple_ref/swift/Variable/shouldPerformVersionCheckOnSubsequentLaunch" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE43shouldPerformVersionCheckOnSubsequentLaunchSbvpZ">shouldPerformVersionCheckOnSubsequentLaunch</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Sets and Gets a <code>UserDefault</code> around performing a version check on a subsequent launch.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">static</span> <span class="k">var</span> <span class="nv">shouldPerformVersionCheckOnSubsequentLaunch</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -256,8 +232,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -230,8 +233,8 @@ the Siren alert the next time the user launches the app.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -426,8 +429,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -484,8 +487,8 @@ If the app is not available in the US App Store, set it to the identifier of at
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -202,8 +205,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -283,8 +286,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -375,8 +378,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -448,8 +451,8 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -1285,8 +1288,8 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -231,8 +234,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -175,8 +178,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -311,8 +314,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -283,8 +286,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -855,8 +858,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -191,7 +194,7 @@ Defaults to <code>unknown</code> until an alert is actually presented.</p>
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">localization</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization.html">Localization</a></span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">localization</span><span class="p">:</span> <span class="kt"><a href="../Structs/Localization.html">Localization</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -218,7 +221,7 @@ Defaults to <code>unknown</code> until an alert is actually presented.</p>
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">lookupModel</span><span class="p">:</span> <span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span></code></pre>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">lookupModel</span><span class="p">:</span> <span class="kt"><a href="../Structs/LookupModel.html">LookupModel</a></span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -257,8 +260,8 @@ Defaults to <code>unknown</code> until an alert is actually presented.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -341,6 +344,33 @@ the next time the app becomes active or skipping the update all together until a
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:5Siren5RulesV7hintingACvpZ"></a>
|
||||
<a name="//apple_ref/swift/Variable/hinting" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:5Siren5RulesV7hintingACvpZ">hinting</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
<div class="pointer-container"></div>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Performs a version check weekly, but allows the user to skip updating the app until the next time the app becomes active.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">var</span> <span class="nv">hinting</span><span class="p">:</span> <span class="kt">Rules</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
@@ -462,8 +492,8 @@ once a new version is available in the App Store and if they have not updated ye
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -257,8 +260,8 @@ Use this option if you would like to present a custom alert to the end-user.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -230,8 +233,8 @@ once a new version is available in the App Store and if they have not updated ye
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -560,8 +563,8 @@ the appropriate ruleset is used to present the update alert.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
+5
-2
@@ -47,6 +47,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="../../Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -292,8 +295,8 @@ the appropriate ruleset is used to present the update alert.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
@@ -150,7 +150,7 @@ header {
|
||||
margin-left: 246px;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
padding-bottom: 60px;
|
||||
padding-bottom: 20px;
|
||||
top: 70px;
|
||||
width: 734px; }
|
||||
.main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
|
||||
@@ -216,10 +216,12 @@ header {
|
||||
.item code {
|
||||
background-color: transparent;
|
||||
padding: 0; }
|
||||
.item .token {
|
||||
.item .token, .item .direct-link {
|
||||
padding-left: 3px;
|
||||
margin-left: 15px;
|
||||
font-size: 11.9px; }
|
||||
.item .discouraged {
|
||||
text-decoration: line-through; }
|
||||
.item .declaration-note {
|
||||
font-size: .85em;
|
||||
color: gray;
|
||||
@@ -283,9 +285,9 @@ header {
|
||||
.language .aside-title {
|
||||
color: #4b8afb; }
|
||||
|
||||
.aside-warning {
|
||||
.aside-warning, .aside-deprecated, .aside-unavailable {
|
||||
border-left: 5px solid #ff6666; }
|
||||
.aside-warning .aside-title {
|
||||
.aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title {
|
||||
color: #ff0000; }
|
||||
|
||||
.graybox {
|
||||
@@ -310,8 +312,9 @@ header {
|
||||
font-size: 0.9em; }
|
||||
|
||||
#footer {
|
||||
position: absolute;
|
||||
bottom: 10px;
|
||||
position: relative;
|
||||
top: 10px;
|
||||
bottom: 0px;
|
||||
margin-left: 25px; }
|
||||
#footer p {
|
||||
margin: 0;
|
||||
|
||||
@@ -46,6 +46,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -136,26 +139,51 @@
|
||||
<p><a href="https://travis-ci.org/ArtSabintsev/Siren"><img src="https://travis-ci.org/ArtSabintsev/Siren.svg?branch=master" alt="Travis CI Status"></a> <img src="https://github.com/ArtSabintsev/Siren/blob/master/docs/badge.svg" alt="Documentation"> <img src="https://img.shields.io/badge/Swift-4.2%2C%204.1%2C%203.2%2C%203.1%202.3-orange.svg" alt="Swift Support"> <a href="https://cocoapods.org/pods/Siren"><img src="https://img.shields.io/cocoapods/v/Siren.svg" alt="CocoaPods"></a> <a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage Compatible"></a> <a href="https://swift.org/package-manager/"><img src="https://img.shields.io/badge/SwiftPM-compatible-brightgreen.svg" alt="SwiftPM Compatible"></a></p>
|
||||
|
||||
<hr>
|
||||
<h2 id='table-of-contents' class='heading'>Table of Contents</h2>
|
||||
<h1 id='table-of-contents' class='heading'>Table of Contents</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#meta"><strong>Meta</strong></a>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#about">About</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#features">Features</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#screenshots">Screenshots</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#ports">Ports</a></li>
|
||||
</ul></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#installation-and-integration"><strong>Installation and Integration</strong></a>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#installation-instructions">Installation Instructions</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#implementation-examples">Implementation Examples</a></li>
|
||||
</ul></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#device-specific-checks"><strong>Device-Specific Checks</strong></a>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#localization">Localization</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#device-compatibility">Device Compatibility</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#testing-siren">Testing Siren</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#app-store-submissions">App Store Review & Submissions</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#phased-releases">Phased Releases</a></li>
|
||||
</ul></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#testing"><strong>Testing</strong></a>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#testing-siren-locally">Testing Siren Locally</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#words-of-caution">Words of Caution</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#ports">Ports</a></li>
|
||||
</ul></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#app-submission"><strong>App Submission</strong></a>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#app-store-review">App Store Review</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#phased-releases">Phased Releases</a></li>
|
||||
</ul></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#attribution"><strong>Attribution</strong></a>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#special-thanks">Special Thanks</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#created-and-maintained-by">Attribution</a></li>
|
||||
<li><a href="https://github.com/ArtSabintsev/Siren#creator">Creator</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
<h1 id='meta' class='heading'>Meta</h1>
|
||||
<h2 id='about' class='heading'>About</h2>
|
||||
|
||||
<p><strong>Siren</strong> checks a user’s currently installed version of your iOS app against the version that is currently available in the App Store.</p>
|
||||
@@ -181,11 +209,9 @@
|
||||
</ul>
|
||||
<h3 id='future-features' class='heading'>Future Features</h3>
|
||||
|
||||
<ul>
|
||||
<li>[ ] Present prompt only on WiFi if app is over the OTA limit.</li>
|
||||
<li>[ ] Support for Third-Party/Homegrown Update Servers (not including TestFlight).</li>
|
||||
<li>[ ] Increase code coverage with more unit tests and UI tests.</li>
|
||||
</ul>
|
||||
<p>A list of future development work can be found on <a href="https://github.com/ArtSabintsev/Siren/projects/1">Siren’s Kanban Board</a>.</p>
|
||||
|
||||
<hr>
|
||||
<h2 id='screenshots' class='heading'>Screenshots</h2>
|
||||
|
||||
<ul>
|
||||
@@ -196,6 +222,32 @@
|
||||
</ul>
|
||||
|
||||
<p><img src="https://github.com/ArtSabintsev/Siren/blob/master/Assets/picForcedUpdate.png?raw=true" height="480"><img src="https://github.com/ArtSabintsev/Siren/blob/master/Assets/picOptionalUpdate.png?raw=true" height="480"><img src="https://github.com/ArtSabintsev/Siren/blob/master/Assets/picSkippedUpdate.png?raw=true" height="480"></p>
|
||||
<h2 id='ports' class='heading'>Ports</h2>
|
||||
|
||||
<ul>
|
||||
<li><strong>Objective-C (iOS)</strong>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Harpy"><strong>Harpy</strong></a></li>
|
||||
<li>Siren was ported <em>from</em> Harpy, as Siren and Harpy are maintained by the same developer.</li>
|
||||
<li>As of December 2018, Harpy has been deprecated in favor of Siren.</li>
|
||||
</ul></li>
|
||||
<li><strong>Java (Android)</strong>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/eggheadgames/Siren"><strong>Egghead Games’ Siren library</strong></a></li>
|
||||
<li>The Siren Swift library inspired the Java library.</li>
|
||||
</ul></li>
|
||||
<li><strong>React Native (iOS)</strong>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/GantMan/react-native-siren"><strong>Gant Laborde’s Siren library</strong></a></li>
|
||||
<li>The Siren Swift library inspired the React Native library.</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
<h1 id='installation-and-integration' class='heading'>Installation and Integration</h1>
|
||||
<h2 id='installation-instructions' class='heading'>Installation Instructions</h2>
|
||||
|
||||
<table><thead>
|
||||
@@ -270,7 +322,8 @@
|
||||
|
||||
<p>Siren also has plenty of customization options. All examples can be found in the Example Project’s <a href="https://github.com/ArtSabintsev/Siren/blob/master/Example/Example/AppDelegate.swift"><strong>AppDelegate</strong></a> file. Uncomment the example you’d like to test.</p>
|
||||
|
||||
<p><strong>WARNING</strong>: Siren should ONLY be placed in <a href="https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622921-application">UIApplication.didFinishLaunchingWithOptions</a> and only after the <code>window?.makeKeyAndVisible()</code> call. Siren initializes a listener on <a href="https://developer.apple.com/reference/foundation/nsnotification.name/1622953-uiapplicationdidbecomeactive">didBecomeActiveNotification</a> to perform version checks.</p>
|
||||
<hr>
|
||||
<h1 id='device-specific-checks' class='heading'>Device-Specific Checks</h1>
|
||||
<h2 id='localization' class='heading'>Localization</h2>
|
||||
|
||||
<p>Siren is localized for the following languages:</p>
|
||||
@@ -280,18 +333,27 @@
|
||||
<p>If your user’s device is set to one of the supported locales, an update message will appear in that language. If a locale is not supported, than the message will appear in English.</p>
|
||||
|
||||
<p>You may want the update dialog to <em>always</em> appear in a certain language, ignoring the user’s device-specific setting. You can enable it like so:</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// In this example, we force the `russian` language.</span>
|
||||
<pre class="highlight swift"><code><span class="c1">// In this example, we force the `Russian` language.</span>
|
||||
<span class="kt">Siren</span><span class="o">.</span><span class="n">shared</span><span class="o">.</span><span class="n">presentationManager</span> <span class="o">=</span> <span class="kt">PresentationManager</span><span class="p">(</span><span class="nv">forceLanguageLocalization</span><span class="p">:</span> <span class="o">.</span><span class="n">russian</span><span class="p">)</span>
|
||||
</code></pre>
|
||||
<h2 id='device-compatibility' class='heading'>Device Compatibility</h2>
|
||||
|
||||
<p>If an app update is available, Siren checks to make sure that the version of iOS on the user’s device is compatible with the one that is required by the app update. For example, if a user has iOS 11 installed on their device, but the app update requires iOS 12, an alert will not be shown. This takes care of the <em>false positive</em> case regarding app updating.</p>
|
||||
<h2 id='testing-siren' class='heading'>Testing Siren</h2>
|
||||
|
||||
<hr>
|
||||
<h1 id='testing' class='heading'>Testing</h1>
|
||||
<h2 id='testing-siren-locally' class='heading'>Testing Siren Locally</h2>
|
||||
|
||||
<p>Temporarily change the version string in Xcode (within the <code>.xcodeproj</code> file) to an older version than the one that’s currently available in the App Store. Afterwards, build and run your app, and you should see the alert.</p>
|
||||
|
||||
<p>If you currently don’t have an app in the store, change your bundleID to one that is already in the store. In the sample app packaged with this library, we use the <a href="https://itunes.apple.com/app/id1234793120">App Store Connect</a> app’s bundleID: <code>com.apple.AppStoreConnect</code>.</p>
|
||||
<h2 id='app-store-submissions' class='heading'>App Store Submissions</h2>
|
||||
<h2 id='words-of-caution' class='heading'>Words of Caution</h2>
|
||||
|
||||
<p>Occasionally, the iTunes JSON will update faster than the App Store CDN, meaning the JSON may state that the new version of the app has been released, while no new binary is made available for download via the App Store. It is for this reason that Siren will, by default, wait 1 day (24 hours) after the JSON has been updated to prompt the user to update. To change the default setting, please modify the value of <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code>.</p>
|
||||
|
||||
<hr>
|
||||
<h1 id='app-submission' class='heading'>App Submission</h1>
|
||||
<h2 id='app-store-review' class='heading'>App Store Review</h2>
|
||||
|
||||
<p>The App Store reviewer will <strong>not</strong> see the alert. The version in the App Store will always be older than the version being reviewed.</p>
|
||||
<h2 id='phased-releases' class='heading'>Phased Releases</h2>
|
||||
@@ -303,32 +365,9 @@
|
||||
<li>You can set <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code> to <code>7</code>, and Siren will not prompt any users until the latest version is 7 days old, after the phased rollout is complete.</li>
|
||||
<li>You can remotely disable Siren until the rollout is done using your own API / backend logic.</li>
|
||||
</ul>
|
||||
<h2 id='words-of-caution' class='heading'>Words of Caution</h2>
|
||||
|
||||
<p>Occasionally, the iTunes JSON will update faster than the App Store CDN, meaning the JSON may state that the new version of the app has been released, while no new binary is made available for download via the App Store. It is for this reason that Siren will, by default, wait 1 day (24 hours) after the JSON has been updated to prompt the user to update. To change the default setting, please modify the value of <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code>.</p>
|
||||
<h2 id='ports' class='heading'>Ports</h2>
|
||||
|
||||
<ul>
|
||||
<li><strong>Objective-C (iOS)</strong>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/ArtSabintsev/Harpy"><strong>Harpy</strong></a></li>
|
||||
<li>Siren was ported <em>from</em> Harpy, as Siren and Harpy are maintained by the same developer.</li>
|
||||
<li>As of December 2018, Harpy has been deprecated in favor of Siren.</li>
|
||||
</ul></li>
|
||||
<li><strong>Java (Android)</strong>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/eggheadgames/Siren"><strong>Egghead Games’ Siren library</strong></a></li>
|
||||
<li>The Siren Swift library inspired the Java library.</li>
|
||||
</ul></li>
|
||||
<li><strong>React Native (iOS)</strong>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/GantMan/react-native-siren"><strong>Gant Laborde’s Siren library</strong></a></li>
|
||||
<li>The Siren Swift library inspired the React Native library.</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
<hr>
|
||||
<h1 id='attribution' class='heading'>Attribution</h1>
|
||||
<h2 id='special-thanks' class='heading'>Special Thanks</h2>
|
||||
|
||||
<p>A massive shout-out and thank you goes to the following folks: </p>
|
||||
@@ -338,15 +377,15 @@
|
||||
<li>All of <a href="https://github.com/ArtSabintsev/Harpy/graphs/contributors">Harpy’s Contributors</a> for helping building the feature set from 2012-2015 that was used as the basis for the first version of Siren.</li>
|
||||
<li>All of <a href="https://github.com/ArtSabintsev/Siren/graphs/contributors">Siren’s Contributors</a> for helping make Siren as powerful and bug-free as it currently is today.</li>
|
||||
</ul>
|
||||
<h2 id='created-and-maintained-by' class='heading'>Created and maintained by</h2>
|
||||
<h2 id='creator' class='heading'>Creator</h2>
|
||||
|
||||
<p><a href="http://www.sabintsev.com/">Arthur Ariel Sabintsev</a></p>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-05)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.
Vendored
+57
-9
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>in-acl Reference</title>
|
||||
<title>Siren Reference</title>
|
||||
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
|
||||
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
|
||||
<meta charset='utf-8'>
|
||||
@@ -10,17 +10,17 @@
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<a title="in-acl Reference"></a>
|
||||
<a title="Siren Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="index.html">in-acl Docs</a> (100% documented)</p>
|
||||
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
|
||||
</div>
|
||||
</header>
|
||||
<div class="content-wrapper">
|
||||
<p id="breadcrumbs">
|
||||
<a href="index.html">in-acl Reference</a>
|
||||
<a href="index.html">Siren Reference</a>
|
||||
<img id="carat" src="img/carat.png" />
|
||||
in-acl Reference
|
||||
Siren Reference
|
||||
</p>
|
||||
</div>
|
||||
<div class="content-wrapper">
|
||||
@@ -32,6 +32,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/Siren.html">Siren</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/SirenViewController.html">SirenViewController</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -43,6 +46,32 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/KnownError.html">KnownError</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Enums/PerformCheck.html">PerformCheck</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a href="Extensions.html">Extensions</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle.html">Bundle</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Bundle/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/Date.html">Date</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UIAlertController.html">UIAlertController</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults.html">UserDefaults</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Extensions/UserDefaults/SirenKeys.html">– SirenKeys</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -51,9 +80,15 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager.html">APIManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/APIManager/Constants.html">– Constants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/AlertConstants.html">AlertConstants</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/DataParser.html">DataParser</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/Localization.html">Localization</a>
|
||||
</li>
|
||||
@@ -63,6 +98,9 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel.html">LookupModel</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/CodingKeys.html">– CodingKeys</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Structs/LookupModel/Results.html">– Results</a>
|
||||
</li>
|
||||
@@ -172,6 +210,8 @@
|
||||
<h3 id='future-features' class='heading'>Future Features</h3>
|
||||
|
||||
<p>A list of future development work can be found on <a href="https://github.com/ArtSabintsev/Siren/projects/1">Siren’s Kanban Board</a>.</p>
|
||||
|
||||
<hr>
|
||||
<h2 id='screenshots' class='heading'>Screenshots</h2>
|
||||
|
||||
<ul>
|
||||
@@ -205,6 +245,8 @@
|
||||
<li>The Siren Swift library inspired the React Native library.</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
<h1 id='installation-and-integration' class='heading'>Installation and Integration</h1>
|
||||
<h2 id='installation-instructions' class='heading'>Installation Instructions</h2>
|
||||
|
||||
@@ -280,7 +322,7 @@
|
||||
|
||||
<p>Siren also has plenty of customization options. All examples can be found in the Example Project’s <a href="https://github.com/ArtSabintsev/Siren/blob/master/Example/Example/AppDelegate.swift"><strong>AppDelegate</strong></a> file. Uncomment the example you’d like to test.</p>
|
||||
|
||||
<p><strong>WARNING</strong>: Siren should ONLY be placed in <a href="https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622921-application">UIApplication.didFinishLaunchingWithOptions</a> and only after the <code>window?.makeKeyAndVisible()</code> call. Siren initializes a listener on <a href="https://developer.apple.com/reference/foundation/nsnotification.name/1622953-uiapplicationdidbecomeactive">didBecomeActiveNotification</a> to perform version checks.</p>
|
||||
<hr>
|
||||
<h1 id='device-specific-checks' class='heading'>Device-Specific Checks</h1>
|
||||
<h2 id='localization' class='heading'>Localization</h2>
|
||||
|
||||
@@ -291,12 +333,14 @@
|
||||
<p>If your user’s device is set to one of the supported locales, an update message will appear in that language. If a locale is not supported, than the message will appear in English.</p>
|
||||
|
||||
<p>You may want the update dialog to <em>always</em> appear in a certain language, ignoring the user’s device-specific setting. You can enable it like so:</p>
|
||||
<pre class="highlight swift"><code><span class="c1">// In this example, we force the `russian` language.</span>
|
||||
<pre class="highlight swift"><code><span class="c1">// In this example, we force the `Russian` language.</span>
|
||||
<span class="kt">Siren</span><span class="o">.</span><span class="n">shared</span><span class="o">.</span><span class="n">presentationManager</span> <span class="o">=</span> <span class="kt">PresentationManager</span><span class="p">(</span><span class="nv">forceLanguageLocalization</span><span class="p">:</span> <span class="o">.</span><span class="n">russian</span><span class="p">)</span>
|
||||
</code></pre>
|
||||
<h2 id='device-compatibility' class='heading'>Device Compatibility</h2>
|
||||
|
||||
<p>If an app update is available, Siren checks to make sure that the version of iOS on the user’s device is compatible with the one that is required by the app update. For example, if a user has iOS 11 installed on their device, but the app update requires iOS 12, an alert will not be shown. This takes care of the <em>false positive</em> case regarding app updating.</p>
|
||||
|
||||
<hr>
|
||||
<h1 id='testing' class='heading'>Testing</h1>
|
||||
<h2 id='testing-siren-locally' class='heading'>Testing Siren Locally</h2>
|
||||
|
||||
@@ -306,6 +350,8 @@
|
||||
<h2 id='words-of-caution' class='heading'>Words of Caution</h2>
|
||||
|
||||
<p>Occasionally, the iTunes JSON will update faster than the App Store CDN, meaning the JSON may state that the new version of the app has been released, while no new binary is made available for download via the App Store. It is for this reason that Siren will, by default, wait 1 day (24 hours) after the JSON has been updated to prompt the user to update. To change the default setting, please modify the value of <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code>.</p>
|
||||
|
||||
<hr>
|
||||
<h1 id='app-submission' class='heading'>App Submission</h1>
|
||||
<h2 id='app-store-review' class='heading'>App Store Review</h2>
|
||||
|
||||
@@ -319,6 +365,8 @@
|
||||
<li>You can set <code>showAlertAfterCurrentVersionHasBeenReleasedForDays</code> to <code>7</code>, and Siren will not prompt any users until the latest version is 7 days old, after the phased rollout is complete.</li>
|
||||
<li>You can remotely disable Siren until the rollout is done using your own API / backend logic.</li>
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
<h1 id='attribution' class='heading'>Attribution</h1>
|
||||
<h2 id='special-thanks' class='heading'>Special Thanks</h2>
|
||||
|
||||
@@ -336,8 +384,8 @@
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-01-10)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
<p>© 2019 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev</a>. All rights reserved. (Last updated: 2019-02-09)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
Vendored
+1
-1
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user