SirenVersionCheckType
+VersionCheckType
enum SirenVersionCheckType: Int
+ enum VersionCheckType: Int
SirenVersionCheckType
-
+
- immediately
+ immediately
Declaration
Declaration
Declaration
Determines the type of alert that should be shown. -See the SirenAlertType enum for full details.
+See the Siren.AlertType enum for full details.Declaration
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.Declaration
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.Declaration
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.Declaration
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.Declaration
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.Declaration
Declaration
Declaration
Swift
-public func checkVersion(checkType: SirenVersionCheckType)
+ public func checkVersion(checkType: VersionCheckType)
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.
Declaration
-
-
- SirenVersionCheckType
+
+
+ VersionCheckType
Declaration
Determines the frequency in which the the version check is performed and the user is prompted to update the app.
- See more + See moreDeclaration
Swift
-enum SirenVersionCheckType: Int
+ enum VersionCheckType: Int
Siren Docs (55% documented)
@@ -22,7 +22,7 @@SirenVersionCheckType
+VersionCheckType
enum SirenVersionCheckType: Int
+ enum VersionCheckType: Int
SirenVersionCheckType
-
+
- immediately
+ immediately
Declaration
Declaration
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.
Ports
diff --git a/docs/docsets/Siren.docset/Contents/Resources/Documents/search.json b/docs/docsets/Siren.docset/Contents/Resources/Documents/search.json index b70d2ddf..7459b68f 100644 --- a/docs/docsets/Siren.docset/Contents/Resources/Documents/search.json +++ b/docs/docsets/Siren.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidShowUpdateDialogFT9alertTypeOCS_5Siren9AlertType_T_":{"name":"sirenDidShowUpdateDialog(alertType:)","abstract":"User presented with update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate26sirenUserDidLaunchAppStoreFT_T_":{"name":"sirenUserDidLaunchAppStore()","abstract":"User did click on button that launched App Store.app.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate23sirenUserDidSkipVersionFT_T_":{"name":"sirenUserDidSkipVersion()","abstract":"User did click on button that skips version update.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate18sirenUserDidCancelFT_T_":{"name":"sirenUserDidCancel()","abstract":"User did click on button that cancels update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidFailVersionCheckFT5errorCSo7NSError_T_":{"name":"sirenDidFailVersionCheck(error:)","abstract":"Siren failed to perform version check (may return system-level error).
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate36sirenDidDetectNewVersionWithoutAlertFT7messageSS_T_":{"name":"sirenDidDetectNewVersionWithoutAlert(message:)","abstract":"Siren performed version check and did not display alert.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate27sirenLatestVersionInstalledFT_T_":{"name":"sirenLatestVersionInstalled()","abstract":"Siren performed version check and latest version is installed.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html":{"name":"SirenDelegate","abstract":"Delegate that handles all codepaths for Siren upon version check completion.
"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6ArabicFMS1_S1_":{"name":"Arabic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8ArmenianFMS1_S1_":{"name":"Armenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6BasqueFMS1_S1_":{"name":"Basque","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType17ChineseSimplifiedFMS1_S1_":{"name":"ChineseSimplified","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18ChineseTraditionalFMS1_S1_":{"name":"ChineseTraditional","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8CroatianFMS1_S1_":{"name":"Croatian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6DanishFMS1_S1_":{"name":"Danish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5DutchFMS1_S1_":{"name":"Dutch","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7EnglishFMS1_S1_":{"name":"English","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8EstonianFMS1_S1_":{"name":"Estonian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7FinnishFMS1_S1_":{"name":"Finnish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6FrenchFMS1_S1_":{"name":"French","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6GermanFMS1_S1_":{"name":"German","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5GreekFMS1_S1_":{"name":"Greek","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6HebrewFMS1_S1_":{"name":"Hebrew","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9HungarianFMS1_S1_":{"name":"Hungarian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10IndonesianFMS1_S1_":{"name":"Indonesian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7ItalianFMS1_S1_":{"name":"Italian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8JapaneseFMS1_S1_":{"name":"Japanese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6KoreanFMS1_S1_":{"name":"Korean","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7LatvianFMS1_S1_":{"name":"Latvian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10LithuanianFMS1_S1_":{"name":"Lithuanian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5MalayFMS1_S1_":{"name":"Malay","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9NorwegianFMS1_S1_":{"name":"Norwegian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6PolishFMS1_S1_":{"name":"Polish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType16PortugueseBrazilFMS1_S1_":{"name":"PortugueseBrazil","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18PortuguesePortugalFMS1_S1_":{"name":"PortuguesePortugal","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7RussianFMS1_S1_":{"name":"Russian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType15SerbianCyrillicFMS1_S1_":{"name":"SerbianCyrillic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType12SerbianLatinFMS1_S1_":{"name":"SerbianLatin","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9SlovenianFMS1_S1_":{"name":"Slovenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SpanishFMS1_S1_":{"name":"Spanish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SwedishFMS1_S1_":{"name":"Swedish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType4ThaiFMS1_S1_":{"name":"Thai","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7TurkishFMS1_S1_":{"name":"Turkish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10VietnameseFMS1_S1_":{"name":"Vietnamese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/SirenVersionCheckType.html#/s:FOC5Siren5Siren21SirenVersionCheckType11immediatelyFMS1_S1_":{"name":"immediately","abstract":"Version check performed every time the app is launched.
","parent_name":"SirenVersionCheckType"},"Classes/Siren/SirenVersionCheckType.html#/s:FOC5Siren5Siren21SirenVersionCheckType5dailyFMS1_S1_":{"name":"daily","abstract":"Version check performed once a day.
","parent_name":"SirenVersionCheckType"},"Classes/Siren/SirenVersionCheckType.html#/s:FOC5Siren5Siren21SirenVersionCheckType6weeklyFMS1_S1_":{"name":"weekly","abstract":"Version check performed once a week.
","parent_name":"SirenVersionCheckType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType5forceFMS1_S1_":{"name":"force","abstract":"Forces user to update your app (1 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType6optionFMS1_S1_":{"name":"option","abstract":"(DEFAULT) Presents user with option to update app now or at next launch (2 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4skipFMS1_S1_":{"name":"skip","abstract":"Presents user with option to update the app now, at next launch, or to skip this version all together (3 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4noneFMS1_S1_":{"name":"none","abstract":"Doesn’t show the alert, but instead returns a localized message","parent_name":"AlertType"},"Classes/Siren.html#/s:vC5Siren5Siren16SirenErrorDomainSS":{"name":"SirenErrorDomain","abstract":"
The error domain for all errors created by Siren.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren8delegateXwGSqPS_13SirenDelegate__":{"name":"delegate","abstract":"The SirenDelegate variable, which should be set if you’d like to be notified:
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren12debugEnabledSb":{"name":"debugEnabled","abstract":"The debug flag, which is disabled by default.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren9alertTypeOS0_9AlertType":{"name":"alertType","abstract":"
Determines the type of alert that should be shown.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20majorUpdateAlertTypeOS0_9AlertType":{"name":"majorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for major version updates: A.b.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20minorUpdateAlertTypeOS0_9AlertType":{"name":"minorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor version updates: a.B.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20patchUpdateAlertTypeOS0_9AlertType":{"name":"patchUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor patch updates: a.b.C","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren23revisionUpdateAlertTypeOS0_9AlertType":{"name":"revisionUpdateAlertType","abstract":"
Determines the type of alert that should be shown for revision updates: a.b.c.D","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren7appNameSS":{"name":"appName","abstract":"
The name of your app.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren11countryCodeGSqSS_":{"name":"countryCode","abstract":"
The region or country of an App Store in which your app is available.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren25forceLanguageLocalizationGSqOS0_12LanguageType_":{"name":"forceLanguageLocalization","abstract":"
Overrides the default localization of a user’s device when presenting the update message and button titles in the alert.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren24alertControllerTintColorGSqCSo7UIColor_":{"name":"alertControllerTintColor","abstract":"
Overrides the tint color for UIAlertController.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren50showAlertAfterCurrentVersionHasBeenReleasedForDaysSi":{"name":"showAlertAfterCurrentVersionHasBeenReleasedForDays","abstract":"When this is set, the alert will only show up if the current version has already been released for X days","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren22currentAppStoreVersionGSqSS_":{"name":"currentAppStoreVersion","abstract":"
The current version of your app that is available for download on the App Store
","parent_name":"Siren"},"Classes/Siren.html#/s:ZvC5Siren5Siren6sharedS0_":{"name":"shared","abstract":"The App’s Singleton
","parent_name":"Siren"},"Classes/Siren.html#/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_21SirenVersionCheckType_T_":{"name":"checkVersion(checkType:)","abstract":"Checks the currently installed version of your app against the App Store.","parent_name":"Siren"},"Classes/Siren/AlertType.html":{"name":"AlertType","abstract":"
Determines the type of alert to present after a successful version check has been performed.
","parent_name":"Siren"},"Classes/Siren/SirenVersionCheckType.html":{"name":"SirenVersionCheckType","abstract":"Determines the frequency in which the the version check is performed and the user is prompted to update the app.
","parent_name":"Siren"},"Classes/Siren/LanguageType.html":{"name":"LanguageType","abstract":"Determines the available languages in which the update message and alert button titles should appear.
","parent_name":"Siren"},"Classes/Siren.html":{"name":"Siren","abstract":"The Siren Class. A singleton that is initialized using the shared() method.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally."},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally."}} \ No newline at end of file +{"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidShowUpdateDialogFT9alertTypeOCS_5Siren9AlertType_T_":{"name":"sirenDidShowUpdateDialog(alertType:)","abstract":"User presented with update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate26sirenUserDidLaunchAppStoreFT_T_":{"name":"sirenUserDidLaunchAppStore()","abstract":"User did click on button that launched App Store.app.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate23sirenUserDidSkipVersionFT_T_":{"name":"sirenUserDidSkipVersion()","abstract":"User did click on button that skips version update.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate18sirenUserDidCancelFT_T_":{"name":"sirenUserDidCancel()","abstract":"User did click on button that cancels update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidFailVersionCheckFT5errorCSo7NSError_T_":{"name":"sirenDidFailVersionCheck(error:)","abstract":"Siren failed to perform version check (may return system-level error).
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate36sirenDidDetectNewVersionWithoutAlertFT7messageSS_T_":{"name":"sirenDidDetectNewVersionWithoutAlert(message:)","abstract":"Siren performed version check and did not display alert.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate27sirenLatestVersionInstalledFT_T_":{"name":"sirenLatestVersionInstalled()","abstract":"Siren performed version check and latest version is installed.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html":{"name":"SirenDelegate","abstract":"Delegate that handles all codepaths for Siren upon version check completion.
"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6ArabicFMS1_S1_":{"name":"Arabic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8ArmenianFMS1_S1_":{"name":"Armenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6BasqueFMS1_S1_":{"name":"Basque","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType17ChineseSimplifiedFMS1_S1_":{"name":"ChineseSimplified","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18ChineseTraditionalFMS1_S1_":{"name":"ChineseTraditional","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8CroatianFMS1_S1_":{"name":"Croatian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6DanishFMS1_S1_":{"name":"Danish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5DutchFMS1_S1_":{"name":"Dutch","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7EnglishFMS1_S1_":{"name":"English","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8EstonianFMS1_S1_":{"name":"Estonian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7FinnishFMS1_S1_":{"name":"Finnish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6FrenchFMS1_S1_":{"name":"French","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6GermanFMS1_S1_":{"name":"German","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5GreekFMS1_S1_":{"name":"Greek","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6HebrewFMS1_S1_":{"name":"Hebrew","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9HungarianFMS1_S1_":{"name":"Hungarian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10IndonesianFMS1_S1_":{"name":"Indonesian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7ItalianFMS1_S1_":{"name":"Italian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8JapaneseFMS1_S1_":{"name":"Japanese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6KoreanFMS1_S1_":{"name":"Korean","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7LatvianFMS1_S1_":{"name":"Latvian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10LithuanianFMS1_S1_":{"name":"Lithuanian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5MalayFMS1_S1_":{"name":"Malay","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9NorwegianFMS1_S1_":{"name":"Norwegian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6PolishFMS1_S1_":{"name":"Polish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType16PortugueseBrazilFMS1_S1_":{"name":"PortugueseBrazil","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18PortuguesePortugalFMS1_S1_":{"name":"PortuguesePortugal","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7RussianFMS1_S1_":{"name":"Russian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType15SerbianCyrillicFMS1_S1_":{"name":"SerbianCyrillic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType12SerbianLatinFMS1_S1_":{"name":"SerbianLatin","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9SlovenianFMS1_S1_":{"name":"Slovenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SpanishFMS1_S1_":{"name":"Spanish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SwedishFMS1_S1_":{"name":"Swedish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType4ThaiFMS1_S1_":{"name":"Thai","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7TurkishFMS1_S1_":{"name":"Turkish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10VietnameseFMS1_S1_":{"name":"Vietnamese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/VersionCheckType.html#/s:FOC5Siren5Siren16VersionCheckType11immediatelyFMS1_S1_":{"name":"immediately","abstract":"Version check performed every time the app is launched.
","parent_name":"VersionCheckType"},"Classes/Siren/VersionCheckType.html#/s:FOC5Siren5Siren16VersionCheckType5dailyFMS1_S1_":{"name":"daily","abstract":"Version check performed once a day.
","parent_name":"VersionCheckType"},"Classes/Siren/VersionCheckType.html#/s:FOC5Siren5Siren16VersionCheckType6weeklyFMS1_S1_":{"name":"weekly","abstract":"Version check performed once a week.
","parent_name":"VersionCheckType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType5forceFMS1_S1_":{"name":"force","abstract":"Forces user to update your app (1 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType6optionFMS1_S1_":{"name":"option","abstract":"(DEFAULT) Presents user with option to update app now or at next launch (2 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4skipFMS1_S1_":{"name":"skip","abstract":"Presents user with option to update the app now, at next launch, or to skip this version all together (3 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4noneFMS1_S1_":{"name":"none","abstract":"Doesn’t show the alert, but instead returns a localized message","parent_name":"AlertType"},"Classes/Siren.html#/s:vC5Siren5Siren16SirenErrorDomainSS":{"name":"SirenErrorDomain","abstract":"
The error domain for all errors created by Siren.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren8delegateXwGSqPS_13SirenDelegate__":{"name":"delegate","abstract":"The SirenDelegate variable, which should be set if you’d like to be notified:
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren12debugEnabledSb":{"name":"debugEnabled","abstract":"The debug flag, which is disabled by default.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren9alertTypeOS0_9AlertType":{"name":"alertType","abstract":"
Determines the type of alert that should be shown.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20majorUpdateAlertTypeOS0_9AlertType":{"name":"majorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for major version updates: A.b.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20minorUpdateAlertTypeOS0_9AlertType":{"name":"minorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor version updates: a.B.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20patchUpdateAlertTypeOS0_9AlertType":{"name":"patchUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor patch updates: a.b.C","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren23revisionUpdateAlertTypeOS0_9AlertType":{"name":"revisionUpdateAlertType","abstract":"
Determines the type of alert that should be shown for revision updates: a.b.c.D","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren7appNameSS":{"name":"appName","abstract":"
The name of your app.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren11countryCodeGSqSS_":{"name":"countryCode","abstract":"
The region or country of an App Store in which your app is available.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren25forceLanguageLocalizationGSqOS0_12LanguageType_":{"name":"forceLanguageLocalization","abstract":"
Overrides the default localization of a user’s device when presenting the update message and button titles in the alert.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren24alertControllerTintColorGSqCSo7UIColor_":{"name":"alertControllerTintColor","abstract":"
Overrides the tint color for UIAlertController.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren50showAlertAfterCurrentVersionHasBeenReleasedForDaysSi":{"name":"showAlertAfterCurrentVersionHasBeenReleasedForDays","abstract":"When this is set, the alert will only show up if the current version has already been released for X days","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren22currentAppStoreVersionGSqSS_":{"name":"currentAppStoreVersion","abstract":"
The current version of your app that is available for download on the App Store
","parent_name":"Siren"},"Classes/Siren.html#/s:ZvC5Siren5Siren6sharedS0_":{"name":"shared","abstract":"The App’s Singleton
","parent_name":"Siren"},"Classes/Siren.html#/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_16VersionCheckType_T_":{"name":"checkVersion(checkType:)","abstract":"Checks the currently installed version of your app against the App Store.","parent_name":"Siren"},"Classes/Siren/AlertType.html":{"name":"AlertType","abstract":"
Determines the type of alert to present after a successful version check has been performed.
","parent_name":"Siren"},"Classes/Siren/VersionCheckType.html":{"name":"VersionCheckType","abstract":"Determines the frequency in which the the version check is performed and the user is prompted to update the app.
","parent_name":"Siren"},"Classes/Siren/LanguageType.html":{"name":"LanguageType","abstract":"Determines the available languages in which the update message and alert button titles should appear.
","parent_name":"Siren"},"Classes/Siren.html":{"name":"Siren","abstract":"The Siren Class. A singleton that is initialized using the shared() method.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally."},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally."}} \ No newline at end of file diff --git a/docs/docsets/Siren.docset/Contents/Resources/docSet.dsidx b/docs/docsets/Siren.docset/Contents/Resources/docSet.dsidx index 2fa0eaf8..2122937e 100644 Binary files a/docs/docsets/Siren.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/Siren.docset/Contents/Resources/docSet.dsidx differ diff --git a/docs/docsets/Siren.tgz b/docs/docsets/Siren.tgz index 7ef08b29..16486114 100644 Binary files a/docs/docsets/Siren.tgz and b/docs/docsets/Siren.tgz differ diff --git a/docs/index.html b/docs/index.html index eb70ae29..319456d9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -37,7 +37,7 @@ – AlertTypeThe 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.
Ports
diff --git a/docs/search.json b/docs/search.json index b70d2ddf..7459b68f 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidShowUpdateDialogFT9alertTypeOCS_5Siren9AlertType_T_":{"name":"sirenDidShowUpdateDialog(alertType:)","abstract":"User presented with update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate26sirenUserDidLaunchAppStoreFT_T_":{"name":"sirenUserDidLaunchAppStore()","abstract":"User did click on button that launched App Store.app.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate23sirenUserDidSkipVersionFT_T_":{"name":"sirenUserDidSkipVersion()","abstract":"User did click on button that skips version update.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate18sirenUserDidCancelFT_T_":{"name":"sirenUserDidCancel()","abstract":"User did click on button that cancels update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidFailVersionCheckFT5errorCSo7NSError_T_":{"name":"sirenDidFailVersionCheck(error:)","abstract":"Siren failed to perform version check (may return system-level error).
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate36sirenDidDetectNewVersionWithoutAlertFT7messageSS_T_":{"name":"sirenDidDetectNewVersionWithoutAlert(message:)","abstract":"Siren performed version check and did not display alert.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate27sirenLatestVersionInstalledFT_T_":{"name":"sirenLatestVersionInstalled()","abstract":"Siren performed version check and latest version is installed.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html":{"name":"SirenDelegate","abstract":"Delegate that handles all codepaths for Siren upon version check completion.
"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6ArabicFMS1_S1_":{"name":"Arabic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8ArmenianFMS1_S1_":{"name":"Armenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6BasqueFMS1_S1_":{"name":"Basque","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType17ChineseSimplifiedFMS1_S1_":{"name":"ChineseSimplified","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18ChineseTraditionalFMS1_S1_":{"name":"ChineseTraditional","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8CroatianFMS1_S1_":{"name":"Croatian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6DanishFMS1_S1_":{"name":"Danish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5DutchFMS1_S1_":{"name":"Dutch","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7EnglishFMS1_S1_":{"name":"English","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8EstonianFMS1_S1_":{"name":"Estonian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7FinnishFMS1_S1_":{"name":"Finnish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6FrenchFMS1_S1_":{"name":"French","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6GermanFMS1_S1_":{"name":"German","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5GreekFMS1_S1_":{"name":"Greek","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6HebrewFMS1_S1_":{"name":"Hebrew","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9HungarianFMS1_S1_":{"name":"Hungarian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10IndonesianFMS1_S1_":{"name":"Indonesian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7ItalianFMS1_S1_":{"name":"Italian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8JapaneseFMS1_S1_":{"name":"Japanese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6KoreanFMS1_S1_":{"name":"Korean","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7LatvianFMS1_S1_":{"name":"Latvian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10LithuanianFMS1_S1_":{"name":"Lithuanian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5MalayFMS1_S1_":{"name":"Malay","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9NorwegianFMS1_S1_":{"name":"Norwegian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6PolishFMS1_S1_":{"name":"Polish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType16PortugueseBrazilFMS1_S1_":{"name":"PortugueseBrazil","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18PortuguesePortugalFMS1_S1_":{"name":"PortuguesePortugal","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7RussianFMS1_S1_":{"name":"Russian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType15SerbianCyrillicFMS1_S1_":{"name":"SerbianCyrillic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType12SerbianLatinFMS1_S1_":{"name":"SerbianLatin","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9SlovenianFMS1_S1_":{"name":"Slovenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SpanishFMS1_S1_":{"name":"Spanish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SwedishFMS1_S1_":{"name":"Swedish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType4ThaiFMS1_S1_":{"name":"Thai","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7TurkishFMS1_S1_":{"name":"Turkish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10VietnameseFMS1_S1_":{"name":"Vietnamese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/SirenVersionCheckType.html#/s:FOC5Siren5Siren21SirenVersionCheckType11immediatelyFMS1_S1_":{"name":"immediately","abstract":"Version check performed every time the app is launched.
","parent_name":"SirenVersionCheckType"},"Classes/Siren/SirenVersionCheckType.html#/s:FOC5Siren5Siren21SirenVersionCheckType5dailyFMS1_S1_":{"name":"daily","abstract":"Version check performed once a day.
","parent_name":"SirenVersionCheckType"},"Classes/Siren/SirenVersionCheckType.html#/s:FOC5Siren5Siren21SirenVersionCheckType6weeklyFMS1_S1_":{"name":"weekly","abstract":"Version check performed once a week.
","parent_name":"SirenVersionCheckType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType5forceFMS1_S1_":{"name":"force","abstract":"Forces user to update your app (1 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType6optionFMS1_S1_":{"name":"option","abstract":"(DEFAULT) Presents user with option to update app now or at next launch (2 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4skipFMS1_S1_":{"name":"skip","abstract":"Presents user with option to update the app now, at next launch, or to skip this version all together (3 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4noneFMS1_S1_":{"name":"none","abstract":"Doesn’t show the alert, but instead returns a localized message","parent_name":"AlertType"},"Classes/Siren.html#/s:vC5Siren5Siren16SirenErrorDomainSS":{"name":"SirenErrorDomain","abstract":"
The error domain for all errors created by Siren.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren8delegateXwGSqPS_13SirenDelegate__":{"name":"delegate","abstract":"The SirenDelegate variable, which should be set if you’d like to be notified:
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren12debugEnabledSb":{"name":"debugEnabled","abstract":"The debug flag, which is disabled by default.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren9alertTypeOS0_9AlertType":{"name":"alertType","abstract":"
Determines the type of alert that should be shown.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20majorUpdateAlertTypeOS0_9AlertType":{"name":"majorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for major version updates: A.b.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20minorUpdateAlertTypeOS0_9AlertType":{"name":"minorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor version updates: a.B.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20patchUpdateAlertTypeOS0_9AlertType":{"name":"patchUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor patch updates: a.b.C","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren23revisionUpdateAlertTypeOS0_9AlertType":{"name":"revisionUpdateAlertType","abstract":"
Determines the type of alert that should be shown for revision updates: a.b.c.D","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren7appNameSS":{"name":"appName","abstract":"
The name of your app.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren11countryCodeGSqSS_":{"name":"countryCode","abstract":"
The region or country of an App Store in which your app is available.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren25forceLanguageLocalizationGSqOS0_12LanguageType_":{"name":"forceLanguageLocalization","abstract":"
Overrides the default localization of a user’s device when presenting the update message and button titles in the alert.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren24alertControllerTintColorGSqCSo7UIColor_":{"name":"alertControllerTintColor","abstract":"
Overrides the tint color for UIAlertController.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren50showAlertAfterCurrentVersionHasBeenReleasedForDaysSi":{"name":"showAlertAfterCurrentVersionHasBeenReleasedForDays","abstract":"When this is set, the alert will only show up if the current version has already been released for X days","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren22currentAppStoreVersionGSqSS_":{"name":"currentAppStoreVersion","abstract":"
The current version of your app that is available for download on the App Store
","parent_name":"Siren"},"Classes/Siren.html#/s:ZvC5Siren5Siren6sharedS0_":{"name":"shared","abstract":"The App’s Singleton
","parent_name":"Siren"},"Classes/Siren.html#/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_21SirenVersionCheckType_T_":{"name":"checkVersion(checkType:)","abstract":"Checks the currently installed version of your app against the App Store.","parent_name":"Siren"},"Classes/Siren/AlertType.html":{"name":"AlertType","abstract":"
Determines the type of alert to present after a successful version check has been performed.
","parent_name":"Siren"},"Classes/Siren/SirenVersionCheckType.html":{"name":"SirenVersionCheckType","abstract":"Determines the frequency in which the the version check is performed and the user is prompted to update the app.
","parent_name":"Siren"},"Classes/Siren/LanguageType.html":{"name":"LanguageType","abstract":"Determines the available languages in which the update message and alert button titles should appear.
","parent_name":"Siren"},"Classes/Siren.html":{"name":"Siren","abstract":"The Siren Class. A singleton that is initialized using the shared() method.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally."},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally."}} \ No newline at end of file +{"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidShowUpdateDialogFT9alertTypeOCS_5Siren9AlertType_T_":{"name":"sirenDidShowUpdateDialog(alertType:)","abstract":"User presented with update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate26sirenUserDidLaunchAppStoreFT_T_":{"name":"sirenUserDidLaunchAppStore()","abstract":"User did click on button that launched App Store.app.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate23sirenUserDidSkipVersionFT_T_":{"name":"sirenUserDidSkipVersion()","abstract":"User did click on button that skips version update.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate18sirenUserDidCancelFT_T_":{"name":"sirenUserDidCancel()","abstract":"User did click on button that cancels update dialog.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate24sirenDidFailVersionCheckFT5errorCSo7NSError_T_":{"name":"sirenDidFailVersionCheck(error:)","abstract":"Siren failed to perform version check (may return system-level error).
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate36sirenDidDetectNewVersionWithoutAlertFT7messageSS_T_":{"name":"sirenDidDetectNewVersionWithoutAlert(message:)","abstract":"Siren performed version check and did not display alert.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html#/s:FP5Siren13SirenDelegate27sirenLatestVersionInstalledFT_T_":{"name":"sirenLatestVersionInstalled()","abstract":"Siren performed version check and latest version is installed.
","parent_name":"SirenDelegate"},"Protocols/SirenDelegate.html":{"name":"SirenDelegate","abstract":"Delegate that handles all codepaths for Siren upon version check completion.
"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6ArabicFMS1_S1_":{"name":"Arabic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8ArmenianFMS1_S1_":{"name":"Armenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6BasqueFMS1_S1_":{"name":"Basque","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType17ChineseSimplifiedFMS1_S1_":{"name":"ChineseSimplified","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18ChineseTraditionalFMS1_S1_":{"name":"ChineseTraditional","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8CroatianFMS1_S1_":{"name":"Croatian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6DanishFMS1_S1_":{"name":"Danish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5DutchFMS1_S1_":{"name":"Dutch","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7EnglishFMS1_S1_":{"name":"English","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8EstonianFMS1_S1_":{"name":"Estonian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7FinnishFMS1_S1_":{"name":"Finnish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6FrenchFMS1_S1_":{"name":"French","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6GermanFMS1_S1_":{"name":"German","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5GreekFMS1_S1_":{"name":"Greek","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6HebrewFMS1_S1_":{"name":"Hebrew","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9HungarianFMS1_S1_":{"name":"Hungarian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10IndonesianFMS1_S1_":{"name":"Indonesian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7ItalianFMS1_S1_":{"name":"Italian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType8JapaneseFMS1_S1_":{"name":"Japanese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6KoreanFMS1_S1_":{"name":"Korean","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7LatvianFMS1_S1_":{"name":"Latvian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10LithuanianFMS1_S1_":{"name":"Lithuanian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType5MalayFMS1_S1_":{"name":"Malay","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9NorwegianFMS1_S1_":{"name":"Norwegian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType6PolishFMS1_S1_":{"name":"Polish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType16PortugueseBrazilFMS1_S1_":{"name":"PortugueseBrazil","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType18PortuguesePortugalFMS1_S1_":{"name":"PortuguesePortugal","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7RussianFMS1_S1_":{"name":"Russian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType15SerbianCyrillicFMS1_S1_":{"name":"SerbianCyrillic","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType12SerbianLatinFMS1_S1_":{"name":"SerbianLatin","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType9SlovenianFMS1_S1_":{"name":"Slovenian","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SpanishFMS1_S1_":{"name":"Spanish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7SwedishFMS1_S1_":{"name":"Swedish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType4ThaiFMS1_S1_":{"name":"Thai","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType7TurkishFMS1_S1_":{"name":"Turkish","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/LanguageType.html#/s:FOC5Siren5Siren12LanguageType10VietnameseFMS1_S1_":{"name":"Vietnamese","abstract":"Undocumented","parent_name":"LanguageType"},"Classes/Siren/VersionCheckType.html#/s:FOC5Siren5Siren16VersionCheckType11immediatelyFMS1_S1_":{"name":"immediately","abstract":"Version check performed every time the app is launched.
","parent_name":"VersionCheckType"},"Classes/Siren/VersionCheckType.html#/s:FOC5Siren5Siren16VersionCheckType5dailyFMS1_S1_":{"name":"daily","abstract":"Version check performed once a day.
","parent_name":"VersionCheckType"},"Classes/Siren/VersionCheckType.html#/s:FOC5Siren5Siren16VersionCheckType6weeklyFMS1_S1_":{"name":"weekly","abstract":"Version check performed once a week.
","parent_name":"VersionCheckType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType5forceFMS1_S1_":{"name":"force","abstract":"Forces user to update your app (1 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType6optionFMS1_S1_":{"name":"option","abstract":"(DEFAULT) Presents user with option to update app now or at next launch (2 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4skipFMS1_S1_":{"name":"skip","abstract":"Presents user with option to update the app now, at next launch, or to skip this version all together (3 button alert).
","parent_name":"AlertType"},"Classes/Siren/AlertType.html#/s:FOC5Siren5Siren9AlertType4noneFMS1_S1_":{"name":"none","abstract":"Doesn’t show the alert, but instead returns a localized message","parent_name":"AlertType"},"Classes/Siren.html#/s:vC5Siren5Siren16SirenErrorDomainSS":{"name":"SirenErrorDomain","abstract":"
The error domain for all errors created by Siren.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren8delegateXwGSqPS_13SirenDelegate__":{"name":"delegate","abstract":"The SirenDelegate variable, which should be set if you’d like to be notified:
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren12debugEnabledSb":{"name":"debugEnabled","abstract":"The debug flag, which is disabled by default.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren9alertTypeOS0_9AlertType":{"name":"alertType","abstract":"
Determines the type of alert that should be shown.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20majorUpdateAlertTypeOS0_9AlertType":{"name":"majorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for major version updates: A.b.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20minorUpdateAlertTypeOS0_9AlertType":{"name":"minorUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor version updates: a.B.c","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren20patchUpdateAlertTypeOS0_9AlertType":{"name":"patchUpdateAlertType","abstract":"
Determines the type of alert that should be shown for minor patch updates: a.b.C","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren23revisionUpdateAlertTypeOS0_9AlertType":{"name":"revisionUpdateAlertType","abstract":"
Determines the type of alert that should be shown for revision updates: a.b.c.D","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren7appNameSS":{"name":"appName","abstract":"
The name of your app.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren11countryCodeGSqSS_":{"name":"countryCode","abstract":"
The region or country of an App Store in which your app is available.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren25forceLanguageLocalizationGSqOS0_12LanguageType_":{"name":"forceLanguageLocalization","abstract":"
Overrides the default localization of a user’s device when presenting the update message and button titles in the alert.","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren24alertControllerTintColorGSqCSo7UIColor_":{"name":"alertControllerTintColor","abstract":"
Overrides the tint color for UIAlertController.
","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren50showAlertAfterCurrentVersionHasBeenReleasedForDaysSi":{"name":"showAlertAfterCurrentVersionHasBeenReleasedForDays","abstract":"When this is set, the alert will only show up if the current version has already been released for X days","parent_name":"Siren"},"Classes/Siren.html#/s:vC5Siren5Siren22currentAppStoreVersionGSqSS_":{"name":"currentAppStoreVersion","abstract":"
The current version of your app that is available for download on the App Store
","parent_name":"Siren"},"Classes/Siren.html#/s:ZvC5Siren5Siren6sharedS0_":{"name":"shared","abstract":"The App’s Singleton
","parent_name":"Siren"},"Classes/Siren.html#/s:FC5Siren5Siren12checkVersionFT9checkTypeOS0_16VersionCheckType_T_":{"name":"checkVersion(checkType:)","abstract":"Checks the currently installed version of your app against the App Store.","parent_name":"Siren"},"Classes/Siren/AlertType.html":{"name":"AlertType","abstract":"
Determines the type of alert to present after a successful version check has been performed.
","parent_name":"Siren"},"Classes/Siren/VersionCheckType.html":{"name":"VersionCheckType","abstract":"Determines the frequency in which the the version check is performed and the user is prompted to update the app.
","parent_name":"Siren"},"Classes/Siren/LanguageType.html":{"name":"LanguageType","abstract":"Determines the available languages in which the update message and alert button titles should appear.
","parent_name":"Siren"},"Classes/Siren.html":{"name":"Siren","abstract":"The Siren Class. A singleton that is initialized using the shared() method.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally."},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally."}} \ No newline at end of file