From 69d49689ce53ae991105a44aec7c65ee997598eb Mon Sep 17 00:00:00 2001 From: Arthur Ariel Sabintsev Date: Sat, 8 Apr 2017 02:12:18 -0400 Subject: [PATCH] SirenVersionCheckType is now Siren.VersionCheckType. Updated docs and podspec. --- README.md | 2 +- Siren.podspec | 2 +- Sources/Siren.swift | 26 ++++++------ docs/Classes.html | 2 +- docs/Classes/Siren.html | 40 +++++++++--------- docs/Classes/Siren/AlertType.html | 2 +- docs/Classes/Siren/LanguageType.html | 2 +- ...onCheckType.html => VersionCheckType.html} | 26 ++++++------ docs/Protocols.html | 2 +- docs/Protocols/SirenDelegate.html | 2 +- .../Contents/Resources/Documents/Classes.html | 2 +- .../Resources/Documents/Classes/Siren.html | 40 +++++++++--------- .../Documents/Classes/Siren/AlertType.html | 2 +- .../Documents/Classes/Siren/LanguageType.html | 2 +- ...onCheckType.html => VersionCheckType.html} | 26 ++++++------ .../Resources/Documents/Protocols.html | 2 +- .../Documents/Protocols/SirenDelegate.html | 2 +- .../Contents/Resources/Documents/index.html | 4 +- .../Contents/Resources/Documents/search.json | 2 +- .../Contents/Resources/docSet.dsidx | Bin 28672 -> 28672 bytes docs/docsets/Siren.tgz | Bin 60811 -> 60794 bytes docs/index.html | 4 +- docs/search.json | 2 +- 23 files changed, 97 insertions(+), 97 deletions(-) rename docs/Classes/Siren/{SirenVersionCheckType.html => VersionCheckType.html} (85%) rename docs/docsets/Siren.docset/Contents/Resources/Documents/Classes/Siren/{SirenVersionCheckType.html => VersionCheckType.html} (85%) diff --git a/README.md b/README.md index 88eb7fd7..39732684 100755 --- a/README.md +++ b/README.md @@ -244,7 +244,7 @@ For your convenience, you may turn on debugging statements by setting `self.debu The App Store reviewer will **not** see the alert. The version in the App Store will always be older than the version being reviewed. ## Words of Caution -Occassionally, the iTunes JSON will update faster than the App Store CDN, meaning the JSON may state that the new verison of the app has been release, while no new binary is made available for download via the App Store. It is for this reason, I caution developers to not use the `Force` option unless you are controlling the `Force` option with a remote configuration file (e.g., enabling Siren remotely only after you have guaranteed that the app has propogated to the App Store). +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 release, while no new binary is made available for download via the App Store. It is for this reason, I caution developers to not use the `Force` option unless you are controlling the `Force` option with a remote configuration file (e.g., enabling Siren remotely only after you have guaranteed that the app has propagated to the App Store). Also, in even rarer situations, the iTunes JSON may fluctuate between multiple versions of your app shortly after pushing out a new version. This is extremely rare, and has only been reported once in the five years that Siren and Harpy have been around. diff --git a/Siren.podspec b/Siren.podspec index 4865b99b..f6337ca2 100755 --- a/Siren.podspec +++ b/Siren.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = "Siren" - s.version = "2.0.0" + s.version = "2.0.1" s.summary = "Notify users when a new version of your iOS app is available, and prompt them with the App Store link.." s.description = <<-DESC diff --git a/Sources/Siren.swift b/Sources/Siren.swift index 2f7dd216..4c51f56d 100644 --- a/Sources/Siren.swift +++ b/Sources/Siren.swift @@ -38,7 +38,7 @@ public final class Siren: NSObject { public lazy var debugEnabled = false /// Determines the type of alert that should be shown. - /// See the SirenAlertType enum for full details. + /// See the Siren.AlertType enum for full details. public var alertType = AlertType.option { didSet { majorUpdateAlertType = alertType @@ -49,23 +49,23 @@ public final class Siren: NSObject { } /// Determines the type of alert that should be shown for major version updates: A.b.c - /// Defaults to SirenAlertType.Option. - /// See the SirenAlertType enum for full details. + /// Defaults to Siren.AlertType.option. + /// See the Siren.AlertType enum for full details. public lazy var majorUpdateAlertType = AlertType.option /// Determines the type of alert that should be shown for minor version updates: a.B.c - /// Defaults to SirenAlertType.Option. - /// See the SirenAlertType enum for full details. + /// Defaults to Siren.AlertType.option. + /// See the Siren.AlertType enum for full details. public lazy var minorUpdateAlertType = AlertType.option /// Determines the type of alert that should be shown for minor patch updates: a.b.C - /// Defaults to SirenAlertType.Option. - /// See the SirenAlertType enum for full details. + /// Defaults to Siren.AlertType.option. + /// See the Siren.AlertType enum for full details. public lazy var patchUpdateAlertType = AlertType.option /// Determines the type of alert that should be shown for revision updates: a.b.c.D - /// Defaults to SirenAlertType.Option. - /// See the SirenAlertType enum for full details. + /// Defaults to Siren.AlertType.option. + /// See the Siren.AlertType enum for full details. public lazy var revisionUpdateAlertType = AlertType.option /// The name of your app. @@ -78,7 +78,7 @@ public final class Siren: NSObject { public var countryCode: String? /// Overrides the default localization of a user's device when presenting the update message and button titles in the alert. - /// See the SirenLanguageType enum for more details. + /// See the Siren.LanguageType enum for more details. public var forceLanguageLocalization: Siren.LanguageType? /// Overrides the tint color for UIAlertController. @@ -111,8 +111,8 @@ public final class Siren: NSObject { /// you should set the `countryCode` property before calling this method. Please refer to the countryCode property for more information. /// /// - Parameters: - /// - checkType: The frequency in days in which you want a check to be performed. Please refer to the SirenVersionCheckType enum for more details. - public func checkVersion(checkType: SirenVersionCheckType) { + /// - checkType: The frequency in days in which you want a check to be performed. Please refer to the Siren.VersionCheckType enum for more details. + public func checkVersion(checkType: VersionCheckType) { guard let _ = Bundle.bundleID() else { printMessage(message: "Please make sure that you have set a `Bundle Identifier` in your project.") return @@ -495,7 +495,7 @@ public extension Siren { /// Determines the frequency in which the the version check is performed and the user is prompted to update the app. /// - enum SirenVersionCheckType: Int { + enum VersionCheckType: Int { /// Version check performed every time the app is launched. case immediately = 0 diff --git a/docs/Classes.html b/docs/Classes.html index 825b7c45..c7ec6d6e 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -37,7 +37,7 @@ – AlertType
  • - + - checkVersion(checkType:) + checkVersion(checkType:)
    @@ -522,7 +522,7 @@

    Declaration

    Declaration

    Swift

    -
    public func checkVersion(checkType: SirenVersionCheckType)
    +
    public func checkVersion(checkType: VersionCheckType)
    @@ -538,7 +538,7 @@

    Parameters

    -

    The frequency in days in which you want a check to be performed. Please refer to the SirenVersionCheckType enum for more details.

    +

    The frequency in days in which you want a check to be performed. Please refer to the Siren.VersionCheckType enum for more details.

    @@ -584,9 +584,9 @@

    Declaration

  • - - - SirenVersionCheckType + + + VersionCheckType
    @@ -596,13 +596,13 @@

    Declaration

    Determines the frequency in which the the version check is performed and the user is prompted to update the app.

    - See more + See more

    Declaration

    Swift

    -
    enum SirenVersionCheckType: Int
    +
    enum VersionCheckType: Int
    diff --git a/docs/Classes/Siren/AlertType.html b/docs/Classes/Siren/AlertType.html index 92612df8..8d1c168d 100644 --- a/docs/Classes/Siren/AlertType.html +++ b/docs/Classes/Siren/AlertType.html @@ -38,7 +38,7 @@ – AlertType