Skip to content

Commit

Permalink
SirenVersionCheckType is now Siren.VersionCheckType. Updated docs and…
Browse files Browse the repository at this point in the history
… podspec.
  • Loading branch information
ArtSabintsev committed Apr 8, 2017
1 parent bd4b17f commit 69d4968
Show file tree
Hide file tree
Showing 23 changed files with 97 additions and 97 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Siren.podspec
Original file line number Diff line number Diff line change
@@ -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
Expand Down
26 changes: 13 additions & 13 deletions Sources/Siren.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<a href="Classes/Siren/AlertType.html">– AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a>
<a href="Classes/Siren/VersionCheckType.html">VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html">– LanguageType</a>
Expand Down
40 changes: 20 additions & 20 deletions docs/Classes/Siren.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<a href="../Classes/Siren/AlertType.html">– AlertType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a>
<a href="../Classes/Siren/VersionCheckType.html">VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/LanguageType.html">– LanguageType</a>
Expand Down Expand Up @@ -176,7 +176,7 @@ <h4>Declaration</h4>
<div class="pointer"></div>
<div class="abstract">
<p>Determines the type of alert that should be shown.
See the SirenAlertType enum for full details.</p>
See the Siren.AlertType enum for full details.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -204,8 +204,8 @@ <h4>Declaration</h4>
<div class="pointer"></div>
<div class="abstract">
<p>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.</p>
Defaults to Siren.AlertType.option.
See the Siren.AlertType enum for full details.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -233,8 +233,8 @@ <h4>Declaration</h4>
<div class="pointer"></div>
<div class="abstract">
<p>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.</p>
Defaults to Siren.AlertType.option.
See the Siren.AlertType enum for full details.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -262,8 +262,8 @@ <h4>Declaration</h4>
<div class="pointer"></div>
<div class="abstract">
<p>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.</p>
Defaults to Siren.AlertType.option.
See the Siren.AlertType enum for full details.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -291,8 +291,8 @@ <h4>Declaration</h4>
<div class="pointer"></div>
<div class="abstract">
<p>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.</p>
Defaults to Siren.AlertType.option.
See the Siren.AlertType enum for full details.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -377,7 +377,7 @@ <h4>Declaration</h4>
<div class="pointer"></div>
<div class="abstract">
<p>Overrides the default localization of a user&rsquo;s device when presenting the update message and button titles in the alert.
See the SirenLanguageType enum for more details.</p>
See the Siren.LanguageType enum for more details.</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -503,9 +503,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_21SirenVersionCheckType_T_"></a>
<a name="/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_16VersionCheckType_T_"></a>
<a name="//apple_ref/swift/Method/checkVersion(checkType:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_21SirenVersionCheckType_T_">checkVersion(checkType:)</a>
<a class="token" href="#/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_16VersionCheckType_T_">checkVersion(checkType:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -522,7 +522,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">checkVersion</span><span class="p">(</span><span class="nv">checkType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a></span><span class="p">)</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">checkVersion</span><span class="p">(</span><span class="nv">checkType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/VersionCheckType.html">VersionCheckType</a></span><span class="p">)</span></code></pre>

</div>
</div>
Expand All @@ -538,7 +538,7 @@ <h4>Parameters</h4>
</td>
<td>
<div>
<p>The frequency in days in which you want a check to be performed. Please refer to the SirenVersionCheckType enum for more details.</p>
<p>The frequency in days in which you want a check to be performed. Please refer to the Siren.VersionCheckType enum for more details.</p>

</div>
</td>
Expand Down Expand Up @@ -584,9 +584,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:OC5Siren5Siren21SirenVersionCheckType"></a>
<a name="//apple_ref/swift/Enum/SirenVersionCheckType" class="dashAnchor"></a>
<a class="token" href="#/s:OC5Siren5Siren21SirenVersionCheckType">SirenVersionCheckType</a>
<a name="/s:OC5Siren5Siren16VersionCheckType"></a>
<a name="//apple_ref/swift/Enum/VersionCheckType" class="dashAnchor"></a>
<a class="token" href="#/s:OC5Siren5Siren16VersionCheckType">VersionCheckType</a>
</code>
</div>
<div class="height-container">
Expand All @@ -596,13 +596,13 @@ <h4>Declaration</h4>
<div class="abstract">
<p>Determines the frequency in which the the version check is performed and the user is prompted to update the app.</p>

<a href="../Classes/Siren/SirenVersionCheckType.html" class="slightly-smaller">See more</a>
<a href="../Classes/Siren/VersionCheckType.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"><code><span class="kd">enum</span> <span class="kt">SirenVersionCheckType</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
<pre class="highlight"><code><span class="kd">enum</span> <span class="kt">VersionCheckType</span><span class="p">:</span> <span class="kt">Int</span></code></pre>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/Siren/AlertType.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<a href="../../Classes/Siren/AlertType.html">– AlertType</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a>
<a href="../../Classes/Siren/VersionCheckType.html">VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Siren/LanguageType.html">– LanguageType</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/Siren/LanguageType.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<a href="../../Classes/Siren/AlertType.html">– AlertType</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a>
<a href="../../Classes/Siren/VersionCheckType.html">VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Siren/LanguageType.html">– LanguageType</a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>SirenVersionCheckType Enum Reference</title>
<title>VersionCheckType Enum 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'>
Expand All @@ -10,8 +10,8 @@

</head>
<body>
<a name="//apple_ref/swift/Enum/SirenVersionCheckType" class="dashAnchor"></a>
<a title="SirenVersionCheckType Enum Reference"></a>
<a name="//apple_ref/swift/Enum/VersionCheckType" class="dashAnchor"></a>
<a title="VersionCheckType Enum Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">Siren Docs</a> (55% documented)</p>
Expand All @@ -22,7 +22,7 @@
<p id="breadcrumbs">
<a href="../../index.html">Siren Reference</a>
<img id="carat" src="../../img/carat.png" />
SirenVersionCheckType Enum Reference
VersionCheckType Enum Reference
</p>
</div>
<div class="content-wrapper">
Expand All @@ -38,7 +38,7 @@
<a href="../../Classes/Siren/AlertType.html">– AlertType</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a>
<a href="../../Classes/Siren/VersionCheckType.html">VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Siren/LanguageType.html">– LanguageType</a>
Expand All @@ -58,10 +58,10 @@
<article class="main-content">
<section>
<section class="section">
<h1>SirenVersionCheckType</h1>
<h1>VersionCheckType</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">enum</span> <span class="kt">SirenVersionCheckType</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
<pre class="highlight"><code><span class="kd">enum</span> <span class="kt">VersionCheckType</span><span class="p">:</span> <span class="kt">Int</span></code></pre>

</div>
</div>
Expand All @@ -74,9 +74,9 @@ <h1>SirenVersionCheckType</h1>
<li class="item">
<div>
<code>
<a name="/s:FOC5Siren5Siren21SirenVersionCheckType11immediatelyFMS1_S1_"></a>
<a name="/s:FOC5Siren5Siren16VersionCheckType11immediatelyFMS1_S1_"></a>
<a name="//apple_ref/swift/Element/immediately" class="dashAnchor"></a>
<a class="token" href="#/s:FOC5Siren5Siren21SirenVersionCheckType11immediatelyFMS1_S1_">immediately</a>
<a class="token" href="#/s:FOC5Siren5Siren16VersionCheckType11immediatelyFMS1_S1_">immediately</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -105,9 +105,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FOC5Siren5Siren21SirenVersionCheckType5dailyFMS1_S1_"></a>
<a name="/s:FOC5Siren5Siren16VersionCheckType5dailyFMS1_S1_"></a>
<a name="//apple_ref/swift/Element/daily" class="dashAnchor"></a>
<a class="token" href="#/s:FOC5Siren5Siren21SirenVersionCheckType5dailyFMS1_S1_">daily</a>
<a class="token" href="#/s:FOC5Siren5Siren16VersionCheckType5dailyFMS1_S1_">daily</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -136,9 +136,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FOC5Siren5Siren21SirenVersionCheckType6weeklyFMS1_S1_"></a>
<a name="/s:FOC5Siren5Siren16VersionCheckType6weeklyFMS1_S1_"></a>
<a name="//apple_ref/swift/Element/weekly" class="dashAnchor"></a>
<a class="token" href="#/s:FOC5Siren5Siren21SirenVersionCheckType6weeklyFMS1_S1_">weekly</a>
<a class="token" href="#/s:FOC5Siren5Siren16VersionCheckType6weeklyFMS1_S1_">weekly</a>
</code>
</div>
<div class="height-container">
Expand Down
2 changes: 1 addition & 1 deletion docs/Protocols.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<a href="Classes/Siren/AlertType.html">– AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a>
<a href="Classes/Siren/VersionCheckType.html">VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html">– LanguageType</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/Protocols/SirenDelegate.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<a href="../Classes/Siren/AlertType.html">– AlertType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/SirenVersionCheckType.html">SirenVersionCheckType</a>
<a href="../Classes/Siren/VersionCheckType.html">VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/LanguageType.html">– LanguageType</a>
Expand Down
Loading

0 comments on commit 69d4968

Please sign in to comment.