Compare commits

...

175 Commits

Author SHA1 Message Date
Arthur Ariel Sabintsev a3c7cfa26d Updated imports 2019-03-10 23:42:11 -04:00
Arthur Ariel Sabintsev 8477f5fbe6 Updated podspec 2019-03-10 23:40:40 -04:00
Arthur Ariel Sabintsev 3c036ce559 A couple more import fixes 2019-03-10 23:40:17 -04:00
Thi 212e68969a Fix missing imports (#273) 2019-03-10 23:37:39 -04:00
Arthur Ariel Sabintsev 56a834ee41 Reverted default uncommented example 2019-02-09 22:52:04 -05:00
Arthur Ariel Sabintsev df6174ba06 Simplified oberver methods 2019-02-09 22:50:34 -05:00
Arthur Ariel Sabintsev a11b7f0600 Updated Podspec 2019-02-08 20:42:16 -05:00
Ryoh Tsukahara de971bf52f FIX a conditional statement for the skip action. (#270) 2019-02-08 20:41:52 -05:00
Arthur Ariel Sabintsev 5f00463928 Update README.md 2019-02-02 23:01:12 -05:00
Arthur Ariel Sabintsev cf4274fb16 Update README.md 2019-02-02 22:15:09 -05:00
Arthur Ariel Sabintsev a2cd55d83b Merge branch 'master' of https://github.com/ArtSabintsev/Siren 2019-02-02 16:30:07 -05:00
Arthur Ariel Sabintsev 3c064ffa4e Updated docs 2019-02-02 16:29:55 -05:00
Arthur Ariel Sabintsev 84301d4ba2 Update README.md 2019-02-02 16:28:46 -05:00
Arthur Ariel Sabintsev e226f934c0 Updated podspec to 4.1.1 2019-02-02 16:05:29 -05:00
Arthur Ariel Sabintsev 33b6e60862 Improved documentation in a few places and improved Results type 2019-02-02 16:03:56 -05:00
Arthur Ariel Sabintsev fc64e7aca7 Updated docs and travis file 2019-02-02 15:47:23 -05:00
Arthur Ariel Sabintsev f976791460 Updated Podspec to 4.1.0 2019-02-02 15:34:35 -05:00
Arthur Ariel Sabintsev 2a948f0133 Manual version check and alert presentation (#268)
* Manual version check and alert presentation

* Fixes #267

* Adds the PerformCheck enum

* Added a deinit

* Reverted appdelegate uncommented method

* Updated rule ordering to be alphabetical

* Standardized naming

* emoved extra space

* Updated docs
2019-02-02 15:31:43 -05:00
Morgan Dock 2253c339ff add hinting static rules configuration (#269) 2019-02-02 15:09:50 -05:00
Arthur Ariel Sabintsev 85a8a4141d Removed shouldPerformVersionCheckOnSubsequentLaunch userdefault to fi… (#264)
* Removed shouldPerformVersionCheckOnSubsequentLaunch userdefault to fix NexTime bug

* Updated podspec to 4.0.2
2019-01-10 23:46:26 -05:00
Arthur Ariel Sabintsev fc8d7d80d0 Update README.md 2019-01-08 23:59:05 -05:00
Arthur Ariel Sabintsev 7167868002 Update README.md 2019-01-08 23:55:49 -05:00
Arthur Ariel Sabintsev ced4415181 Update README.md 2019-01-08 20:27:13 -05:00
Arthur Ariel Sabintsev d28f69d7bc Update README.md 2019-01-08 20:24:37 -05:00
Arthur Ariel Sabintsev 790d771a2a Improved AppDelegate examples 2019-01-08 20:14:02 -05:00
Arthur Ariel Sabintsev eed4b9ac41 Reverted example project back to defaultExampleUsingCompletionHandler() 2019-01-05 23:21:37 -05:00
Arthur Ariel Sabintsev cde489c888 Fixed alert layering issue. Fixed function scoping. Added background observer. Updated docs 2019-01-05 23:08:34 -05:00
Arthur Ariel Sabintsev 6c8a47fb17 Update README.md 2019-01-03 10:05:45 -05:00
Arthur Ariel Sabintsev 40fbca14a2 Update README.md 2018-12-28 11:52:47 -05:00
Arthur Ariel Sabintsev c31afc015a Update README.md 2018-12-28 11:45:14 -05:00
Arthur Ariel Sabintsev c508279a0c Update .gitignore 2018-12-27 23:43:23 -05:00
Arthur Ariel Sabintsev 7502760c6e Update README.md 2018-12-27 23:42:54 -05:00
Arthur Ariel Sabintsev eabb29fc8b Updated README 2018-12-27 08:42:43 -05:00
Arthur Ariel Sabintsev cc3b7b6715 Update README.md 2018-12-27 08:41:53 -05:00
Arthur Ariel Sabintsev 1503bcbb1c Update README.md 2018-12-27 08:39:45 -05:00
Arthur Ariel Sabintsev 15872781a8 Update README.md 2018-12-27 08:37:59 -05:00
Arthur Ariel Sabintsev 4286f34b1d Update README.md 2018-12-27 08:37:36 -05:00
Arthur Ariel Sabintsev 78526b17cb Update README.md 2018-12-27 08:36:42 -05:00
Arthur Ariel Sabintsev 217883dc34 Update README.md 2018-12-27 08:36:01 -05:00
Arthur Ariel Sabintsev a492985dcf Update README.md 2018-12-27 08:35:00 -05:00
Arthur Ariel Sabintsev 85c6867a70 Update README.md 2018-12-27 08:34:46 -05:00
Arthur Ariel Sabintsev dbfe20032f Siren 4.0.0 (#250)
* Scoping changes to most utility classes

* Updated docs

* Continued code clean up and file renaming

* Metadata cleanup

* Updated docs

* Updated Siren.podspec to 4.0.0

* Massive overhaul of the localization logic

* Fixed tests

* Updated docs

* Minor cleanup

* Added new Configuration type but have not hooked it up

* Non-working commit for Configuration

* Continued configuration by thinning down Siren's main interface

* Removed singleton and improved window presenting logic

* Removed dead code. Confined utility methods to proper locations

* Updated some documentation

* Rebuilt version checking and alert presentation logic, however skip alert presentation logic is broken

* Fixed skip version logic

* Added default settings

* Removed delegates and added completion handler

* Changed initialization scheme

* Minor changes to initialization

* Fixed tests and error logic

* Minor changes to sample project

* Renamed all managers

* Improved Errors

* Continued cleanup

* Mor cleanup

* Continued cleanup

* Removed Log struct as it is no longer needed. Removed unused helpers. Merged remaining helpers into mainline Siren.swift file

* Began adding more documentation

* Renamed alertManager to presentationManager

* Removed redundant comments

* Changed alphabetical ordering

* Added some more built in rules

* minor improvemeent to VersionCheckFrequency

* Code cleanup

* Added some missing errors

* More robust error handling

* Added more rules

* Changed start to wail

* Added deviceLanguageLocalization

* Added documentation to BundleExtension

* Added DateExtension documentation

* Added UIAlertController extension documentation

* Added UserDefaultsExtension documentation

* Added APIManager documentation

* Added PresentationManager documentation and began adding RulesManager documentation

* Added AlertAction documentation

* Added Results.swift documentation

* Added Rules.swift documentation

* Added documentation to VersionParser and SirenViewController

* Some metadata cleanup

* Lots more documentation

* Moved networking code in APIManagr.swift

* Moved lots of logic out of siren and into PresentationManager and Localization

* More abstraction

* Cleaned up alert presentation

* More cleanup

* minor changres

* App now has less properties, improved uni-directional flow, and tests that account for that

* Continued code modification

* More documentation changes

* More scope changes

* More scope changes

* More documentation

* Fixed app store version null bug

* More changes

* Reorganized code in presentationmanager

* Reorganized code in presentationmanager

* Improved cache handling

* Added a lot more documentation and removed some unnecessary optionality

* Continued adding documentation

* Fixed bug with layering of alert. Tons more documentation

* Finished documenting all functions and properties

* Updated jazzy docs

* Added missing documentation

* Removed superfluous files

* Fixed bugs around prompt frequency. Updated code and documentation around prompt frequency

* Reached 100% of private function and beyond documentation

* Fixed bug arond presenting localized strings vs custom strings

* Added lots of examples to AppDelegate. Updated README. Removed attributed string settings since they never worked

* Documentation updated. Added tons of examples to AppDelegate.swift with comments

* Updated README

* Updated README.md

* Updated README.md

* Updated README.md

* Removed random fragment in readme

* Updated README

* More README updates

* More README updates

* Updated README

* More metadata updates

* Update metadata

* Regenerated jazzy docs
2018-12-26 20:47:03 -05:00
Arthur Ariel Sabintsev 168cc437c1 Update ISSUE_TEMPLATE.md 2018-12-21 22:38:07 -05:00
Arthur Ariel Sabintsev b65d0d9c75 Updated Siren.podspec 2018-12-20 17:21:55 -05:00
ivan aee7eeca8a Update Siren.swift (#254)
* Update Siren.swift

- fixed url session caching issue in performVersionCheck().

* Update Siren.swift

- swapped .reloadIgnoringCacheData caching policy with .reloadIgnoringLocalAndRemoteCacheData in performVersionCheck() method.
2018-12-20 17:17:48 -05:00
ArtSabintsev dc63e9ea2f Updated base ruby-version 2018-11-17 13:50:08 -05:00
Arthur Ariel Sabintsev 121178a603 Update README.md 2018-11-10 10:59:40 -05:00
Arthur Ariel Sabintsev d946ccbc1b Updated Podspec and Contributors docs 2018-11-09 13:03:42 -05:00
Ilija Puaca 608329ec30 Removed print statement from UserDefaults getter (#247) 2018-11-09 13:02:08 -05:00
Arthur Ariel Sabintsev 8686a397dd Update README.md 2018-11-09 13:01:08 -05:00
Arthur Ariel Sabintsev 4dd7941d22 Updated podspec and docs 2018-11-07 21:42:47 -05:00
Arthur Ariel Sabintsev a43d87d0ae Reverted trackId back to Int. Closes #246 2018-11-07 21:41:46 -05:00
Arthur Ariel Sabintsev 9a72fcc164 Minor stylistic change 2018-11-04 07:18:18 -05:00
Arthur Ariel Sabintsev 2b15eb55aa Minor stylistic change 2018-11-04 07:16:23 -05:00
Arthur Ariel Sabintsev 364ba7d755 Updated Gems 2018-11-01 23:36:01 -04:00
Arthur Ariel Sabintsev fb9633cf25 Update Gemfile 2018-11-01 23:22:14 -04:00
Arthur Ariel Sabintsev 417caff8b1 Updated Siren docs 2018-10-29 23:10:36 -04:00
Arthur Ariel Sabintsev a66052c592 Updated docs 2018-10-29 23:09:59 -04:00
Arthur Ariel Sabintsev d152dc4887 Update ISSUE_TEMPLATE.md 2018-10-29 22:51:10 -04:00
Arthur Ariel Sabintsev 7ff3f21945 Update ISSUE_TEMPLATE.md 2018-10-29 22:48:12 -04:00
Arthur Ariel Sabintsev 5b3742175c Update ISSUE_TEMPLATE.md 2018-10-29 22:47:59 -04:00
Arthur Ariel Sabintsev 2e0b11d30a Update ISSUE_TEMPLATE.md 2018-10-29 22:47:45 -04:00
Arthur Ariel Sabintsev 7176b45aed Update ISSUE_TEMPLATE.md 2018-10-29 22:47:12 -04:00
Arthur Ariel Sabintsev 954ce02353 Update ISSUE_TEMPLATE.md 2018-10-26 10:43:09 -04:00
Arthur Ariel Sabintsev a3fbdfaee0 Update ISSUE_TEMPLATE.md 2018-10-26 10:26:35 -04:00
Arthur Ariel Sabintsev 92c8ac45cc Update README.md 2018-10-25 22:37:42 -04:00
Arthur Ariel Sabintsev 63ed8219dc Update README.md 2018-10-25 22:37:35 -04:00
Arthur Ariel Sabintsev 2b482d367c Fixed indentation 2018-10-25 21:18:17 -04:00
Arthur Ariel Sabintsev cc639488b3 Updated lockfile 2018-10-25 20:59:58 -04:00
Arthur Ariel Sabintsev 0772192629 Updated podspec 2018-10-25 20:52:28 -04:00
Arthur Ariel Sabintsev c2449e25a2 Fixed tackId parsing. Added some documentation 2018-10-25 20:50:36 -04:00
Arthur Ariel Sabintsev da0b258863 Update README.md 2018-10-02 08:37:13 -04:00
Arthur Ariel Sabintsev 58da2806a1 Update README.md 2018-09-29 23:08:58 -04:00
Arthur Ariel Sabintsev 25ec41abbd Updated docs 2018-09-29 23:04:40 -04:00
Arthur Ariel Sabintsev 1c9dd88d68 Update README.md 2018-09-29 23:03:55 -04:00
Arthur Ariel Sabintsev dd0966b29b Updated podspec 2018-09-29 00:02:53 -04:00
Arthur Ariel Sabintsev 421eb6802e 100% documentation again 2018-09-29 00:00:26 -04:00
Arthur Ariel Sabintsev 01c33f99d6 Added more docs 2018-09-28 23:51:39 -04:00
Arthur Ariel Sabintsev de925dc477 Added more missing documentation 2018-09-28 23:44:50 -04:00
Arthur Ariel Sabintsev bdf15f9be8 Updated project 2018-09-28 10:02:09 -04:00
Arthur Ariel Sabintsev 8cb742d2a6 Updated docs 2018-09-28 09:59:55 -04:00
Arthur Ariel Sabintsev 2168a4f1fc Updated docs 2018-09-28 09:58:39 -04:00
Arthur Ariel Sabintsev 1febce77dd Updated podspec 2018-09-27 22:22:23 -04:00
Arthur Ariel Sabintsev 2197494481 Removed force unwrapped localization methods 2018-09-27 22:21:42 -04:00
Arthur Ariel Sabintsev 74284809e3 Cleaned up constants file 2018-09-27 21:51:47 -04:00
Arthur Ariel Sabintsev 841d04dafd Removed dead file 2018-09-27 21:47:09 -04:00
Arthur Ariel Sabintsev d4c7baf247 project updates 2018-09-27 21:41:46 -04:00
Arthur Ariel Sabintsev 6f0b8f733c Minor changes 2018-09-27 21:39:09 -04:00
Arthur Ariel Sabintsev f217d5cd73 Further refactoring for Swift 4.2 (#231)
* Began moving code around to clean Siren.swift

* further cleanup of siren.swift

* Removed superfluous test helping function

* More code cleanup

* Added code that potentially fixes old bug about users not being reprompted after NEXT TIME is tapped

* Continued work on UserDefaults changes

* Improved UserDefaults handling

* Fixed UserDefaults comments
2018-09-27 21:37:01 -04:00
Arthur Ariel Sabintsev 7cfd6e788f Update README.md 2018-09-22 15:46:29 -04:00
Arthur Ariel Sabintsev 1a215cc608 Converted SirenAlertMessaging strings to type of NSAttributedString (#228)
* Converted SirenAlertMessaging strings to type of NSAttributedString

* Updated documentation

* Removed whitespace

* Removed more whitespace

* Updated sample code and README

* Updated sample code and README

* Updated sample code and README

* Added some docs

* Updated Gems

* Updated podspec
2018-09-22 15:41:32 -04:00
Arthur Ariel Sabintsev 7e30501d1c Update ISSUE_TEMPLATE.md 2018-09-21 07:53:02 -04:00
Arthur Ariel Sabintsev 6df36c9c8c Update .travis.yml 2018-09-20 08:23:10 -04:00
Arthur Ariel Sabintsev d7bbe9e8a6 Update README.md 2018-09-18 22:14:19 -04:00
Arthur Ariel Sabintsev 62b51d52a5 Removed .build folder 2018-09-18 21:43:19 -04:00
Arthur Ariel Sabintsev 6aa91d26c4 Minor changes 2018-09-18 21:07:44 -04:00
Arthur Ariel Sabintsev beb19f19c0 Updated osx_image to xcode10 2018-09-16 22:16:31 -04:00
Arthur Ariel Sabintsev 6e504a84a0 Updated example project and framework swift_version to 4.2 2018-09-16 21:58:19 -04:00
Arthur Ariel Sabintsev 129bffe9d8 Update README.md 2018-09-16 21:52:35 -04:00
Arthur Ariel Sabintsev cd4328feee Merged with swift4.2 branch 2018-09-16 21:46:26 -04:00
Arthur Ariel Sabintsev 1ac84cafc8 Updated podspec and other files 2018-09-16 21:45:58 -04:00
Arthur Ariel Sabintsev 36bff434f6 Merge branch 'master' into swift4.2 2018-09-16 21:40:38 -04:00
Arthur Ariel Sabintsev 94b319573e Update README.md 2018-08-07 14:17:50 -04:00
Arthur Ariel Sabintsev 43abfabe15 Update README.md 2018-08-04 21:10:50 -04:00
Arthur Ariel Sabintsev 9ac0dea011 Update README.md 2018-08-03 09:25:13 -04:00
Arthur Ariel Sabintsev 9721263f90 Updated project and framework to Swift 4.2. Updated UIWindowLevelAlert reference 2018-08-03 09:23:58 -04:00
Arthur Ariel Sabintsev 124fd715ef Xcode 10b5 fixes. 2018-08-03 08:59:16 -04:00
Arthur Ariel Sabintsev 1c3aee01fd Updated travis.yml 2018-07-28 01:13:26 -04:00
Arthur Ariel Sabintsev fe3b0acb6d Updated travis.yml 2018-07-28 00:54:08 -04:00
Arthur Ariel Sabintsev 509b5c9ca3 Updated travis.yml 2018-07-28 00:47:29 -04:00
Arthur Ariel Sabintsev 9c00d90424 Updated travis.yml 2018-07-28 00:40:01 -04:00
Arthur Ariel Sabintsev b4bba84753 Updated travis.yml 2018-07-27 22:39:40 -04:00
Arthur Ariel Sabintsev 47b95c97e0 Update README.md 2018-07-27 22:31:09 -04:00
Arthur Ariel Sabintsev fedee61c34 Update .travis.yml 2018-07-27 22:30:27 -04:00
Arthur Ariel Sabintsev 0c5c0fd1bf Update README.md 2018-07-25 22:02:40 -04:00
Arthur Ariel Sabintsev f2929ef72b Reverted docs location 2018-07-25 22:02:18 -04:00
Arthur Ariel Sabintsev f19075e6b4 Updated docs. Made certain sequences lazy 2018-07-25 22:00:38 -04:00
Arthur Ariel Sabintsev 4063d7e061 Updated docs and gems 2018-07-25 11:46:42 -04:00
Arthur Ariel Sabintsev 75bf43da3c Merged with downstream 2018-07-24 10:01:39 -04:00
Arthur Ariel Sabintsev 556382e38e Updatdd metadata 2018-07-24 09:59:59 -04:00
Titouan Van Belle de480f9cb8 Update German localisation (#218)
The current translation is not grammatically ideal.
2018-07-24 09:56:48 -04:00
Arthur Ariel Sabintsev 0643cd318c Update README.md 2018-07-04 12:34:34 -04:00
Arthur Ariel Sabintsev c7ffac16a1 Update README.md 2018-07-04 12:34:20 -04:00
Arthur Ariel Sabintsev 0f85e4087a Updated CONTRIBUTORS.md file 2018-07-01 22:33:08 -04:00
Arthur Ariel Sabintsev 1bdffa86fc Updated podspec 2018-07-01 22:29:50 -04:00
Arthur Ariel Sabintsev 8ffc87556c Updated gems 2018-07-01 22:29:19 -04:00
Arthur Ariel Sabintsev 43a5d734c1 Minor changes 2018-07-01 22:28:34 -04:00
Ryan 4fad697cd5 Use method introduced in iOS 10 for opening URLs with UIApplication, when appropriate. (#216) 2018-07-01 22:15:34 -04:00
Arthur Ariel Sabintsev 7ab708edf6 Minor changes after path renames 2018-07-01 21:59:48 -04:00
Arthur Ariel Sabintsev 094b218c1d Renamed example project and tests project 2018-07-01 21:57:26 -04:00
Arthur Ariel Sabintsev 3117731c00 Removed jazzy.yml 2018-06-07 22:52:10 -04:00
Arthur Ariel Sabintsev 3d7ebea02f Merge branch 'master' of https://github.com/ArtSabintsev/Siren 2018-06-07 22:51:35 -04:00
Arthur Ariel Sabintsev 53f32cd3d5 Updated docs 2018-06-07 22:51:33 -04:00
Arthur Ariel Sabintsev af6a9825e1 Update .gitattributes 2018-06-07 22:50:02 -04:00
Arthur Ariel Sabintsev bc570b028e Updated README 2018-06-07 22:48:42 -04:00
Arthur Ariel Sabintsev c37cd6968f Update .gitattributes 2018-06-07 22:47:23 -04:00
Arthur Ariel Sabintsev ef8498a8e6 Updated metadata 2018-06-06 20:51:41 -04:00
Arthur Ariel Sabintsev 10ddcab12c Updated logic slightly. Updated sample bundleId 2018-06-06 20:49:35 -04:00
Arthur Ariel Sabintsev 8344ed8cb3 Merge branch 'master' of https://github.com/ArtSabintsev/Siren 2018-06-06 20:07:38 -04:00
Gabriel Martelo d3668c8943 Localized title (#214)
* Expose localized title

* Update sirenDidDetectNewVersionWithoutAlert delegate method
2018-06-06 20:06:04 -04:00
Arthur Ariel Sabintsev 4def0e9441 Merge branch 'master' of https://github.com/ArtSabintsev/Siren 2018-05-08 19:48:47 -04:00
Arthur Ariel Sabintsev fa692a3912 Update README.md 2018-04-27 23:09:17 -04:00
Arthur Ariel Sabintsev 80a449975b Updated gitattributes 2018-04-27 23:09:02 -04:00
Arthur Ariel Sabintsev 3fd2f93d21 Update README.md 2018-04-27 23:08:41 -04:00
Arthur Ariel Sabintsev 13ad9ba3da Updated gitattributes 2018-04-27 23:04:37 -04:00
Arthur Ariel Sabintsev 31a59a4b3c Added .gitattributes 2018-04-27 23:00:45 -04:00
Arthur Ariel Sabintsev 19f303535c Updated podspec 2018-04-27 22:50:39 -04:00
Arthur Ariel Sabintsev cdfae11e70 SirenDelegate Enhancements (#210)
* SirenDelegate now returns SirenLookupModel

* Updated README and documentation

* Updated README

* Updated .travis.yml file
2018-04-27 22:50:11 -04:00
Arthur Ariel Sabintsev 676b125666 Updated podspec 2018-04-27 22:19:59 -04:00
Arthur Ariel Sabintsev 3032aed434 Updated jazzy and docs 2018-04-27 22:19:35 -04:00
Arthur Ariel Sabintsev a9a5be48e6 Minor enhancements to documentation and SirenLookupModel 2018-04-27 22:10:18 -04:00
Antoine Cœur 6999fefad4 HTTPS when supported (#209) 2018-04-27 12:56:47 -04:00
Arthur Ariel Sabintsev 7ef6584c14 Update README.md 2018-04-27 11:00:05 -04:00
Arthur Ariel Sabintsev ecf41d965c Merge branch 'master' of https://github.com/ArtSabintsev/Siren 2018-04-23 19:59:53 -04:00
Arthur Ariel Sabintsev 4338a2dae2 Updated model to be alphabetical 2018-04-23 19:59:52 -04:00
Arthur Ariel Sabintsev e80a073fe9 Update README.md 2018-04-23 19:57:35 -04:00
Arthur Ariel Sabintsev a1404096bf Updated Siren 2018-04-23 10:23:14 -04:00
Arthur Ariel Sabintsev cef1a7f560 Update README.md 2018-04-23 10:19:26 -04:00
Arthur Ariel Sabintsev 7ef618d402 Update README.md 2018-04-23 10:15:59 -04:00
Arthur Ariel Sabintsev 4b32315ad1 Modified travis.yml file 2018-04-23 10:06:33 -04:00
Arthur Ariel Sabintsev 2504f5efc0 Modified travis.yml file 2018-04-23 09:58:12 -04:00
Arthur Ariel Sabintsev 2acc8ee0c0 Added travis.yml file 2018-04-23 09:53:47 -04:00
Arthur Ariel Sabintsev 2c833b84ee Updated docs and metadata 2018-04-23 09:50:35 -04:00
Arthur Ariel Sabintsev fd5aaabb99 Minor doc change 2018-04-23 09:44:23 -04:00
Arthur Ariel Sabintsev 4eb31510d0 Fixed unowned to weak 2018-04-23 09:40:12 -04:00
Arthur Ariel Sabintsev 8bb784a16b SirenLookupModel now parses releaseNotes. Closes #206. 2018-04-23 09:35:01 -04:00
Arthur Ariel Sabintsev c98b124f73 Update README.md 2018-03-29 16:42:16 -04:00
Arthur Ariel Sabintsev 5e12e74e9c Update README.md 2018-03-29 16:16:09 -04:00
Arthur Ariel Sabintsev 04ad0f1682 Update gemfile 2018-03-29 16:02:46 -04:00
Arthur Ariel Sabintsev 87a58c65de Updated podspec 2018-03-29 16:01:38 -04:00
Arthur Ariel Sabintsev c2e278df55 Updated syntax for 4.1 2018-03-29 15:58:42 -04:00
Arthur Ariel Sabintsev dee7bc8e5e Updated synatx for 4.1. 2018-03-29 15:58:04 -04:00
Arthur Ariel Sabintsev e7fc566b10 Updated docs 2018-03-22 00:30:58 -04:00
Arthur Ariel Sabintsev a4ab45f772 Update README.md 2018-03-14 22:30:06 -04:00
Arthur Ariel Sabintsev c72eaf234c Improved ccoapods compatibility by modernizing podspec 2018-03-14 21:32:52 -04:00
264 changed files with 43777 additions and 10665 deletions
+1
View File
@@ -0,0 +1 @@
docs/* linguist-vendored
+16 -6
View File
@@ -1,18 +1,28 @@
Before posting an issue, please make sure your issue has not already been resolved or answered elsewhere.
# If you're experiencing a problem integrating Siren into your app, please provide the following information when posting a new issue:
Common Issue #1:
> "Error retrieving iOS version number as there was no data returned."
- **Are you using the [latest version](https://github.com/ArtSabintsev/Siren/releases) of Siren?**:
- **What is your app's Bundle ID?**:
- **When was the latest version of your app published to the App Store?**:
- **Is your app published in the US App Store? If not, what App Store is it published in?**:
- **Does Siren work if you plugin your app's `BundleID` (and `countryCode`, if necessary) into the Example app?**:
---
# Before posting an issue, please make sure your issue has not already been resolved or answered elsewhere.
## Common Issue #1:
>"Error retrieving iOS version number as there was no data returned."
Check if your app is available in the US App Store, otherwise add the corresponding country code when setting up Siren.
Common Issue #2:
## Common Issue #2:
> "Support for macOS App Store."
Siren does not and will not support the macOS App Store.
Common Issue #3:
## Common Issue #3:
> "Support for prompting TestFlight users to update to the newest beta build."
Siren does not support this functionality. There is no publicly accessible TestFlight API akin to that of the public App Store API that Siren can utilize to provide this functionality.
Please delete this text before submitting a new issue.
# Please delete this text before submitting a new issue.
-8
View File
@@ -17,11 +17,3 @@ DerivedData
*.ipa
*.xcuserstate
.DS_Store
# CocoaPods
#
# We recommend against adding the Pods directory to your .gitignore. However
# you should judge for yourself, the pros and cons are mentioned at:
# http://guides.cocoapods.org/using/using-cocoapods.html#should-i-ignore-the-pods-directory-in-source-control
#
# Pods/
-10
View File
@@ -1,10 +0,0 @@
module: Siren
author: Arthur Ariel Sabintsev
author_url: http://www.sabintsev.com
github_url: https://github.com/artsabintsev/siren
copyright: "© 2015-2017 [Arthur Ariel Sabintsev](http://www.sabintsev.com)"
theme: apple
output: docs
documentation: docs/*.md
clean: true
podspec: Siren.podspec
-1
View File
@@ -1 +0,0 @@
4.0
+2 -4
View File
@@ -5,13 +5,11 @@ included:
disabled_rules:
- cyclomatic_complexity
- line_length
- nesting
- unused_optional_binding
- variable_name
# Specialized Rules
file_length:
- 1000
line_length:
- 200
- 500
+10
View File
@@ -0,0 +1,10 @@
language: objective-c
osx_image: xcode10
notifications:
email: false
env:
- LC_CTYPE=en_US.UTF-8 LANG=en_US.UTF-8
script:
- set -o pipefail
- xcodebuild -project Example/Example.xcodeproj -scheme Example -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO | xcpretty -c
-80
View File
@@ -1,80 +0,0 @@
### Creators
[Arthur Ariel Sabintsev](http://www.sabintsev.com/) and [Aaron Brager](http://twitter.com/GetAaron)
### Siren Project Contributors
- [Dmitry Bespalov](https://github.com/diamondsky) for [Pull Request #7](https://github.com/ArtSabintsev/Siren/pull/7)
- [Daniel Bauke](https://github.com/bonkey) for [Pull Request #8](https://github.com/ArtSabintsev/Siren/pull/8)
- [ipedro](https://github.com/ipedro) for [Pull Request #76 (Harpy)](https://github.com/ArtSabintsev/Harpy/pull/76)
- [Michael Graff](http://github.com/skandragon) for [Pull Request #15](https://github.com/ArtSabintsev/Siren/pull/15)
- [Jaroslav_](https://github.com/jaroslavas) for [Pull Request #83 (Harpy)](https://github.com/ArtSabintsev/Harpy/pull/83)
- [Dylan Bettermann](https://github.com/dbettermann) for [Pull Request #18](https://github.com/ArtSabintsev/Siren/pull/18)
- [Daniel](https://github.com/Daniel) for [Pull Request #21](https://github.com/ArtSabintsev/Siren/pull/21)
- [nagaho](https://github.com/nagaho) for [Pull Request #22](https://github.com/ArtSabintsev/Siren/pull/22)
- [Parnsind Hantrakool](https://github.com/kong707) for [Pull Request #91 (Harpy)](https://github.com/ArtSabintsev/Harpy/issues/91)
- [Tibor Molnár](https://github.com/fatalaa) for [Pull Request #96 (Harpy)](https://github.com/ArtSabintsev/Harpy/issues/96)
- [Tanel Suurhans](https://github.com/tanelsuurhans) and [Jaroslav_](https://github.com/jaroslavas) for [Pull Request #99 (Harpy)](https://github.com/ArtSabintsev/Harpy/issues/99)
- [Zaid M. Said](https://github.com/SentulAsia) for [Pull Request #36](https://github.com/ArtSabintsev/Siren/pull/36)
- [Vahan Margaryan](https://github.com/VahanMargaryan) for [Pull Request #37](https://github.com/ArtSabintsev/Siren/pull/37)
- [Justus Kandzi](https://github.com/jkandzi) for [Pull Request #108 (Harpy)](https://github.com/ArtSabintsev/Harpy/pull/108)
- [Maxim-Inv](https://github.com/Maxim-Inv) for [Pull Request #40](https://github.com/ArtSabintsev/Siren/pull/40)
- [Dirk van Oosterbosch](https://github.com/irlabs) for [Pull Request #54](https://github.com/ArtSabintsev/Siren/pull/54) and [Pull Request #55](https://github.com/ArtSabintsev/Siren/pull/55)
- [pavankataria](https://github.com/pavankataria) for [Pull Request #63](https://github.com/ArtSabintsev/Siren/pull/63)
- [attilat85](https://github.com/attilat85) for [Pull Request #124 (Harpy)](https://github.com/ArtSabintsev/Harpy/pull/124)
- [Vahan Margaryan](https://github.com/VahanMargaryan) for [Pull Request #71](https://github.com/ArtSabintsev/Siren/pull/71)
- [Josip Injic](https://github.com/jinjic) for [Pull Request #73](https://github.com/ArtSabintsev/Siren/pull/73)
- [Thi](https://github.com/thii) for [Pull Request #78](https://github.com/ArtSabintsev/Siren/pull/78)
- [Ilija Puaca](https://github.com/ilijapuaca) for [Pull Request #141 (Harpy)](https://github.com/ArtSabintsev/Harpy/pull/141)
- [thii](https://github.com/ilijapuaca) for [Pull Request #83](https://github.com/ArtSabintsev/Siren/pull/83)
- [Kristaps Grinbergs](https://github.com/fassko) for [Pull Request #90](https://github.com/ArtSabintsev/Siren/pull/90)
- [Luciano Nascimento](https://github.com/@lucianocn) for [Pull Request #146 (Harpy)](https://github.com/ArtSabintsev/Harpy/pull/146)
- [Stefan Kieleithner](https://github.com/steviki) for [Pull Request #97](https://github.com/ArtSabintsev/Siren/pull/97)
- [Vladislav Jevremović](https://github.com/VladislavJevremovic) for [Pull Request #98](https://github.com/ArtSabintsev/Siren/pull/98)
- [Stefan Kieleithner](https://github.com/steviki) for [Pull Request #99](https://github.com/ArtSabintsev/Siren/pull/99)
- [Konstantinos N.](https://github.com/kwstasna) for [Pull Request #101](https://github.com/ArtSabintsev/Siren/pull/101)
- [Christoph Mantler](https://github.com/ChrisixFlash) for [Pull Request #103](https://github.com/ArtSabintsev/Siren/pull/103) and [Pull Request #106](https://github.com/ArtSabintsev/Siren/pull/106)
- [xedla](https://github.com/xedla) for [Pull Request #107](https://github.com/ArtSabintsev/Siren/pull/107)
- [Daniel Hu](https://github.com/zongmumask) for [Pull Request #116](https://github.com/ArtSabintsev/Siren/pull/116)
- [Jakob Krigovsky](https://github.com/sonicdoe) for [Pull Request #118](https://github.com/ArtSabintsev/Siren/pull/118)
- [germ4n](https://github.com/glm4) for [Pull Request #122](https://github.com/ArtSabintsev/Siren/pull/122)
- [Txai Wieser](https://github.com/txaiwieser) for [Pull Request #139](https://github.com/ArtSabintsev/Siren/pull/139) and [Pull Request #140](https://github.com/ArtSabintsev/Siren/pull/140)
- [premyslvlcek](https://github.com/premyslvlcek) for [Pull Request #143](https://github.com/ArtSabintsev/Siren/pull/143)
- [Seyed Mojtaba Hosseini Zeidabadi](https://github.com/MojtabaHs) for [Pull Request #144](https://github.com/ArtSabintsev/Siren/pull/143)
- [Chanchal Raj](https://github.com/RajChanchal) for [Pull Request #171 (Harpy)](https://github.com/ArtSabintsev/harpy/pull/171)
- [Ryoh Tsukahara](https://github.com/nixnoughtnothing) for [Pull Request #150](https://github.com/ArtSabintsev/Siren/pull/150) and [Pull Request #159](https://github.com/ArtSabintsev/Siren/pull/159)
- [Jason Wade](https://github.com/iJasonWade) for [Pull Request #162](https://github.com/ArtSabintsev/Siren/pull/162)
- [JussiSuojanen](https://github.com/JussiSuojanen) for [Pull Request #171](https://github.com/ArtSabintsev/Siren/pull/171)
- [Dmytro Cheverda](https://github.com/dimacheverda) for [Pull Request #175](https://github.com/ArtSabintsev/Siren/pull/175)
- [Vladislav Jevremovic](https://github.com/VladislavJevremovic) for [Pull Request #176](https://github.com/ArtSabintsev/Siren/pull/176)
- [NSemakov](https://github.com/NSemakov) for [Pull Request #179](https://github.com/ArtSabintsev/Siren/pull/179)
- [Attia Mo](https://github.com/attiamo) for [Pull Request #182](https://github.com/ArtSabintsev/Siren/pull/182)
- [wbison](https://github.com/wbison) for [Pull Request #185 (Harpy)](https://github.com/ArtSabintsev/Harpy/pull/185)
- [Balázs Vincze](https://github.com/vinczebalazs) for [Pull Request #200](https://github.com/ArtSabintsev/siren/pull/200)
- [Txai Wieser](https://github.com/txaiwieser) for [Pull Request #201](https://github.com/ArtSabintsev/siren/pull/200)
### Harpy Project Contributors
This repo is a Swift language port of [Harpy](http://github.com/ArtSabintsev/Harpy). We couldn't have built this port without acknowledging the following developers who were instrumental in getting Harpy to v3.2.1, the version of Harpy that Siren was based on.
A huge **Thank You** to the following developers:
- [Borut Tomažin](https://github.com/borut-t)
- [Bertie Liu](https://github.com/https://github.com/aceisScope)
- [Burakkilic](https://github.com/burakkilic)
- [Claas Lange](https://github.com/claaslange)
- [Daniel](https://github.com/danieltskv)
- [David Keegan](https://github.com/kgn)
- [Erick](https://github.com/dexcell0)
- [Ercillagorka](https://github.com/ercillagorka)
- [Jamie Ly](http://github,com/jamiely)
- [Jon Andersen](https://github.com/jonandersen)
- [Josh T. Brown](https://github.com/joshuatbrown)
- [Mark Rickert](https://github.com/markrickert)
- [Patrick Debois](https://github.com/jedi4ever)
- [Pius Uzamere](https://github.com/pius)
- [Rahul Jiresal](https://github.com/rahuljiresal)
- [Rui Peres](https://github.com/RuiAAPeres)
- [Thomas Hempel](https://github.com/thomashempel)
- [TrentW](https://github.com/trentw)
### Special Thanks
Finally, a massive **Thank You** to [Aaron Brager](http://twitter.com/GetAaron) for the dev-work and issue-moderation he's done on Harpy since 2012. A Swift port could not have happened without him.
@@ -7,37 +7,37 @@
objects = {
/* Begin PBXBuildFile section */
4D729C4421A20EDC002F73AB /* Siren.bundle in Resources */ = {isa = PBXBuildFile; fileRef = 55EC365E1E6BB99B00726F13 /* Siren.bundle */; };
4D729C4621A213B4002F73AB /* Rules.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4D729C4521A213B4002F73AB /* Rules.swift */; };
55EC364B1E6BB98A00726F13 /* Siren.h in Headers */ = {isa = PBXBuildFile; fileRef = 55EC36491E6BB98A00726F13 /* Siren.h */; settings = {ATTRIBUTES = (Public, ); }; };
55EC364E1E6BB98A00726F13 /* Siren.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 55EC36471E6BB98A00726F13 /* Siren.framework */; };
55EC364F1E6BB98A00726F13 /* Siren.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 55EC36471E6BB98A00726F13 /* Siren.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
55EC36601E6BB99B00726F13 /* Siren.bundle in Resources */ = {isa = PBXBuildFile; fileRef = 55EC365E1E6BB99B00726F13 /* Siren.bundle */; };
55EC36611E6BB99B00726F13 /* Siren.swift in Sources */ = {isa = PBXBuildFile; fileRef = 55EC365F1E6BB99B00726F13 /* Siren.swift */; };
8E01817921B379AF006DED05 /* Results.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E01817821B379AF006DED05 /* Results.swift */; };
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 */; };
8E2499BF1FD83DDF00F384BA /* SirenAlertMessaging.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E2499BE1FD83DDF00F384BA /* SirenAlertMessaging.swift */; };
8E43D6231E8223EE00ECFFC8 /* SirenDateExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E43D6221E8223EE00ECFFC8 /* SirenDateExtension.swift */; };
8E528A301E989A7A00B643C4 /* SirenDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E528A2F1E989A7A00B643C4 /* SirenDelegate.swift */; };
8E528A321E989E0A00B643C4 /* SirenTestHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E528A311E989E0A00B643C4 /* SirenTestHelper.swift */; };
8E5D15B11F3632D7001C0960 /* SirenLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E5D15B01F3632D7001C0960 /* SirenLog.swift */; };
8E9C238B1E7CDB42000ED3DA /* SirenBundleExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E9C238A1E7CDB42000ED3DA /* SirenBundleExtension.swift */; };
8E9C238D1E7CDD31000ED3DA /* SirenUIAlertControllerExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E9C238C1E7CDD31000ED3DA /* SirenUIAlertControllerExtension.swift */; };
8E9C238F1E7CDDE7000ED3DA /* SirenViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E9C238E1E7CDDE7000ED3DA /* SirenViewController.swift */; };
8EACA9701F37F327003134CA /* SirenLookupModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EACA96F1F37F327003134CA /* SirenLookupModel.swift */; };
8E171DDE215B26B4006FBBCC /* BundleExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DD1215B26B4006FBBCC /* BundleExtension.swift */; };
8E171DDF215B26B4006FBBCC /* DateExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DD2215B26B4006FBBCC /* DateExtension.swift */; };
8E171DE2215B26B4006FBBCC /* LookupModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DD7215B26B4006FBBCC /* LookupModel.swift */; };
8E171DE3215B26B4006FBBCC /* UIAlertControllerExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DD8215B26B4006FBBCC /* UIAlertControllerExtension.swift */; };
8E171DE4215B26B4006FBBCC /* SirenViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DDA215B26B4006FBBCC /* SirenViewController.swift */; };
8E171DE6215B2701006FBBCC /* Localization.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DE5215B2701006FBBCC /* Localization.swift */; };
8E171DEE215B2D09006FBBCC /* UserDefaultsExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E171DED215B2D09006FBBCC /* UserDefaultsExtension.swift */; };
8E5061EB21C9CDF000A28DE0 /* AlertConstants.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8E5061EA21C9CDF000A28DE0 /* AlertConstants.swift */; };
8E641D2520C8B44B00908555 /* Siren.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 55EC36471E6BB98A00726F13 /* Siren.framework */; };
8EACA9711F380294003134CA /* LaunchScreen.xib in Resources */ = {isa = PBXBuildFile; fileRef = 8EACA9671F37F2D3003134CA /* LaunchScreen.xib */; };
8EACA9721F380294003134CA /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 8EACA9691F37F2D3003134CA /* Main.storyboard */; };
8EACA9731F380294003134CA /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 8EACA96B1F37F2D3003134CA /* Images.xcassets */; };
8EACA9741F38029B003134CA /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EACA9661F37F2D3003134CA /* AppDelegate.swift */; };
8EACA9751F38029B003134CA /* ViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EACA96D1F37F2D3003134CA /* ViewController.swift */; };
8EACA9771F38113E003134CA /* SirenError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EACA9761F38113D003134CA /* SirenError.swift */; };
8EE1FAF321B4DC0F009112A8 /* KnownError.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EE1FAF221B4DC0F009112A8 /* KnownError.swift */; };
8EE1FAF521B4E6B8009112A8 /* APIManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EE1FAF421B4E6B8009112A8 /* APIManager.swift */; };
8EEF4AB121AA6DDF00C83AAA /* DataParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8EEF4AB021AA6DDF00C83AAA /* DataParser.swift */; };
/* End PBXBuildFile section */
/* Begin PBXContainerItemProxy section */
55EC364C1E6BB98A00726F13 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 8EC391791A58B465001C121E /* Project object */;
proxyType = 1;
remoteGlobalIDString = 55EC36461E6BB98A00726F13;
remoteInfo = Siren;
};
8E3A6C091D07CB6F00A8B7CF /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 8EC391791A58B465001C121E /* Project object */;
@@ -47,46 +47,39 @@
};
/* End PBXContainerItemProxy section */
/* Begin PBXCopyFilesBuildPhase section */
558455D81C6690B4004BE492 /* Embed Frameworks */ = {
isa = PBXCopyFilesBuildPhase;
buildActionMask = 2147483647;
dstPath = "";
dstSubfolderSpec = 10;
files = (
55EC364F1E6BB98A00726F13 /* Siren.framework in Embed Frameworks */,
);
name = "Embed Frameworks";
runOnlyForDeploymentPostprocessing = 0;
};
/* End PBXCopyFilesBuildPhase section */
/* Begin PBXFileReference section */
4D729C4521A213B4002F73AB /* Rules.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Rules.swift; sourceTree = "<group>"; };
55EC36471E6BB98A00726F13 /* Siren.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Siren.framework; sourceTree = BUILT_PRODUCTS_DIR; };
55EC36491E6BB98A00726F13 /* Siren.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = Siren.h; sourceTree = "<group>"; };
55EC364A1E6BB98A00726F13 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
55EC364A1E6BB98A00726F13 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = ../../Siren/Info.plist; sourceTree = "<group>"; };
55EC365E1E6BB99B00726F13 /* Siren.bundle */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.plug-in"; name = Siren.bundle; path = ../../Sources/Siren.bundle; sourceTree = "<group>"; };
55EC365F1E6BB99B00726F13 /* Siren.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = Siren.swift; path = ../../Sources/Siren.swift; sourceTree = "<group>"; };
8E2499BE1FD83DDF00F384BA /* SirenAlertMessaging.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = SirenAlertMessaging.swift; path = ../../Sources/SirenAlertMessaging.swift; sourceTree = "<group>"; };
8E3A6C041D07CB6F00A8B7CF /* SirenExampleTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = SirenExampleTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
8E43D6221E8223EE00ECFFC8 /* SirenDateExtension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = SirenDateExtension.swift; path = ../../Sources/SirenDateExtension.swift; sourceTree = "<group>"; };
8E528A2F1E989A7A00B643C4 /* SirenDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = SirenDelegate.swift; path = ../../Sources/SirenDelegate.swift; sourceTree = "<group>"; };
8E528A311E989E0A00B643C4 /* SirenTestHelper.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = SirenTestHelper.swift; path = ../../Sources/SirenTestHelper.swift; sourceTree = "<group>"; };
8E5D15B01F3632D7001C0960 /* SirenLog.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = SirenLog.swift; path = ../../Sources/SirenLog.swift; sourceTree = "<group>"; };
8E9C238A1E7CDB42000ED3DA /* SirenBundleExtension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = SirenBundleExtension.swift; path = ../../Sources/SirenBundleExtension.swift; sourceTree = "<group>"; };
8E9C238C1E7CDD31000ED3DA /* SirenUIAlertControllerExtension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = SirenUIAlertControllerExtension.swift; path = ../../Sources/SirenUIAlertControllerExtension.swift; sourceTree = "<group>"; };
8E9C238E1E7CDDE7000ED3DA /* SirenViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; name = SirenViewController.swift; path = ../../Sources/SirenViewController.swift; sourceTree = "<group>"; };
8E01817821B379AF006DED05 /* Results.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Results.swift; sourceTree = "<group>"; };
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>"; };
8E171DD8215B26B4006FBBCC /* UIAlertControllerExtension.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UIAlertControllerExtension.swift; sourceTree = "<group>"; };
8E171DDA215B26B4006FBBCC /* SirenViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SirenViewController.swift; sourceTree = "<group>"; };
8E171DE5215B2701006FBBCC /* Localization.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Localization.swift; sourceTree = "<group>"; };
8E171DED215B2D09006FBBCC /* UserDefaultsExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UserDefaultsExtension.swift; sourceTree = "<group>"; };
8E3A6C041D07CB6F00A8B7CF /* Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = Tests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
8E5061EA21C9CDF000A28DE0 /* AlertConstants.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AlertConstants.swift; sourceTree = "<group>"; };
8EACA9661F37F2D3003134CA /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
8EACA9681F37F2D3003134CA /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/LaunchScreen.xib; sourceTree = "<group>"; };
8EACA96A1F37F2D3003134CA /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; };
8EACA96B1F37F2D3003134CA /* Images.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Images.xcassets; sourceTree = "<group>"; };
8EACA96C1F37F2D3003134CA /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
8EACA96D1F37F2D3003134CA /* ViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewController.swift; sourceTree = "<group>"; };
8EACA96F1F37F327003134CA /* SirenLookupModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = SirenLookupModel.swift; path = ../../Sources/SirenLookupModel.swift; sourceTree = "<group>"; };
8EACA9761F38113D003134CA /* SirenError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = SirenError.swift; path = ../../Sources/SirenError.swift; sourceTree = "<group>"; };
8EC391811A58B465001C121E /* SirenExample.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = SirenExample.app; sourceTree = BUILT_PRODUCTS_DIR; };
8EC391811A58B465001C121E /* Example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Example.app; sourceTree = BUILT_PRODUCTS_DIR; };
8EE1FAF221B4DC0F009112A8 /* KnownError.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = KnownError.swift; sourceTree = "<group>"; };
8EE1FAF421B4E6B8009112A8 /* APIManager.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = APIManager.swift; sourceTree = "<group>"; };
8EE6C74B1E6A0AE100DBE454 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
8EE6C74C1E6A0AE100DBE454 /* SirenTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SirenTests.swift; sourceTree = "<group>"; };
8EEF4AB021AA6DDF00C83AAA /* DataParser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DataParser.swift; sourceTree = "<group>"; };
/* End PBXFileReference section */
/* Begin PBXFrameworksBuildPhase section */
@@ -108,7 +101,7 @@
isa = PBXFrameworksBuildPhase;
buildActionMask = 2147483647;
files = (
55EC364E1E6BB98A00726F13 /* Siren.framework in Frameworks */,
8E641D2520C8B44B00908555 /* Siren.framework in Frameworks */,
);
runOnlyForDeploymentPostprocessing = 0;
};
@@ -118,31 +111,89 @@
55EC36481E6BB98A00726F13 /* Siren */ = {
isa = PBXGroup;
children = (
55EC365E1E6BB99B00726F13 /* Siren.bundle */,
55EC365F1E6BB99B00726F13 /* Siren.swift */,
8E2499BE1FD83DDF00F384BA /* SirenAlertMessaging.swift */,
8E9C238A1E7CDB42000ED3DA /* SirenBundleExtension.swift */,
8E43D6221E8223EE00ECFFC8 /* SirenDateExtension.swift */,
8E528A2F1E989A7A00B643C4 /* SirenDelegate.swift */,
8EACA9761F38113D003134CA /* SirenError.swift */,
8E5D15B01F3632D7001C0960 /* SirenLog.swift */,
8EACA96F1F37F327003134CA /* SirenLookupModel.swift */,
8E528A311E989E0A00B643C4 /* SirenTestHelper.swift */,
8E9C238C1E7CDD31000ED3DA /* SirenUIAlertControllerExtension.swift */,
8E9C238E1E7CDDE7000ED3DA /* SirenViewController.swift */,
55EC36491E6BB98A00726F13 /* Siren.h */,
55EC364A1E6BB98A00726F13 /* Info.plist */,
55EC365F1E6BB99B00726F13 /* Siren.swift */,
55EC365E1E6BB99B00726F13 /* Siren.bundle */,
8E171DD0215B26B4006FBBCC /* Extensions */,
8E01817A21B379DD006DED05 /* Managers */,
8E171DD5215B26B4006FBBCC /* Models */,
8E171DCC215B26B4006FBBCC /* Utilities */,
8E171DD9215B26B4006FBBCC /* View Controllers */,
);
path = Siren;
sourceTree = "<group>";
};
8EACA9651F37F2D3003134CA /* SirenExample */ = {
8E01817A21B379DD006DED05 /* Managers */ = {
isa = PBXGroup;
children = (
8EE1FAF421B4E6B8009112A8 /* APIManager.swift */,
8E01817B21B379DD006DED05 /* PresentationManager.swift */,
8E01817D21B379DD006DED05 /* RulesManager.swift */,
);
name = Managers;
path = ../../Sources/Managers;
sourceTree = "<group>";
};
8E171DCC215B26B4006FBBCC /* Utilities */ = {
isa = PBXGroup;
children = (
8EEF4AB021AA6DDF00C83AAA /* DataParser.swift */,
8EE1FAF221B4DC0F009112A8 /* KnownError.swift */,
);
name = Utilities;
path = ../../Sources/Utilities;
sourceTree = "<group>";
};
8E171DD0215B26B4006FBBCC /* Extensions */ = {
isa = PBXGroup;
children = (
8E171DD1215B26B4006FBBCC /* BundleExtension.swift */,
8E171DD2215B26B4006FBBCC /* DateExtension.swift */,
8E171DD8215B26B4006FBBCC /* UIAlertControllerExtension.swift */,
8E171DED215B2D09006FBBCC /* UserDefaultsExtension.swift */,
);
name = Extensions;
path = ../../Sources/Extensions;
sourceTree = "<group>";
};
8E171DD5215B26B4006FBBCC /* Models */ = {
isa = PBXGroup;
children = (
8E01818121B37B43006DED05 /* AlertAction.swift */,
8E5061EA21C9CDF000A28DE0 /* AlertConstants.swift */,
8E171DE5215B2701006FBBCC /* Localization.swift */,
8E171DD7215B26B4006FBBCC /* LookupModel.swift */,
8E065BA022054E5A00188D4E /* PerformCheck.swift */,
8E01817821B379AF006DED05 /* Results.swift */,
4D729C4521A213B4002F73AB /* Rules.swift */,
);
name = Models;
path = ../../Sources/Models;
sourceTree = "<group>";
};
8E171DD9215B26B4006FBBCC /* View Controllers */ = {
isa = PBXGroup;
children = (
8E171DDA215B26B4006FBBCC /* SirenViewController.swift */,
);
name = "View Controllers";
path = "../../Sources/View Controllers";
sourceTree = "<group>";
};
8E641D2420C8B44B00908555 /* Frameworks */ = {
isa = PBXGroup;
children = (
);
name = Frameworks;
sourceTree = "<group>";
};
8EACA9651F37F2D3003134CA /* Example */ = {
isa = PBXGroup;
children = (
8EACA9661F37F2D3003134CA /* AppDelegate.swift */,
8EACA96E1F37F2DD003134CA /* Supporting Files */,
);
path = SirenExample;
path = Example;
sourceTree = "<group>";
};
8EACA96E1F37F2DD003134CA /* Supporting Files */ = {
@@ -153,6 +204,7 @@
8EACA96B1F37F2D3003134CA /* Images.xcassets */,
8EACA96C1F37F2D3003134CA /* Info.plist */,
8EACA96D1F37F2D3003134CA /* ViewController.swift */,
55EC364A1E6BB98A00726F13 /* Info.plist */,
);
path = "Supporting Files";
sourceTree = "<group>";
@@ -161,29 +213,30 @@
isa = PBXGroup;
children = (
55EC36481E6BB98A00726F13 /* Siren */,
8EACA9651F37F2D3003134CA /* SirenExample */,
8EE6C74A1E6A0AE100DBE454 /* SirenExampleTests */,
8EACA9651F37F2D3003134CA /* Example */,
8EE6C74A1E6A0AE100DBE454 /* Tests */,
8EC391821A58B465001C121E /* Products */,
8E641D2420C8B44B00908555 /* Frameworks */,
);
sourceTree = "<group>";
};
8EC391821A58B465001C121E /* Products */ = {
isa = PBXGroup;
children = (
8EC391811A58B465001C121E /* SirenExample.app */,
8E3A6C041D07CB6F00A8B7CF /* SirenExampleTests.xctest */,
8EC391811A58B465001C121E /* Example.app */,
8E3A6C041D07CB6F00A8B7CF /* Tests.xctest */,
55EC36471E6BB98A00726F13 /* Siren.framework */,
);
name = Products;
sourceTree = "<group>";
};
8EE6C74A1E6A0AE100DBE454 /* SirenExampleTests */ = {
8EE6C74A1E6A0AE100DBE454 /* Tests */ = {
isa = PBXGroup;
children = (
8EE6C74B1E6A0AE100DBE454 /* Info.plist */,
8EE6C74C1E6A0AE100DBE454 /* SirenTests.swift */,
);
path = SirenExampleTests;
path = Tests;
sourceTree = "<group>";
};
/* End PBXGroup section */
@@ -218,9 +271,9 @@
productReference = 55EC36471E6BB98A00726F13 /* Siren.framework */;
productType = "com.apple.product-type.framework";
};
8E3A6C031D07CB6F00A8B7CF /* SirenExampleTests */ = {
8E3A6C031D07CB6F00A8B7CF /* Tests */ = {
isa = PBXNativeTarget;
buildConfigurationList = 8E3A6C0D1D07CB6F00A8B7CF /* Build configuration list for PBXNativeTarget "SirenExampleTests" */;
buildConfigurationList = 8E3A6C0D1D07CB6F00A8B7CF /* Build configuration list for PBXNativeTarget "Tests" */;
buildPhases = (
8E3A6C001D07CB6F00A8B7CF /* Sources */,
8E3A6C011D07CB6F00A8B7CF /* Frameworks */,
@@ -231,29 +284,27 @@
dependencies = (
8E3A6C0A1D07CB6F00A8B7CF /* PBXTargetDependency */,
);
name = SirenExampleTests;
name = Tests;
productName = SirenTests;
productReference = 8E3A6C041D07CB6F00A8B7CF /* SirenExampleTests.xctest */;
productReference = 8E3A6C041D07CB6F00A8B7CF /* Tests.xctest */;
productType = "com.apple.product-type.bundle.unit-test";
};
8EC391801A58B465001C121E /* SirenExample */ = {
8EC391801A58B465001C121E /* Example */ = {
isa = PBXNativeTarget;
buildConfigurationList = 8EC391A01A58B466001C121E /* Build configuration list for PBXNativeTarget "SirenExample" */;
buildConfigurationList = 8EC391A01A58B466001C121E /* Build configuration list for PBXNativeTarget "Example" */;
buildPhases = (
8EC3917D1A58B465001C121E /* Sources */,
8EC3917E1A58B465001C121E /* Frameworks */,
8EE3A3F81E6A0E470010BDCE /* SwiftLint */,
8EC3917F1A58B465001C121E /* Resources */,
558455D81C6690B4004BE492 /* Embed Frameworks */,
);
buildRules = (
);
dependencies = (
55EC364D1E6BB98A00726F13 /* PBXTargetDependency */,
);
name = SirenExample;
name = Example;
productName = Siren;
productReference = 8EC391811A58B465001C121E /* SirenExample.app */;
productReference = 8EC391811A58B465001C121E /* Example.app */;
productType = "com.apple.product-type.application";
};
/* End PBXNativeTarget section */
@@ -264,7 +315,7 @@
attributes = {
LastSwiftMigration = 0700;
LastSwiftUpdateCheck = 0730;
LastUpgradeCheck = 0900;
LastUpgradeCheck = 0930;
ORGANIZATIONNAME = "Sabintsev iOS Projects";
TargetAttributes = {
55EC36461E6BB98A00726F13 = {
@@ -282,10 +333,21 @@
DevelopmentTeam = HT94948NDD;
DevelopmentTeamName = "Arthur Sabintsev";
LastSwiftMigration = 0900;
SystemCapabilities = {
com.apple.BackgroundModes = {
enabled = 0;
};
com.apple.InAppPurchase = {
enabled = 0;
};
com.apple.Push = {
enabled = 0;
};
};
};
};
};
buildConfigurationList = 8EC3917C1A58B465001C121E /* Build configuration list for PBXProject "SirenExample" */;
buildConfigurationList = 8EC3917C1A58B465001C121E /* Build configuration list for PBXProject "Example" */;
compatibilityVersion = "Xcode 3.2";
developmentRegion = English;
hasScannedForEncodings = 0;
@@ -298,8 +360,8 @@
projectDirPath = "";
projectRoot = "";
targets = (
8EC391801A58B465001C121E /* SirenExample */,
8E3A6C031D07CB6F00A8B7CF /* SirenExampleTests */,
8EC391801A58B465001C121E /* Example */,
8E3A6C031D07CB6F00A8B7CF /* Tests */,
55EC36461E6BB98A00726F13 /* Siren */,
);
};
@@ -318,6 +380,7 @@
isa = PBXResourcesBuildPhase;
buildActionMask = 2147483647;
files = (
4D729C4421A20EDC002F73AB /* Siren.bundle in Resources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
@@ -355,17 +418,24 @@
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
8E528A321E989E0A00B643C4 /* SirenTestHelper.swift in Sources */,
8E9C238F1E7CDDE7000ED3DA /* SirenViewController.swift in Sources */,
8EACA9771F38113E003134CA /* SirenError.swift in Sources */,
8E01818021B379DD006DED05 /* RulesManager.swift in Sources */,
8E01818221B37B43006DED05 /* AlertAction.swift in Sources */,
8E171DEE215B2D09006FBBCC /* UserDefaultsExtension.swift in Sources */,
8E171DE2215B26B4006FBBCC /* LookupModel.swift in Sources */,
55EC36611E6BB99B00726F13 /* Siren.swift in Sources */,
8E43D6231E8223EE00ECFFC8 /* SirenDateExtension.swift in Sources */,
8E5D15B11F3632D7001C0960 /* SirenLog.swift in Sources */,
8E9C238B1E7CDB42000ED3DA /* SirenBundleExtension.swift in Sources */,
8E528A301E989A7A00B643C4 /* SirenDelegate.swift in Sources */,
8E2499BF1FD83DDF00F384BA /* SirenAlertMessaging.swift in Sources */,
8EACA9701F37F327003134CA /* SirenLookupModel.swift in Sources */,
8E9C238D1E7CDD31000ED3DA /* SirenUIAlertControllerExtension.swift in Sources */,
8E5061EB21C9CDF000A28DE0 /* AlertConstants.swift in Sources */,
8E01817921B379AF006DED05 /* Results.swift in Sources */,
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 */,
8E01817E21B379DD006DED05 /* PresentationManager.swift in Sources */,
8E171DE3215B26B4006FBBCC /* UIAlertControllerExtension.swift in Sources */,
8EE1FAF321B4DC0F009112A8 /* KnownError.swift in Sources */,
8E171DDF215B26B4006FBBCC /* DateExtension.swift in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
@@ -389,14 +459,9 @@
/* End PBXSourcesBuildPhase section */
/* Begin PBXTargetDependency section */
55EC364D1E6BB98A00726F13 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 55EC36461E6BB98A00726F13 /* Siren */;
targetProxy = 55EC364C1E6BB98A00726F13 /* PBXContainerItemProxy */;
};
8E3A6C0A1D07CB6F00A8B7CF /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 8EC391801A58B465001C121E /* SirenExample */;
target = 8EC391801A58B465001C121E /* Example */;
targetProxy = 8E3A6C091D07CB6F00A8B7CF /* PBXContainerItemProxy */;
};
/* End PBXTargetDependency section */
@@ -431,6 +496,7 @@
CURRENT_PROJECT_VERSION = 1;
DEBUG_INFORMATION_FORMAT = dwarf;
DEFINES_MODULE = YES;
DEVELOPMENT_TEAM = "";
DYLIB_COMPATIBILITY_VERSION = 1;
DYLIB_CURRENT_VERSION = 1;
DYLIB_INSTALL_NAME_BASE = "@rpath";
@@ -438,13 +504,13 @@
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.apple.itunesconnect.mobile.tests;
PRODUCT_BUNDLE_IDENTIFIER = com.apple.AppStoreConnect;
PRODUCT_NAME = "$(TARGET_NAME)";
SKIP_INSTALL = YES;
SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG;
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
SWIFT_SWIFT3_OBJC_INFERENCE = Default;
SWIFT_VERSION = 4.0;
SWIFT_VERSION = 4.2;
TARGETED_DEVICE_FAMILY = "1,2";
VERSIONING_SYSTEM = "apple-generic";
VERSION_INFO_PREFIX = "";
@@ -462,6 +528,7 @@
CURRENT_PROJECT_VERSION = 1;
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
DEFINES_MODULE = YES;
DEVELOPMENT_TEAM = "";
DYLIB_COMPATIBILITY_VERSION = 1;
DYLIB_CURRENT_VERSION = 1;
DYLIB_INSTALL_NAME_BASE = "@rpath";
@@ -469,12 +536,12 @@
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.apple.itunesconnect.mobile.tests;
PRODUCT_BUNDLE_IDENTIFIER = com.apple.AppStoreConnect;
PRODUCT_NAME = "$(TARGET_NAME)";
SKIP_INSTALL = YES;
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
SWIFT_SWIFT3_OBJC_INFERENCE = Default;
SWIFT_VERSION = 4.0;
SWIFT_VERSION = 4.2;
TARGETED_DEVICE_FAMILY = "1,2";
VERSIONING_SYSTEM = "apple-generic";
VERSION_INFO_PREFIX = "";
@@ -489,14 +556,14 @@
CLANG_ANALYZER_NONNULL = YES;
DEBUG_INFORMATION_FORMAT = dwarf;
GCC_NO_COMMON_BLOCKS = YES;
INFOPLIST_FILE = SirenExampleTests/Info.plist;
INFOPLIST_FILE = Tests/Info.plist;
IPHONEOS_DEPLOYMENT_TARGET = 9.3;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.sabintsev.SirenTests;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_SWIFT3_OBJC_INFERENCE = Default;
SWIFT_VERSION = 4.0;
TEST_HOST = "$(BUILT_PRODUCTS_DIR)/SirenExample.app/SirenExample";
SWIFT_VERSION = 4.2;
TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Example.app/Example";
};
name = Debug;
};
@@ -509,15 +576,15 @@
COPY_PHASE_STRIP = NO;
DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
GCC_NO_COMMON_BLOCKS = YES;
INFOPLIST_FILE = SirenExampleTests/Info.plist;
INFOPLIST_FILE = Tests/Info.plist;
IPHONEOS_DEPLOYMENT_TARGET = 9.3;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.sabintsev.SirenTests;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
SWIFT_SWIFT3_OBJC_INFERENCE = Default;
SWIFT_VERSION = 4.0;
TEST_HOST = "$(BUILT_PRODUCTS_DIR)/SirenExample.app/SirenExample";
SWIFT_VERSION = 4.2;
TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Example.app/Example";
};
name = Release;
};
@@ -533,12 +600,14 @@
CLANG_WARN_BOOL_CONVERSION = YES;
CLANG_WARN_COMMA = YES;
CLANG_WARN_CONSTANT_CONVERSION = YES;
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
CLANG_WARN_EMPTY_BODY = YES;
CLANG_WARN_ENUM_CONVERSION = YES;
CLANG_WARN_INFINITE_RECURSION = YES;
CLANG_WARN_INT_CONVERSION = YES;
CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
@@ -570,6 +639,7 @@
ONLY_ACTIVE_ARCH = YES;
SDKROOT = iphoneos;
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
SWIFT_VERSION = 4.2;
};
name = Debug;
};
@@ -585,12 +655,14 @@
CLANG_WARN_BOOL_CONVERSION = YES;
CLANG_WARN_COMMA = YES;
CLANG_WARN_CONSTANT_CONVERSION = YES;
CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
CLANG_WARN_EMPTY_BODY = YES;
CLANG_WARN_ENUM_CONVERSION = YES;
CLANG_WARN_INFINITE_RECURSION = YES;
CLANG_WARN_INT_CONVERSION = YES;
CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
@@ -613,6 +685,7 @@
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
MTL_ENABLE_DEBUG_INFO = NO;
SDKROOT = iphoneos;
SWIFT_VERSION = 4.2;
VALIDATE_PRODUCT = YES;
};
name = Release;
@@ -620,31 +693,31 @@
8EC391A11A58B466001C121E /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
INFOPLIST_FILE = "$(SRCROOT)/SirenExample/Supporting Files/Info.plist";
DEVELOPMENT_TEAM = HT94948NDD;
INFOPLIST_FILE = "$(SRCROOT)/Siren/Info.plist";
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.apple.itunesconnect.mobile;
PRODUCT_NAME = SirenExample;
PRODUCT_BUNDLE_IDENTIFIER = com.apple.AppStoreConnect;
PRODUCT_NAME = Example;
SWIFT_SWIFT3_OBJC_INFERENCE = Default;
SWIFT_VERSION = 4.0;
SWIFT_VERSION = 4.2;
};
name = Debug;
};
8EC391A21A58B466001C121E /* Release */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
INFOPLIST_FILE = "$(SRCROOT)/SirenExample/Supporting Files/Info.plist";
DEVELOPMENT_TEAM = HT94948NDD;
INFOPLIST_FILE = "$(SRCROOT)/Siren/Info.plist";
IPHONEOS_DEPLOYMENT_TARGET = 8.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = com.apple.itunesconnect.mobile;
PRODUCT_NAME = SirenExample;
PRODUCT_BUNDLE_IDENTIFIER = com.apple.AppStoreConnect;
PRODUCT_NAME = Example;
SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
SWIFT_SWIFT3_OBJC_INFERENCE = Default;
SWIFT_VERSION = 4.0;
SWIFT_VERSION = 4.2;
};
name = Release;
};
@@ -660,7 +733,7 @@
defaultConfigurationIsVisible = 0;
defaultConfigurationName = Release;
};
8E3A6C0D1D07CB6F00A8B7CF /* Build configuration list for PBXNativeTarget "SirenExampleTests" */ = {
8E3A6C0D1D07CB6F00A8B7CF /* Build configuration list for PBXNativeTarget "Tests" */ = {
isa = XCConfigurationList;
buildConfigurations = (
8E3A6C0B1D07CB6F00A8B7CF /* Debug */,
@@ -669,7 +742,7 @@
defaultConfigurationIsVisible = 0;
defaultConfigurationName = Release;
};
8EC3917C1A58B465001C121E /* Build configuration list for PBXProject "SirenExample" */ = {
8EC3917C1A58B465001C121E /* Build configuration list for PBXProject "Example" */ = {
isa = XCConfigurationList;
buildConfigurations = (
8EC3919E1A58B466001C121E /* Debug */,
@@ -678,7 +751,7 @@
defaultConfigurationIsVisible = 0;
defaultConfigurationName = Release;
};
8EC391A01A58B466001C121E /* Build configuration list for PBXNativeTarget "SirenExample" */ = {
8EC391A01A58B466001C121E /* Build configuration list for PBXNativeTarget "Example" */ = {
isa = XCConfigurationList;
buildConfigurations = (
8EC391A11A58B466001C121E /* Debug */,
@@ -2,6 +2,6 @@
<Workspace
version = "1.0">
<FileRef
location = "self:/Users/Arthur/Documents/oss/siren/Sample App/SirenExample.xcodeproj">
location = "self:/Users/Arthur/Documents/oss/siren/SirenExample/Example.xcodeproj">
</FileRef>
</Workspace>
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>IDEDidComputeMac32BitWarning</key>
<true/>
</dict>
</plist>
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "0900"
LastUpgradeVersion = "0940"
version = "1.3">
<BuildAction
parallelizeBuildables = "YES"
@@ -15,9 +15,9 @@
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "8EC391801A58B465001C121E"
BuildableName = "SirenExample.app"
BlueprintName = "SirenExample"
ReferencedContainer = "container:SirenExample.xcodeproj">
BuildableName = "Example.app"
BlueprintName = "Example"
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</BuildActionEntry>
</BuildActionEntries>
@@ -33,9 +33,9 @@
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "8E3A6C031D07CB6F00A8B7CF"
BuildableName = "SirenExampleTests.xctest"
BlueprintName = "SirenExampleTests"
ReferencedContainer = "container:SirenExample.xcodeproj">
BuildableName = "Tests.xctest"
BlueprintName = "Tests"
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</TestableReference>
</Testables>
@@ -43,9 +43,9 @@
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "8EC391801A58B465001C121E"
BuildableName = "SirenExample.app"
BlueprintName = "SirenExample"
ReferencedContainer = "container:SirenExample.xcodeproj">
BuildableName = "Example.app"
BlueprintName = "Example"
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
@@ -66,9 +66,9 @@
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "8EC391801A58B465001C121E"
BuildableName = "SirenExample.app"
BlueprintName = "SirenExample"
ReferencedContainer = "container:SirenExample.xcodeproj">
BuildableName = "Example.app"
BlueprintName = "Example"
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</BuildableProductRunnable>
<AdditionalOptions>
@@ -85,9 +85,9 @@
<BuildableReference
BuildableIdentifier = "primary"
BlueprintIdentifier = "8EC391801A58B465001C121E"
BuildableName = "SirenExample.app"
BlueprintName = "SirenExample"
ReferencedContainer = "container:SirenExample.xcodeproj">
BuildableName = "Example.app"
BlueprintName = "Example"
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</BuildableProductRunnable>
</ProfileAction>
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<Scheme
LastUpgradeVersion = "0900"
LastUpgradeVersion = "0930"
version = "1.3">
<BuildAction
parallelizeBuildables = "YES"
@@ -17,7 +17,7 @@
BlueprintIdentifier = "55EC36461E6BB98A00726F13"
BuildableName = "Siren.framework"
BlueprintName = "Siren"
ReferencedContainer = "container:SirenExample.xcodeproj">
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</BuildActionEntry>
</BuildActionEntries>
@@ -48,7 +48,7 @@
BlueprintIdentifier = "55EC36461E6BB98A00726F13"
BuildableName = "Siren.framework"
BlueprintName = "Siren"
ReferencedContainer = "container:SirenExample.xcodeproj">
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</MacroExpansion>
<AdditionalOptions>
@@ -66,7 +66,7 @@
BlueprintIdentifier = "55EC36461E6BB98A00726F13"
BuildableName = "Siren.framework"
BlueprintName = "Siren"
ReferencedContainer = "container:SirenExample.xcodeproj">
ReferencedContainer = "container:Example.xcodeproj">
</BuildableReference>
</MacroExpansion>
</ProfileAction>
+258
View File
@@ -0,0 +1,258 @@
//
// AppDelegate.swift
// Siren
//
// Created by Arthur Sabintsev on 1/3/15.
// Copyright (c) 2015 Sabintsev iOS Projects. All rights reserved.
//
import Siren
import UIKit
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
window?.makeKeyAndVisible()
/// - Warning:
/// Siren should ONLY be placed in UIApplication.didFinishLaunchingWithOptions and only after the `window?.makeKeyAndVisible()` call.
/// Siren initializes a listener on `didBecomeActiveNotification` to perform version checks.
// defaultExample()
defaultExampleUsingCompletionHandler()
// manualExampleWithCompletionHandler()
// minimalCustomizationPresentationExample()
// forceLocalizationCustomizationPresentationExample()
// customMessagingPresentationExample()
// annoyingRuleExample()
// hyperCriticalRulesExample()
// updateSpecificRulesExample()
// customAlertRulesExample()
// appStoreCountryChangeExample()
// complexExample()
return true
}
}
// Examples on how to use Siren
private extension AppDelegate {
/// The simplest implementation of Siren.
/// All default rules are implemented and the
/// results of the completion handler are ignored.
func defaultExample() {
Siren.shared.wail()
}
/// The simplest implementation of Siren.
/// All default rules are implemented and the
/// results of the completion handler are returned or an error is returned.
func defaultExampleUsingCompletionHandler() {
Siren.shared.wail { (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)
}
}
}
/// 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
siren.presentationManager = PresentationManager(alertTintColor: .purple,
appName: "Siren Example App Override!")
siren.wail { (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)
}
}
}
/// Forcing the language of the update alert to a specific localization (e.g., Russian is force in this function.
func forceLocalizationCustomizationPresentationExample() {
let siren = Siren.shared
siren.presentationManager = PresentationManager(forceLanguageLocalization: .russian)
siren.wail { (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)
}
}
}
/// Example on how to change specific strings in the update alert.
func customMessagingPresentationExample() {
let siren = Siren.shared
siren.presentationManager = PresentationManager(alertTitle: "Update Now, OK?",
nextTimeButtonTitle: "Next time, please!?")
siren.wail { (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)
}
}
}
/// How to present an alert every time the app is foregrounded.
func annoyingRuleExample() {
let siren = Siren.shared
siren.rulesManager = RulesManager(globalRules: .annoying)
siren.wail { (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)
}
}
}
/// How to present an alert every time the app is foregrounded.
/// This will block the user from using the app until they update the app.
/// Setting `showAlertAfterCurrentVersionHasBeenReleasedForDays` to `0` IS NOT RECOMMENDED
/// as it will cause the user to go into an endless loop to the App Store if the JSON results
/// update faster than the App Store CDN.
///
/// The `0` value is illustrated in this app as an example on how to change how quickly an alert is presented.
func hyperCriticalRulesExample() {
let siren = Siren.shared
siren.rulesManager = RulesManager(globalRules: .critical,
showAlertAfterCurrentVersionHasBeenReleasedForDays: 0)
siren.wail { (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)
}
}
}
/// Major, Minor, Patch, and Revision specific rules implementations.
func updateSpecificRulesExample() {
let siren = Siren.shared
siren.rulesManager = RulesManager(majorUpdateRules: .critical,
minorUpdateRules: .annoying,
patchUpdateRules: .default,
revisionUpdateRules: Rules(promptFrequency: .weekly, forAlertType: .option))
siren.wail { (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)
}
}
}
/// An example on how to present your own custom alert using Siren's localized Strings and version checking cadence.
func customAlertRulesExample() {
let siren = Siren.shared
// The key for using custom alerts is to set the `alertType` to `.none`.
// The `Results` type will return localized strings for your app's custom modal presentation.
// The `promptFrequency` allows you to customize how often Siren performs the version check before returning a non-error result back into your app, prompting your custom alert functionality.
let rules = Rules(promptFrequency: .immediately, forAlertType: .none)
siren.rulesManager = RulesManager(globalRules: rules)
siren.wail { (results, error) in
if let results = results {
print("USE THE VALUES FROM THE `RESULTS` DATA STRUCTURE TO BUILD YOUR UPDATE ALERT WITH LOCALIZED STRINGS.")
print("AlertAction ", results.alertAction)
print("Localization ", results.localization)
print("LookupModel ", results.lookupModel)
print("UpdateType ", results.updateType)
} else if let error = error {
print(error.localizedDescription)
}
}
}
/// An example on how to change the App Store region that your app in which your app is available.
// This should only be used if your app is not available in the US App Store.
// This example function illustrates how this can be done by checking against the Russian App Store.
func appStoreCountryChangeExample() {
let siren = Siren.shared
siren.apiManager = APIManager(countryCode: "RU")
siren.wail { (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)
}
}
}
/// An example on how to customize multiple managers at once.
func complexExample() {
let siren = Siren.shared
siren.presentationManager = PresentationManager(alertTintColor: .brown,
appName: "Siren's Complex Rule Example App",
alertTitle: "Please, Update Now!",
skipButtonTitle: "Click here to skip!",
forceLanguageLocalization: .spanish)
siren.rulesManager = RulesManager(majorUpdateRules: .critical,
minorUpdateRules: .annoying,
patchUpdateRules: .default,
revisionUpdateRules: .relaxed)
siren.wail { (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)
}
}
}
}
@@ -1,21 +1,26 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="10116" systemVersion="15E65" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" initialViewController="vXZ-lx-hvc">
<?xml version="1.0" encoding="UTF-8"?>
<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14113" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="vXZ-lx-hvc">
<device id="retina4_7" orientation="portrait">
<adaptation id="fullscreen"/>
</device>
<dependencies>
<plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="10085"/>
<deployment identifier="iOS"/>
<plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/>
<capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
</dependencies>
<scenes>
<!--View Controller-->
<scene sceneID="ufC-wZ-h7g">
<objects>
<viewController id="vXZ-lx-hvc" customClass="ViewController" customModule="Sample_App" customModuleProvider="target" sceneMemberID="viewController">
<viewController id="vXZ-lx-hvc" customClass="ViewController" customModule="Example" customModuleProvider="target" sceneMemberID="viewController">
<layoutGuides>
<viewControllerLayoutGuide type="top" id="jyV-Pf-zRb"/>
<viewControllerLayoutGuide type="bottom" id="2fi-mo-0CV"/>
</layoutGuides>
<view key="view" contentMode="scaleToFill" id="kh9-bI-dsS">
<rect key="frame" x="0.0" y="0.0" width="600" height="600"/>
<rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
<autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/>
<color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="calibratedWhite"/>
<color key="backgroundColor" red="1" green="1" blue="1" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
</view>
</viewController>
<placeholder placeholderIdentifier="IBFirstResponder" id="x5A-6p-PRh" sceneMemberID="firstResponder"/>
@@ -1,5 +1,15 @@
{
"images" : [
{
"idiom" : "iphone",
"size" : "20x20",
"scale" : "2x"
},
{
"idiom" : "iphone",
"size" : "20x20",
"scale" : "3x"
},
{
"idiom" : "iphone",
"size" : "29x29",
@@ -29,6 +39,11 @@
"idiom" : "iphone",
"size" : "60x60",
"scale" : "3x"
},
{
"idiom" : "ios-marketing",
"size" : "1024x1024",
"scale" : "1x"
}
],
"info" : {
@@ -0,0 +1,6 @@
{
"info" : {
"version" : 1,
"author" : "xcode"
}
}
@@ -15,7 +15,7 @@
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>1.0.0</string>
<string>0.0.9</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
@@ -15,10 +15,14 @@
<key>CFBundlePackageType</key>
<string>FMWK</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<string>0.0.9</string>
<key>CFBundleVersion</key>
<string>$(CURRENT_PROJECT_VERSION)</string>
<key>NSPrincipalClass</key>
<string></string>
<key>UILaunchStoryboardName</key>
<string>LaunchScreen</string>
<key>UIMainStoryboardFile</key>
<string>Main</string>
</dict>
</plist>
@@ -15,5 +15,3 @@ FOUNDATION_EXPORT double SirenVersionNumber;
FOUNDATION_EXPORT const unsigned char SirenVersionString[];
// In this header, you should import all the public headers of your framework using statements like #import <Siren/PublicHeader.h>
+795
View File
@@ -0,0 +1,795 @@
//
// SirenTests.swift
// SirenTests
//
// Created by Arthur Sabintsev on 6/7/16.
// Copyright © 2016 Sabintsev iOS Projects. All rights reserved.
//
import XCTest
@testable import Siren
final class SirenTests: XCTestCase {
var siren: Siren = Siren.shared
}
// MARK: - Updates
extension SirenTests {
func testSingleDigitVersionUpdate() {
siren.currentInstalledVersion = "1"
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0.0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.0.9"))
}
func testDoubleDigitVersionUpdate() {
siren.currentInstalledVersion = "1.0"
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0.0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.0.9"))
}
func testTripleDigitVersionUpdate() {
siren.currentInstalledVersion = "1.0.0"
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0.0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.0.9"))
}
func testQuadrupleDigitVersionUpdate() {
siren.currentInstalledVersion = "1.0.0"
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0"))
XCTAssertTrue(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "2.0.0.0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.9"))
XCTAssertFalse(DataParser.isAppStoreVersionNewer(installedVersion: siren.currentInstalledVersion,
appStoreVersion: "0.0.0.9"))
}
}
// MARK: - Localization
extension SirenTests {
func testArabicLocalization() {
let language: Localization.Language = .arabic
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "التحديث متوفر")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "المرة التالية")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "تخطى عن هذه النسخة")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "تحديث")
}
func testArmenianLocalization() {
let language: Localization.Language = .armenian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Թարմացումը հասանելի Է")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Հաջորդ անգամ")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Բաց թողնել այս տարբերակը")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Թարմացնել")
}
func testBasqueLocalization() {
let language: Localization.Language = .basque
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Eguneratzea erabilgarri")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Hurrengo batean")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Bertsio honetatik jauzi egin")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Eguneratu")
}
func testChineseSimplifiedLocalization() {
let language: Localization.Language = .chineseSimplified
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "更新可用")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "下一次")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "跳过此版本")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "更新")
}
func testChineseTraditionalLocalization() {
let language: Localization.Language = .chineseTraditional
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "有更新可用")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "下次")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "跳過此版本")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "更新")
}
func testCroatianLocalization() {
let language: Localization.Language = .croatian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Nova ažuriranje je stigla")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Sljedeći put")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Preskoči ovu verziju")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Ažuriraj")
}
func testCzechLocalization() {
let language: Localization.Language = .czech
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Aktualizace dostupná")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Příště")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Přeskočit tuto verzi")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Aktualizovat")
}
func testDanishLocalization() {
let language: Localization.Language = .danish
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Tilgængelig opdatering")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Næste gang")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Spring denne version over")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Opdater")
}
func testDutchLocalization() {
let language: Localization.Language = .dutch
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Update beschikbaar")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Volgende keer")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Sla deze versie over")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Updaten")
}
func testEstonianLocalization() {
let language: Localization.Language = .estonian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Uuendus saadaval")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Järgmisel korral")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Jäta see version vahele")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Uuenda")
}
func testFinnishLocalization() {
let language: Localization.Language = .finnish
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Päivitys saatavilla")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Ensi kerralla")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Jätä tämä versio väliin")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Päivitys")
}
func testFrenchLocalization() {
let language: Localization.Language = .french
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Mise à jour disponible")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "La prochaine fois")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Sauter cette version")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Mettre à jour")
}
func testGermanLocalization() {
let language: Localization.Language = .german
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Update erhältlich")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Später")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Diese Version überspringen")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Update")
}
func testGreekLocalization() {
let language: Localization.Language = .greek
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Διαθέσιμη Ενημέρωση")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Άλλη φορά")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Αγνόησε αυτήν την έκδοση")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Αναβάθμιση")
}
func testHebrewLocalization() {
let language: Localization.Language = .hebrew
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "עדכון זמין")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "בפעם הבאה")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "דלג על גרסה זו")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "עדכן")
}
func testHungarianLocalization() {
let language: Localization.Language = .hungarian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Új frissítés érhető el")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Később")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Ennél a verziónál ne figyelmeztessen")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Frissítés")
}
func testIndonesianLocalization() {
let language: Localization.Language = .indonesian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Pembaruan Tersedia")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Lain kali")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Lewati versi ini")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Perbarui")
}
func testItalianLocalization() {
let language: Localization.Language = .italian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Aggiornamento disponibile")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "La prossima volta")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Salta questa versione")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Aggiorna")
}
func testJapaneseLocalization() {
let language: Localization.Language = .japanese
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "アップデートのお知らせ")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "次回")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "このバージョンをスキップ")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "アップデート")
}
func testKoreanLocalization() {
let language: Localization.Language = .korean
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "업데이트 가능")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "다음에")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "이 버전 건너뜀")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "업데이트")
}
func testLatvianLocalization() {
let language: Localization.Language = .latvian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Atjauninājums pieejams")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Nākamreiz")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Izlaist šo versiju")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Atjaunināt")
}
func testLithuanianLocalization() {
let language: Localization.Language = .lithuanian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Atnaujinimas")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Kitą kartą")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Praleisti šią versiją")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Atnaujinti")
}
func testMalayLocalization() {
let language: Localization.Language = .malay
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Versi Terkini")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Lain kali")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Langkau versi ini")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Muat turun")
}
func testNorwegianLocalization() {
let language: Localization.Language = .norwegian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Oppdatering tilgjengelig")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Neste gang")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Hopp over denne versjonen")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Oppdater")
}
func testPersianLocalization() {
let language: Localization.Language = .persian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "بروزرسانی در دسترس")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "دفعه بعد")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "رد این نسخه")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "بروزرسانی")
}
func testPersianAfghanistanLocalization() {
let language: Localization.Language = .persianAfghanistan
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "بروزرسانی در دسترس")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "دگر بار")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "رد این نسخه")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "بروزرسانی")
}
func testPersianIranLocalization() {
let language: Localization.Language = .persianIran
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "بروزرسانی در دسترس")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "دفعه بعد")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "رد این نسخه")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "بروزرسانی")
}
func testPolishLocalization() {
let language: Localization.Language = .polish
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Aktualizacja dostępna")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Następnym razem")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Pomiń wersję")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Zaktualizuj")
}
func testPortugueseBrazilLocalization() {
let language: Localization.Language = .portugueseBrazil
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Atualização disponível")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Próxima vez")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Ignorar esta versão")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Atualizar")
}
func testPortuguesePortugalLocalization() {
let language: Localization.Language = .portuguesePortugal
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Nova actualização disponível")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Próxima vez")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Ignorar esta versão")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Actualizar")
}
func testRussianLocalization() {
let language: Localization.Language = .russian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Доступно обновление")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "В следующий раз")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Пропустить эту версию")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Обновить")
}
func testSerbianCyrillicLocalization() {
let language: Localization.Language = .serbianCyrillic
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Ажурирање доступно")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Следећи пут")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Прескочи ову верзију")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Ажурирај")
}
func testSerbianLatinLocalization() {
let language: Localization.Language = .serbianLatin
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Ažuriranje dostupno")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Sledeći put")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Preskoči ovu verziju")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Ažuriraj")
}
func testSlovenianLocalization() {
let language: Localization.Language = .slovenian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Posodobitev aplikacije")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Naslednjič")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Ne želim")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Namesti")
}
func testSpanishLocalization() {
let language: Localization.Language = .spanish
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Actualización disponible")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "La próxima vez")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Saltar esta versión")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Actualizar")
}
func testSwedishLocalization() {
let language: Localization.Language = .swedish
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Tillgänglig uppdatering")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Nästa gång")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Hoppa över den här versionen")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Uppdatera")
}
func testThaiLocalization() {
let language: Localization.Language = .thai
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "มีการอัพเดท")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "ไว้คราวหน้า")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "ข้ามเวอร์ชั่นนี้")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "อัพเดท")
}
func testTurkishLocalization() {
let language: Localization.Language = .turkish
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Güncelleme Mevcut")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Daha sonra")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Boşver")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Güncelle")
}
func testUkrainianLocalization() {
let language: Localization.Language = .ukrainian
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Доступне Оновлення")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Наступного разу")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Пропустити версію")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Оновити")
}
func testUrduLocalization() {
let language: Localization.Language = .urdu
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "نیا اپڈیٹ")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "اگلی مرتبہ")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "اس ورزن کو چھوڑ دیں")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "اپڈیٹ کریں")
}
func testVietnameseLocalization() {
let language: Localization.Language = .vietnamese
// Update Available
XCTAssertEqual(Bundle.localizedString(forKey: "Update Available", andForceLocalization: language), "Cập nhật mới")
// Next time
XCTAssertEqual(Bundle.localizedString(forKey: "Next time", andForceLocalization: language), "Lần tới")
// Skip this version
XCTAssertEqual(Bundle.localizedString(forKey: "Skip this version", andForceLocalization: language), "Bỏ qua phiên bản này")
// Update
XCTAssertEqual(Bundle.localizedString(forKey: "Update", andForceLocalization: language), "Cập nhật")
}
}
+2 -2
View File
@@ -1,5 +1,5 @@
# A sample Gemfile
source "https://rubygems.org"
gem "cocoapods"
gem "jazzy"
gem "jazzy", :git => "https://www.github.com/realm/jazzy.git"
gem "rubygems-bundler"
+49 -38
View File
@@ -1,20 +1,35 @@
GIT
remote: https://www.github.com/realm/jazzy.git
revision: 04b0cd720f6c25c1582939020757b96331e9472f
specs:
jazzy (0.9.5)
cocoapods (~> 1.5.3)
mustache (~> 1.1.0)
open4
redcarpet (~> 3.4.0)
rouge (>= 2.0.6, < 4.0)
sass (~> 3.6.0)
sqlite3 (~> 1.3.13)
xcinvoke (~> 0.3.0)
GEM
remote: https://rubygems.org/
specs:
CFPropertyList (2.3.6)
activesupport (4.2.10)
CFPropertyList (3.0.0)
activesupport (4.2.11)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
atomos (0.1.2)
atomos (0.1.3)
bundler-unload (1.0.2)
claide (1.0.2)
cocoapods (1.4.0)
cocoapods (1.5.3)
activesupport (>= 4.0.2, < 5)
claide (>= 1.0.2, < 2.0)
cocoapods-core (= 1.4.0)
cocoapods-core (= 1.5.3)
cocoapods-deintegrate (>= 1.0.2, < 2.0)
cocoapods-downloader (>= 1.1.3, < 2.0)
cocoapods-downloader (>= 1.2.0, < 2.0)
cocoapods-plugins (>= 1.0.0, < 2.0)
cocoapods-search (>= 1.0.0, < 2.0)
cocoapods-stats (>= 1.0.0, < 2.0)
@@ -24,57 +39,52 @@ GEM
escape (~> 0.0.4)
fourflusher (~> 2.0.1)
gh_inspector (~> 1.0)
molinillo (~> 0.6.4)
molinillo (~> 0.6.5)
nap (~> 1.0)
ruby-macho (~> 1.1)
xcodeproj (>= 1.5.4, < 2.0)
cocoapods-core (1.4.0)
xcodeproj (>= 1.5.7, < 2.0)
cocoapods-core (1.5.3)
activesupport (>= 4.0.2, < 6)
fuzzy_match (~> 2.0.4)
nap (~> 1.0)
cocoapods-deintegrate (1.0.2)
cocoapods-downloader (1.1.3)
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-trunk (1.3.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)
ffi (1.9.23)
executable-hooks (1.6.0)
ffi (1.10.0)
fourflusher (2.0.1)
fuzzy_match (2.0.4)
gh_inspector (1.1.3)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jazzy (0.9.1)
cocoapods (~> 1.0)
mustache (~> 0.99)
open4
redcarpet (~> 3.2)
rouge (>= 2.0.6, < 4.0)
sass (~> 3.4)
sqlite3 (~> 1.3)
xcinvoke (~> 0.3.0)
liferaft (0.0.6)
minitest (5.11.3)
molinillo (0.6.4)
mustache (0.99.8)
nanaimo (0.2.3)
molinillo (0.6.6)
mustache (1.1.0)
nanaimo (0.2.6)
nap (1.1.0)
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.1.1)
ruby-macho (1.1.0)
sass (3.5.5)
rouge (3.3.0)
ruby-macho (1.4.0)
rubygems-bundler (1.4.5)
bundler-unload (>= 1.0.2)
executable-hooks (>= 1.5.0)
sass (3.6.0)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
@@ -85,19 +95,20 @@ GEM
thread_safe (~> 0.1)
xcinvoke (0.3.0)
liferaft (~> 0.0.6)
xcodeproj (1.5.6)
CFPropertyList (~> 2.3.3)
atomos (~> 0.1.2)
xcodeproj (1.8.1)
CFPropertyList (>= 2.3.3, < 4.0)
atomos (~> 0.1.3)
claide (>= 1.0.2, < 2.0)
colored2 (~> 3.1)
nanaimo (~> 0.2.3)
nanaimo (~> 0.2.6)
PLATFORMS
ruby
DEPENDENCIES
cocoapods
jazzy
jazzy!
rubygems-bundler
BUNDLED WITH
1.16.1
1.17.3
+165 -285
View File
@@ -2,311 +2,73 @@
### Notify users when a new version of your app is available and prompt them to upgrade.
![Swift Support](https://img.shields.io/badge/Swift-2.3%2C%203.1%2C%203.2%2C%204.0-orange.svg)
[![Travis CI Status](https://travis-ci.org/ArtSabintsev/Siren.svg?branch=master)](https://travis-ci.org/ArtSabintsev/Siren) ![Documentation](https://github.com/ArtSabintsev/Siren/blob/master/docs/badge.svg) ![Swift Support](https://img.shields.io/badge/Swift-4.2%2C%204.1%2C%203.2%2C%203.1%202.3-orange.svg) [![CocoaPods](https://img.shields.io/cocoapods/v/Siren.svg)](https://cocoapods.org/pods/Siren) [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![SwiftPM Compatible](https://img.shields.io/badge/SwiftPM-compatible-brightgreen.svg)](https://swift.org/package-manager/)
[![BuddyBuild](https://dashboard.buddybuild.com/api/statusImage?appID=58c4d0d85601d40100c5c51d&branch=master&build=latest)](https://dashboard.buddybuild.com/apps/58c4d0d85601d40100c5c51d/build/latest?branch=master) [![CocoaPods](https://img.shields.io/cocoapods/v/Siren.svg)](https://cocoapods.org/pods/Siren) [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![SwiftPM Compatible](https://img.shields.io/badge/SwiftPM-Compatible-brightgreen.svg)](https://swift.org/package-manager/) [![CocoaPods](https://img.shields.io/cocoapods/dt/Siren.svg)](https://cocoapods.org/pods/Siren) [![CocoaPods](https://img.shields.io/cocoapods/dm/Siren.svg)](https://cocoapods.org/pods/Siren)
---
## Table of Contents
- [About](https://github.com/ArtSabintsev/Siren#about)
- [Features](https://github.com/ArtSabintsev/Siren#features)
- [Screenshots](https://github.com/ArtSabintsev/Siren#screenshots)
- [Installation Instructions](https://github.com/ArtSabintsev/Siren#installation-instructions)
- [Example Code](https://github.com/ArtSabintsev/Siren#example-code)
- [Granular/Differentiated Version Management](https://github.com/ArtSabintsev/Siren#granular-version-update-management)
- [Delegates (Optional)](https://github.com/ArtSabintsev/Siren#optional-delegate-and-delegate-methods)
- [Localization](https://github.com/ArtSabintsev/Siren#localization)
- [Device Compatibility](https://github.com/ArtSabintsev/Siren#device-compatibility)
- [Testing Siren](https://github.com/ArtSabintsev/Siren#testing-siren)
- [App Store Review & Submissions](https://github.com/ArtSabintsev/Siren#app-store-submissions)
- [Phrased Releases](https://github.com/ArtSabintsev/Siren#phased-releases)
- [Words of Caution](https://github.com/ArtSabintsev/Siren#words-of-caution)
- [Ports](https://github.com/ArtSabintsev/Siren#ports)
- [Attribution](https://github.com/ArtSabintsev/Siren#created-and-maintained-by)
# Table of Contents
- [**Meta**](https://github.com/ArtSabintsev/Siren#meta)
- [About](https://github.com/ArtSabintsev/Siren#about)
- [Features](https://github.com/ArtSabintsev/Siren#features)
- [Screenshots](https://github.com/ArtSabintsev/Siren#screenshots)
- [Ports](https://github.com/ArtSabintsev/Siren#ports)
- [**Installation and Integration**](https://github.com/ArtSabintsev/Siren#installation-and-integration)
- [Installation Instructions](https://github.com/ArtSabintsev/Siren#installation-instructions)
- [Implementation Examples](https://github.com/ArtSabintsev/Siren#implementation-examples)
- [**Device-Specific Checks**](https://github.com/ArtSabintsev/Siren#device-specific-checks)
- [Localization](https://github.com/ArtSabintsev/Siren#localization)
- [Device Compatibility](https://github.com/ArtSabintsev/Siren#device-compatibility)
- [**Testing**](https://github.com/ArtSabintsev/Siren#testing)
- [Testing Siren Locally](https://github.com/ArtSabintsev/Siren#testing-siren-locally)
- [Words of Caution](https://github.com/ArtSabintsev/Siren#words-of-caution)
- [**App Submission**](https://github.com/ArtSabintsev/Siren#app-submission)
- [App Store Review](https://github.com/ArtSabintsev/Siren#app-store-review)
- [Phased Releases](https://github.com/ArtSabintsev/Siren#phased-releases)
- [**Attribution**](https://github.com/ArtSabintsev/Siren#attribution)
- [Special Thanks](https://github.com/ArtSabintsev/Siren#special-thanks)
- [Creator](https://github.com/ArtSabintsev/Siren#creator)
---
# Meta
## About
**Siren** checks a user's currently installed version of your iOS app against the version that is currently available in the App Store.
If a new version is available, an alert can be presented to the user informing them of the newer version, and giving them the option to update the application. Alternatively, Siren can notify your app programmatically, enabling you to inform the user through alternative means, such as a custom interface.
If a new version is available, a language localized alert can be presented to the user informing them of the newer version, and giving them the option to update the application. Alternatively, Siren can notify your app through alternative means, such as a custom user interface.
- Siren is built to work with the [**Semantic Versioning**](http://semver.org/) system.
- Semantic Versioning is a three number versioning system (e.g., 1.0.0)
- Siren also supports two-number versioning (e.g., 1.0) and four-number versioning (e.g., 1.0.0.0)
- Siren is actively maintained by [**Arthur Sabintsev**](http://github.com/ArtSabintsev) and [**Aaron Brager**](http://twitter.com/getaaron)
### README Translations
- [**简体中文**](README.zh_CN.md) (by [**Daniel Hu**](http://www.jianshu.com/u/d8bbc4831623))
Siren is built to work with the [**Semantic Versioning**](https://semver.org/) system.
- Canonical Semantic Versioning uses a three number versioning system (e.g., 1.0.0)
- Siren also supports two-number versioning (e.g., 1.0) and four-number versioning (e.g., 1.0.0.0)
## Features
- [x] CocoaPods Support
- [x] Carthage Support
- [x] Swift Package Manager Support
- [x] Localized for 30+ languages (see [Localization](https://github.com/ArtSabintsev/Siren#localization))
- [x] Pre-Update Device Compatibility Check (see [Device Compatibility](https://github.com/ArtSabintsev/Siren#device-compatibility))
- [x] Three types of alerts (see [Screenshots](https://github.com/ArtSabintsev/Siren#screenshots))
- [x] Optional delegate methods (see [Delegates (Optional)](https://github.com/ArtSabintsev/Siren#optional-delegate-and-delegate-methods))
- [x] Unit Tests
- [x] Documentation can be found at http://sabintsev.com/Siren.
### Current Features
- [x] CocoaPods, Carthage, and Swift Package Manager Support (see [Installation Instructions](https://github.com/ArtSabintsev/Siren#installation-instructions))
- [x] Three Types of Alerts (see [Screenshots](https://github.com/ArtSabintsev/Siren#screenshots))
- [x] Highly Customizable Presentation Rules (see [Implementation Examples](https://github.com/ArtSabintsev/Siren#implementation-examples))
- [x] Localized for 40+ Languages (see [Localization](https://github.com/ArtSabintsev/Siren#localization))
- [x] Device Compatibility Check (see [Device Compatibility](https://github.com/ArtSabintsev/Siren#device-compatibility))
- [x] 100% Documentation Coverage (see https://sabintsev.com/Siren)
### 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.
- The **right picture** gives the user the option to skip the current update.
- These options are controlled by the `Siren.AlertType` enum.
- These options are controlled by the `Rules.AlertType` enum.
<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">
## Installation Instructions
| Swift Version | Branch Name | Will Continue to Receive Updates?
| ------------- | ------------- | -------------
| 4.0 | master | **Yes**
| 3.2 | swift3.2 | No
| 3.1 | swift3.1 | No
| 2.3 | swift2.3 | No
### CocoaPods
For Swift 4 support:
```ruby
pod 'Siren'
```
For Swift 3.2 support:
```ruby
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift3.2'
```
For Swift 3.1 support:
```ruby
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift3.1'
```
For Swift 2.3 support:
```ruby
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift2.3'
```
### Carthage
For Swift 4 support:
```swift
github "ArtSabintsev/Siren"
```
For Swift 3.2 support:
```swift
github "ArtSabintsev/Siren", "swift3.2"
```
For Swift 3.1 support:
```swift
github "ArtSabintsev/Siren", "swift3.1"
```
For Swift 2.3 support:
```ruby
github "ArtSabintsev/Siren", "swift2.3"
```
### Swift Package Manager
```swift
.Package(url: "https://github.com/ArtSabintsev/Siren.git", majorVersion: 3)
```
## Example Code
Below is some commented sample code. Adapt this to meet your app's needs.
For a full list of optional settings/preferences, please refer to https://github.com/ArtSabintsev/Siren/blob/master/SirenExample/SirenExample/AppDelegate.swift in the Sample Project.
```Swift
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
/* Siren code should go below window?.makeKeyAndVisible() */
// Siren is a singleton
let siren = Siren.shared
// Optional: Defaults to .option
siren.alertType = <#Siren.AlertType_Enum_Value#>
// Optional: Change the various UIAlertController and UIAlertAction messaging. One or more values can be changes. If only a subset of values are changed, the defaults with which Siren comes with will be used.
siren.alertMessaging = SirenAlertMessaging(updateTitle: "New Fancy Title",
updateMessage: "New message goes here!",
updateButtonMessage: "Update Now, Plz!?",
nextTimeButtonMessage: "OK, next time it is!",
skipVersionButtonMessage: "Please don't push skip, please don't!")
// Optional: Set this variable if you would only like to show an alert if your app has been available on the store for a few days.
// This default value is set to 1 to avoid this issue: https://github.com/ArtSabintsev/Siren#words-of-caution
// To show the update immediately after Apple has updated their JSON, set this value to 0. Not recommended due to aforementioned reason in https://github.com/ArtSabintsev/Siren#words-of-caution.
siren.showAlertAfterCurrentVersionHasBeenReleasedForDays = 3
// Replace .immediately with .daily or .weekly to specify a maximum daily or weekly frequency for version checks.
// DO NOT CALL THIS METHOD IN didFinishLaunchingWithOptions IF YOU ALSO PLAN TO CALL IT IN applicationDidBecomeActive.
siren.checkVersion(checkType: .immediately)
return true
}
func applicationDidBecomeActive(application: UIApplication) {
/*
Perform daily (.daily) or weekly (.weekly) checks for new version of your app.
Useful if user returns to your app from the background after extended period of time.
Place in applicationDidBecomeActive(_:). */
Siren.shared.checkVersion(checkType: .daily)
}
func applicationWillEnterForeground(application: UIApplication) {
/*
Useful if user returns to your app from the background after being sent to the
App Store, but doesn't update their app before coming back to your app.
ONLY USE WITH Siren.AlertType.immediately
*/
Siren.shared.checkVersion(checkType: .immediately)
}
```
And you're all set!
### Prompting for Updates without Alerts
Some developers may want to display a less obtrusive custom interface, like a banner or small icon. To accomplish this, you can disable alert presentation by doing the following:
```swift
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
...
siren.delegate = self
siren.alertType = .none
...
}
extension AppDelegate: SirenDelegate {
// Returns a localized message to this delegate method upon performing a successful version check
func sirenDidDetectNewVersionWithoutAlert(message: String, updateType: UpdateType) {
print("\(message)")
}
}
```
Siren will call the `sirenDidDetectNewVersionWithoutAlert(message: String)` delegate method, passing a localized, suggested update string suitable for display. Implement this method to display your own messaging, optionally using `message`.
## Granular Version Update Management
If you would like to set a different type of alert for revision, patch, minor, and/or major updates, simply add one or all of the following *optional* lines to your setup *before* calling the `checkVersion()` method:
```swift
/* Siren defaults to Siren.AlertType.option for all updates */
siren.shared.revisionUpdateAlertType = <#Siren.AlertType_Enum_Value#>
siren.shared.patchUpdateAlertType = <#Siren.AlertType_Enum_Value#>
siren.shared.minorUpdateAlertType = <#Siren.AlertType_Enum_Value#>
siren.shared.majorUpdateAlertType = <#Siren.AlertType_Enum_Value#>
```
## Optional Delegate and Delegate Methods
Six delegate methods allow you to handle or track the user's behavior. Each method has a default, empty implementation, effectively making each of these methods optional.
``` swift
public protocol SirenDelegate: class {
// User presented with update dialog
func sirenDidShowUpdateDialog(alertType: Siren.AlertType)
// User did click on button that launched App Store.app
func sirenUserDidLaunchAppStore()
// User did click on button that skips version update
func sirenUserDidSkipVersion()
// User did click on button that cancels update dialog
func sirenUserDidCancel()
// Siren failed to perform version check (may return system-level error)
func sirenDidFailVersionCheck(error: Error)
// Siren performed version check and did not display alert
func sirenDidDetectNewVersionWithoutAlert(message: String, updateType: UpdateType)
}
```
## Localization
Siren is localized for
- Arabic
- Armenian
- Basque
- Chinese (Simplified and Traditional)
- Croatian
- Czech
- Danish
- Dutch
- English
- Estonian
- Finnish
- French
- German
- Greek
- Hebrew
- Hungarian
- Indonesian
- Italian
- Japanese
- Korean
- Latvian
- Lithuanian
- Malay
- Norwegian (Bokmål)
- Persian (Afghanistan, Iran, Persian)
- Polish
- Portuguese (Brazil and Portugal)
- Russian
- Serbian (Cyrillic and Latin)
- Slovenian
- Spanish
- Swedish
- Thai
- Turkish
- Ukrainian
- Urdu
- Vietnamese
You may want the update dialog to *always* appear in a certain language, ignoring iOS's language setting (e.g. apps released in a specific country).
You can enable it like so:
```swift
Siren.shared.forceLanguageLocalization = Siren.LanguageType.<#Siren.LanguageType_Enum_Value#>
```
## 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 9 installed on their device, but the app update requires iOS 10, an alert will not be shown. This takes care of the *false positive* case regarding app updating.
## Testing Siren
Temporarily change the version string in Xcode (within the `.xcodeproj`) 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.
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 [iTunes Connect Mobile](https://itunes.apple.com/us/app/itunes-connect/id376771144?mt=8) app's bundleID: `com.apple.itunesconnect.mobile`.
For your convenience, you may turn on debugging statements by setting `self.debugEnabled = true` before calling the `checkVersion()` method.
## App Store Submissions
The App Store reviewer will **not** see the alert. The version in the App Store will always be older than the version being reviewed.
## Phased Releases
In 2017, Apple announced the [ability to rollout app updates gradually (a.k.a. Phased Releases)](https://itunespartner.apple.com/en/apps/faq/Managing%20Your%20Apps_Submission%20Process). Siren will continue to work as it has in the past, presenting an update modal to _all_ users. If you opt-in to a phased rollout for a specific version, you have a few choices:
- You can leave Siren configured as normal. Phased rollout will continue to auto-update apps. Since all users can still manually update your app directly, Siren will ignore the phase rollout and will prompt users to update.
- You can set `showAlertAfterCurrentVersionHasBeenReleasedForDays` to `7`, and Siren will not prompt any users until the latest version is 7 days old, after phased rollout is complete.
- You can remotely disable Siren until the rollout is done using your own API / backend logic.
## 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 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`.
## Ports
- **Objective-C (iOS)**
- [**Harpy**](http://github.com/ArtSabintsev/Harpy)
- [**Harpy**](https://github.com/ArtSabintsev/Harpy)
- Siren was ported _from_ Harpy, as Siren and Harpy are maintained by the same developer.
- As of December 2018, Harpy has been deprecated in favor of Siren.
- **Java (Android)**
- [**Egghead Games' Siren library**](https://github.com/eggheadgames/Siren)
- The Siren Swift library inspired the Java library.
@@ -314,5 +76,123 @@ Occasionally, the iTunes JSON will update faster than the App Store CDN, meaning
- [**Gant Laborde's Siren library**](https://github.com/GantMan/react-native-siren)
- The Siren Swift library inspired the React Native library.
## Created and maintained by
[Arthur Ariel Sabintsev](http://www.sabintsev.com/) & [Aaron Brager](http://twitter.com/getaaron)
---
# Installation and Integration
## Installation Instructions
| Swift Version | Branch Name | Will Continue to Receive Updates?
| ------------- | ------------- | -------------
| 4.2 | master | **Yes**
| 4.1 | swift4.1 | No
| 3.2 | swift3.2 | No
| 3.1 | swift3.1 | No
| 2.3 | swift2.3 | No
### CocoaPods
```ruby
pod 'Siren' # Swift 4.2
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift4.1' # Swift 4.1
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift3.2' # Swift 3.2
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift3.1' # Swift 3.1
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift2.3' # Swift 2.3
```
### Carthage
```swift
github "ArtSabintsev/Siren" // Swift 4.2
github "ArtSabintsev/Siren" "swift4.1" // Swift 4.1
github "ArtSabintsev/Siren" "swift3.2" // Swift 3.2
github "ArtSabintsev/Siren" "swift3.1" // Swift 3.1
github "ArtSabintsev/Siren" "swift2.3" // Swift 2.3
```
### Swift Package Manager
```swift
.Package(url: "https://github.com/ArtSabintsev/Siren.git", majorVersion: 4)
```
## Implementation Examples
Implementing Siren is as easy as adding two lines of code to your app:
```swift
import Siren // Line 1
import UIKit
@UIApplicationMain
final class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
window?.makeKeyAndVisible()
Siren.shared.wail() // Line 2
return true
}
}
```
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.
---
# Device-Specific Checks
## Localization
Siren is localized for the following languages:
Arabic, Armenian, Basque, Chinese (Simplified and Traditional), Croatian, Czech, Danish, Dutch, English, Estonian, Finnish, French, German, Greek, Hebrew, Hungarian, Indonesian, Italian, Japanese, Korean, Latvian, Lithuanian, Malay, Norwegian (Bokmål), Persian (Afghanistan, Iran, Persian), Polish, Portuguese (Brazil and Portugal), Russian, Serbian (Cyrillic and Latin), Slovenian, Spanish, Swedish, Thai, Turkish, Ukrainian, Urdu, Vietnamese
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.
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.
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
Temporarily change the version string in Xcode (within the `.xcodeproj` 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.
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 [App Store Connect](https://itunes.apple.com/app/id1234793120) app's bundleID: `com.apple.AppStoreConnect`.
## 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
The App Store reviewer will **not** see the alert. The version in the App Store will always be older than the version being reviewed.
## Phased Releases
In 2017, Apple announced the [ability to rollout app updates gradually (a.k.a. Phased Releases)](https://itunespartner.apple.com/en/apps/faq/Managing%20Your%20Apps_Submission%20Process). Siren will continue to work as it has in the past, presenting an update modal to _all_ users. If you opt-in to a phased rollout for a specific version, you have a few choices:
- You can leave Siren configured as normal. Phased rollout will continue to auto-update apps. Since all users can still manually update your app directly from the App Store, Siren will ignore the phased rollout and will prompt users to update.
- 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:
- [Aaron Brager](https://twitter.com/@getaaron) for motivating me and assisting me in building the initial proof-of-concept of Siren (based on [Harpy](https:github.com/ArtSabintsev/Harpy)) back in 2015. Without him, Siren may never have been built.
- All of [Harpy's Contributors](https://github.com/ArtSabintsev/Harpy/graphs/contributors) for helping building the feature set from 2012-2015 that was used as the basis for the first version of Siren.
- All of [Siren's Contributors](https://github.com/ArtSabintsev/Siren/graphs/contributors) for helping make Siren as powerful and bug-free as it currently is today.
## Creator
[Arthur Ariel Sabintsev](http://www.sabintsev.com/)
-232
View File
@@ -1,232 +0,0 @@
# Siren [English](README.md)
### 当您的 app 有新版本可用时提示用户进行更新。
[![Travis-CI](https://travis-ci.org/ArtSabintsev/Siren.svg?branch=master)](https://travis-ci.org/ArtSabintsev/Siren) [![CocoaPods](https://img.shields.io/cocoapods/v/Siren.svg)](https://cocoapods.org/pods/Siren) [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![SwiftPM Compatible](https://img.shields.io/badge/SwiftPM-Compatible-brightgreen.svg)](https://swift.org/package-manager/) [![CocoaPods](https://img.shields.io/cocoapods/dt/Siren.svg)](https://cocoapods.org/pods/Siren) [![CocoaPods](https://img.shields.io/cocoapods/dm/Siren.svg)](https://cocoapods.org/pods/Siren)
---
## 关于
**Siren** 用于检测用户当前安装版本是否是 App Store 上的最新可用版本。
当 app 有更新时,Siren 会弹出提示框,用户可根据提示框提供的选项进行更新。或者您也可以根据 Siren 发出的消息来自定义通知用户的方式,比如您可以提供一个自定义的提示框。
- Siren 可配合 [**Semantic Versioning**](http://semver.org/) 系统使用
- Semantic 版本系统由三位数字标识 (比如,1.0.0)
- Siren 同时支持两位数字标识 (比如,1.0)
- Siren 同时支持四位数字标识 (比如,1.0.0.0)
- Siren 当前处于活跃维护状态,由[**Arthur Sabintsev**](http://github.com/ArtSabintsev) 和 [**Aaron Brager**](http://twitter.com/getaaron) 进行维护。
## Ports
- [**Harpy**](http://github.com/ArtSabintsev/Harpy) 是 Objective-C 实现的版本更新检查库,Siren 是 Harpy 的 swift 版本。
- Siren 和 Harpy 是由相同的开发者维护。
- 安卓平台 Play Store 上的 [**Egghead Games' Siren library**](https://github.com/eggheadgames/Siren) 库使用了和 Siren 相同的原理实现了版本更新检测。
- 针对 React Native 项目 (iOS/Android) 的 [**Gant Laborde's Siren library**](https://github.com/GantMan/react-native-siren) 库使用了和 Siren 相同的原理实现了版本更新检测。
## 特点
- [x] 支持 Cocoapods
- [x] 支持 Carthage
- [x] 支持 Swift 包管理器
- [x] 30+ 语言本地化 (查看**本地化**)
- [x] 设备兼容性检测 (查看**设备兼容性**)
- [x] 三种类型的弹出提示框 (查看**截图**)
- [x] 可选代理方法 (查看**可选代理**)
- [x] 单元测试!
## 截图
- **左图** 强制用户更新
- **中间** 给用户提供更新选项
- **右图** 给用户提供更新和跳过更新选项
- 这些选项对应着 `SirenAlertType` 枚举类型
<img src="https://github.com/ArtSabintsev/Harpy/blob/master/samplePictures/picForcedUpdate.png?raw=true" height=480">
<img src="https://github.com/ArtSabintsev/Harpy/blob/master/samplePictures/picOptionalUpdate.png?raw=true" height=480">
<img src="https://github.com/ArtSabintsev/Harpy/blob/master/samplePictures/picSkippedUpdate.png?raw=true" height=480">
## 安装指南
### CocoaPods
Swift 3 版本:
```ruby
pod 'Siren'
```
Swift 2.3 版本:
```ruby
pod 'Siren', :git => 'https://github.com/ArtSabintsev/Siren.git', :branch => 'swift2.3'
```
Swift 2.2 版本:
```ruby
pod 'Siren', '0.9.5'
```
### Carthage
FSwift 3 版本:
``` swift
github "ArtSabintsev/Siren"
```
Swift 2.3 版本:
``` swift
github "ArtSabintsev/Siren" "swift2.3"
```
### Swift 包管理器
```swift
.Package(url: "https://github.com/ArtSabintsev/Siren.git", majorVersion: 1)
```
## 使用
下面是一些示例代码。请根据您的需求进行修改。更详细的使用说明请参考示例项目中的 https://github.com/ArtSabintsev/Siren/blob/master/Sample%20App/Sample%20App/AppDelegate.swift。
```Swift
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
/* Siren code should go below window?.makeKeyAndVisible() */
// Siren is a singleton
let siren = Siren.sharedInstance
// Optional: Defaults to .Option
siren.alertType = <#SirenAlertType_Enum_Value#>
/*
Replace .Immediately with .Daily or .Weekly to specify a maximum daily or weekly frequency for version
checks.
*/
siren.checkVersion(checkType: .immediately)
return true
}
func applicationDidBecomeActive(application: UIApplication) {
/*
Perform daily (.Daily) or weekly (.Weekly) checks for new version of your app.
Useful if user returns to your app from the background after extended period of time.
Place in applicationDidBecomeActive(_:). */
Siren.sharedInstance.checkVersion(checkType: .daily)
}
func applicationWillEnterForeground(application: UIApplication) {
/*
Useful if user returns to your app from the background after being sent to the
App Store, but doesn't update their app before coming back to your app.
ONLY USE WITH SirenAlertType.Force
*/
Siren.sharedInstance.checkVersion(checkType: .immediately)
}
```
### 使用非弹出提示框进行提示
您可以使用顶部条幅等更友好的方式进行提示。首先,您需要通过下面代码禁用弹出提示框:
```swift
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
...
siren.delegate = self
siren.alertType = .None
...
}
extension AppDelegate: SirenDelegate {
// 当检测到有更新可用时向该代理方法传递一个本地化的提示信息
func sirenDidDetectNewVersionWithoutAlert(message: String) {
print("\(message)")
}
}
```
Siren 会调用 `sirenDidDetectNewVersionWithoutAlert(message: String)` 代理方法,该方法传递了一个本地化的更新提示信息作为参数。您可以使用该参数作为提示信息,也可以使用自定义的提示信息。
## 为修订版,补丁,小版本,大版本设置不同的提示框类型
您可以为修订版,补丁,小版本,大版本等设置不同提示框类型,只需要在 `checkVersion()` 方法前调用进行如下设置即可:
```swift
/* Siren defaults to SirenAlertType.Option for all updates */
siren.sharedInstance().revisionUpdateAlertType = <#SirenAlertType_Enum_Value#>
siren.sharedInstance().patchUpdateAlertType = <#SirenAlertType_Enum_Value#>
siren.sharedInstance().minorUpdateAlertType = <#SirenAlertType_Enum_Value#>
siren.sharedInstance().majorUpdateAlertType = <#SirenAlertType_Enum_Value#>
```
##可选代理和代理方法
您可以通过下面六个代理方法跟踪用户进行的操作。
``` swift
public protocol SirenDelegate: class {
func sirenDidShowUpdateDialog(alertType: SirenAlertType) // 弹出更新提示框
func sirenUserDidLaunchAppStore() // 用户点击去 app store 更新
func sirenUserDidSkipVersion() // 用户点击跳过此次更新
func sirenUserDidCancel() // 用户点击取消更新
func sirenDidFailVersionCheck(error: NSError) // 检查更新失败(可能返回系统级别的错误)
func sirenDidDetectNewVersionWithoutAlert(message: String) // 检测到更新但不弹出提示框
}
```
## 本地化
Siren 为以下国家做了本地化
- Arabic
- Armenian
- Basque
- Chinese (Simplified and Traditional)
- Danish
- Dutch
- English
- Estonian
- Finnish
- French
- German
- Greek
- Hebrew
- Hungarian
- Indonesian
- Italian
- Japanese
- Korean
- Latvian
- Lithuanian
- Malay
- Norwegian (Bokmål)
- Polish
- Portuguese (Brazil and Portugal)
- Russian
- Serbian (Cyrillic and Latin)
- Slovenian
- Swedish
- Spanish
- Thai
- Turkish
- Vietnamese
您可以通过以下代码忽略 iOS 系统语言设置,为弹出框设置固定语言。
```swift
Siren.sharedInstance.forceLanguageLocalization = SirenLanguageType.<#SirenLanguageType_Enum_Value#>
```
## 设备兼容性
当有更新可用时,Siren 会检测用户的 iOS 版本号是否符合更新需求。比如,用户的系统是 iOS 9,但此次更新只针对 iOS 10,这时是不会出现弹出提示框。
## 测试
测试时,需要暂时将 Xcode 里(`.xcodeproj` 文件) 的版本号修改为比当前苹果商店中的可用版本号大。这样编译运行 app 时,您就可以看到弹出提示框。
如果您尚未发布过 App,把 bundleID 修改为一个 app store 已经存在的 bundleID。在示例项目中,我们使用了 [iTunes Connect Mobile](https://itunes.apple.com/us/app/itunes-connect/id376771144?mt=8) 的 bundleID`com.apple.itunesconnect.mobile`。
为方便调试,您可以在调用 `checkVersion()` 方法前通过 `self.debugEnabled = true` 来开启调试模式。
## 提交至 App Store
因为商店里的可用版本总是比提交审核的版本老,所以苹果商店审核人员在审核时是**不会**弹出提示框的。
##创建维护人员
[Arthur Ariel Sabintsev](http://www.sabintsev.com/) & [Aaron Brager](http://twitter.com/getaaron)
## 翻译人员
[Daniel Hu](http://www.jianshu.com/u/d8bbc4831623)
+12 -8
View File
@@ -1,18 +1,22 @@
Pod::Spec.new do |s|
# Version
s.version = "4.2.2"
s.swift_version = '4.2'
# Meta
s.name = "Siren"
s.version = "3.2.2"
s.summary = "Notify users that a new version of your iOS app is available, and prompt them with the App Store link."
s.description = <<-DESC
Notify users when a new version of your iOS app is available, and prompt them with the App Store link.
DESC
s.homepage = "https://github.com/ArtSabintsev/Siren"
s.license = "MIT"
s.authors = { "Arthur Ariel Sabintsev" => "arthur@sabintsev.com", "Aaron Brager" => "getaaron@gmail.com" }
s.authors = { "Arthur Ariel Sabintsev" => "arthur@sabintsev.com" }
s.description = <<-DESC
Notify your users when a new version of your iOS app is available, and prompt them with the App Store link.
DESC
# Compatibility & Sources
s.platform = :ios, "8.0"
s.source = { :git => "https://github.com/ArtSabintsev/Siren.git", :tag => s.version.to_s }
s.source_files = 'Sources/*.swift'
s.source_files = 'Sources/**/*.swift'
s.resources = 'Sources/Siren.bundle'
s.requires_arc = true
-109
View File
@@ -1,109 +0,0 @@
//
// AppDelegate.swift
// Siren
//
// Created by Arthur Sabintsev on 1/3/15.
// Copyright (c) 2015 Sabintsev iOS Projects. All rights reserved.
//
import UIKit
import Siren
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey : Any]? = nil) -> Bool {
window?.makeKeyAndVisible()
setupSiren()
return true
}
func setupSiren() {
let siren = Siren.shared
// Optional
siren.delegate = self
// Optional
siren.debugEnabled = true
// Optional - Change the name of your app. Useful if you have a long app name and want to display a shortened version in the update dialog (e.g., the UIAlertController).
// siren.appName = "Test App Name"
// Optional - Change the various UIAlertController and UIAlertAction messaging. One or more values can be changes. If only a subset of values are changed, the defaults with which Siren comes with will be used.
// siren.alertMessaging = SirenAlertMessaging(updateTitle: "New Fancy Title",
// updateMessage: "New message goes here!",
// updateButtonMessage: "Update Now, Plz!?",
// nextTimeButtonMessage: "OK, next time it is!",
// skipVersionButtonMessage: "Please don't push skip, please don't!")
// Optional - Defaults to .Option
// siren.alertType = .option // or .force, .skip, .none
// Optional - Can set differentiated Alerts for Major, Minor, Patch, and Revision Updates (Must be called AFTER siren.alertType, if you are using siren.alertType)
siren.majorUpdateAlertType = .option
siren.minorUpdateAlertType = .option
siren.patchUpdateAlertType = .option
siren.revisionUpdateAlertType = .option
// Optional - Sets all messages to appear in Russian. Siren supports many other languages, not just English and Russian.
// siren.forceLanguageLocalization = .russian
// Optional - Set this variable if your app is not available in the U.S. App Store. List of codes: https://developer.apple.com/library/content/documentation/LanguagesUtilities/Conceptual/iTunesConnect_Guide/Chapters/AppStoreTerritories.html
// siren.countryCode = ""
// Optional - Set this variable if you would only like to show an alert if your app has been available on the store for a few days.
// This default value is set to 1 to avoid this issue: https://github.com/ArtSabintsev/Siren#words-of-caution
// To show the update immediately after Apple has updated their JSON, set this value to 0. Not recommended due to aforementioned reason in https://github.com/ArtSabintsev/Siren#words-of-caution.
// siren.showAlertAfterCurrentVersionHasBeenReleasedForDays = 3
// Optional (Only do this if you don't call checkVersion in didBecomeActive)
// siren.checkVersion(checkType: .immediately)
}
func applicationWillEnterForeground(_ application: UIApplication) {
// Called as part of the transition from the background to the inactive state; here you can undo many of the changes made on entering the background.
Siren.shared.checkVersion(checkType: .immediately)
}
func applicationDidBecomeActive(_ application: UIApplication) {
// Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface.
Siren.shared.checkVersion(checkType: .daily)
}
}
extension AppDelegate: SirenDelegate
{
func sirenDidShowUpdateDialog(alertType: Siren.AlertType) {
print(#function, alertType)
}
func sirenUserDidCancel() {
print(#function)
}
func sirenUserDidSkipVersion() {
print(#function)
}
func sirenUserDidLaunchAppStore() {
print(#function)
}
func sirenDidFailVersionCheck(error: Error) {
print(#function, error)
}
func sirenLatestVersionInstalled() {
print(#function, "Latest version of app is installed")
}
// This delegate method is only hit when alertType is initialized to .none
func sirenDidDetectNewVersionWithoutAlert(message: String, updateType: UpdateType) {
print(#function, "\(message).\nRelease type: \(updateType.rawValue.capitalized)")
}
}
@@ -1,838 +0,0 @@
//
// SirenTests.swift
// SirenTests
//
// Created by Arthur Sabintsev on 6/7/16.
// Copyright © 2016 Sabintsev iOS Projects. All rights reserved.
//
import XCTest
@testable import Siren
class SirenTests: XCTestCase {
let siren = Siren.shared
}
// MARK: - Updates
extension SirenTests {
func testSingleDigitVersionUpdate() {
siren.testSetCurrentInstalledVersion(version: "1")
siren.testSetAppStoreVersion(version: "2")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
}
func testDoubleDigitVersionUpdate() {
siren.testSetCurrentInstalledVersion(version: "1.0")
siren.testSetAppStoreVersion(version: "2")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
}
func testTripleDigitVersionUpdate() {
siren.testSetCurrentInstalledVersion(version: "1.0.0")
siren.testSetAppStoreVersion(version: "2")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
}
func testQuadrupleDigitVersionUpdate() {
siren.testSetCurrentInstalledVersion(version: "1.0.0")
siren.testSetAppStoreVersion(version: "2")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "2.0.0.0")
XCTAssertTrue(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
siren.testSetAppStoreVersion(version: "0.0.0.9")
XCTAssertFalse(siren.testIsAppStoreVersionNewer())
}
}
// MARK: - Localization
extension SirenTests {
func testArabicLocalization() {
let language: Siren.LanguageType = .arabic
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "التحديث متوفر")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "المرة التالية")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "تخطى عن هذه النسخة")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "تحديث")
}
func testArmenianLocalization() {
let language: Siren.LanguageType = .armenian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Թարմացումը հասանելի Է")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Հաջորդ անգամ")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Բաց թողնել այս տարբերակը")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Թարմացնել")
}
func testBasqueLocalization() {
let language: Siren.LanguageType = .basque
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Eguneratzea erabilgarri")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Hurrengo batean")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Bertsio honetatik jauzi egin")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Eguneratu")
}
func testChineseSimplifiedLocalization() {
let language: Siren.LanguageType = .chineseSimplified
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "更新可用")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "下一次")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "跳过此版本")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "更新")
}
func testChineseTraditionalLocalization() {
let language: Siren.LanguageType = .chineseTraditional
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "有更新可用")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "下次")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "跳過此版本")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "更新")
}
func testCroatianLocalization() {
let language: Siren.LanguageType = .croatian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Nova ažuriranje je stigla")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Sljedeći put")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Preskoči ovu verziju")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Ažuriraj")
}
func testCzechLocalization() {
let language: Siren.LanguageType = .czech
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Aktualizace dostupná")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Příště")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Přeskočit tuto verzi")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Aktualizovat")
}
func testDanishLocalization() {
let language: Siren.LanguageType = .danish
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Tilgængelig opdatering")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Næste gang")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Spring denne version over")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Opdater")
}
func testDutchLocalization() {
let language: Siren.LanguageType = .dutch
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Update beschikbaar")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Volgende keer")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Sla deze versie over")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Updaten")
}
func testEstonianLocalization() {
let language: Siren.LanguageType = .estonian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Uuendus saadaval")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Järgmisel korral")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Jäta see version vahele")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Uuenda")
}
func testFinnishLocalization() {
let language: Siren.LanguageType = .finnish
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Päivitys saatavilla")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Ensi kerralla")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Jätä tämä versio väliin")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Päivitys")
}
func testFrenchLocalization() {
let language: Siren.LanguageType = .french
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Mise à jour disponible")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "La prochaine fois")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Sauter cette version")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Mettre à jour")
}
func testGermanLocalization() {
let language: Siren.LanguageType = .german
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Update erhältlich")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Später")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Diese Version überspringen")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Update")
}
func testGreekLocalization() {
let language: Siren.LanguageType = .greek
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Διαθέσιμη Ενημέρωση")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Άλλη φορά")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Αγνόησε αυτήν την έκδοση")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Αναβάθμιση")
}
func testHebrewLocalization() {
let language: Siren.LanguageType = .hebrew
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "עדכון זמין")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "בפעם הבאה")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "דלג על גרסה זו")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "עדכן")
}
func testHungarianLocalization() {
let language: Siren.LanguageType = .hungarian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Új frissítés érhető el")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Később")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Ennél a verziónál ne figyelmeztessen")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Frissítés")
}
func testIndonesianLocalization() {
let language: Siren.LanguageType = .indonesian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Pembaruan Tersedia")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Lain kali")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Lewati versi ini")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Perbarui")
}
func testItalianLocalization() {
let language: Siren.LanguageType = .italian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Aggiornamento disponibile")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "La prossima volta")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Salta questa versione")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Aggiorna")
}
func testJapaneseLocalization() {
let language: Siren.LanguageType = .japanese
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "アップデートのお知らせ")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "次回")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "このバージョンをスキップ")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "アップデート")
}
func testKoreanLocalization() {
let language: Siren.LanguageType = .korean
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "업데이트 가능")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "다음에")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "이 버전 건너뜀")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "업데이트")
}
func testLatvianLocalization() {
let language: Siren.LanguageType = .latvian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Atjauninājums pieejams")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Nākamreiz")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Izlaist šo versiju")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Atjaunināt")
}
func testLithuanianLocalization() {
let language: Siren.LanguageType = .lithuanian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Atnaujinimas")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Kitą kartą")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Praleisti šią versiją")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Atnaujinti")
}
func testMalayLocalization() {
let language: Siren.LanguageType = .malay
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Versi Terkini")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Lain kali")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Langkau versi ini")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Muat turun")
}
func testNorwegianLocalization() {
let language: Siren.LanguageType = .norwegian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Oppdatering tilgjengelig")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Neste gang")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Hopp over denne versjonen")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Oppdater")
}
func testPersianLocalization() {
let language: Siren.LanguageType = .persian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "بروزرسانی در دسترس")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "دفعه بعد")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "رد این نسخه")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "بروزرسانی")
}
func testPersianAfghanistanLocalization() {
let language: Siren.LanguageType = .persianAfghanistan
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "بروزرسانی در دسترس")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "دگر بار")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "رد این نسخه")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "بروزرسانی")
}
func testPersianIranLocalization() {
let language: Siren.LanguageType = .persianIran
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "بروزرسانی در دسترس")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "دفعه بعد")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "رد این نسخه")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "بروزرسانی")
}
func testPolishLocalization() {
let language: Siren.LanguageType = .polish
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Aktualizacja dostępna")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Następnym razem")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Pomiń wersję")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Zaktualizuj")
}
func testPortugueseBrazilLocalization() {
let language: Siren.LanguageType = .portugueseBrazil
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Atualização disponível")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Próxima vez")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Ignorar esta versão")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Atualizar")
}
func testPortuguesePortugalLocalization() {
let language: Siren.LanguageType = .portuguesePortugal
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Nova actualização disponível")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Próxima vez")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Ignorar esta versão")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Actualizar")
}
func testRussianLocalization() {
let language: Siren.LanguageType = .russian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Доступно обновление")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "В следующий раз")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Пропустить эту версию")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Обновить")
}
func testSerbianCyrillicLocalization() {
let language: Siren.LanguageType = .serbianCyrillic
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Ажурирање доступно")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Следећи пут")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Прескочи ову верзију")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Ажурирај")
}
func testSerbianLatinLocalization() {
let language: Siren.LanguageType = .serbianLatin
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Ažuriranje dostupno")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Sledeći put")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Preskoči ovu verziju")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Ažuriraj")
}
func testSlovenianLocalization() {
let language: Siren.LanguageType = .slovenian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Posodobitev aplikacije")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Naslednjič")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Ne želim")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Namesti")
}
func testSpanishLocalization() {
let language: Siren.LanguageType = .spanish
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Actualización disponible")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "La próxima vez")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Saltar esta versión")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Actualizar")
}
func testSwedishLocalization() {
let language: Siren.LanguageType = .swedish
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Tillgänglig uppdatering")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Nästa gång")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Hoppa över den här versionen")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Uppdatera")
}
func testThaiLocalization() {
let language: Siren.LanguageType = .thai
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "มีการอัพเดท")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "ไว้คราวหน้า")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "ข้ามเวอร์ชั่นนี้")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "อัพเดท")
}
func testTurkishLocalization() {
let language: Siren.LanguageType = .turkish
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Güncelleme Mevcut")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Daha sonra")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Boşver")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Güncelle")
}
func testUkrainianLocalization() {
let language: Siren.LanguageType = .ukrainian
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Доступне Оновлення")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Наступного разу")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Пропустити версію")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Оновити")
}
func testUrduLocalization() {
let language: Siren.LanguageType = .urdu
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "نیا اپڈیٹ")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "اگلی مرتبہ")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "اس ورزن کو چھوڑ دیں")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "اپڈیٹ کریں")
}
func testVietnameseLocalization() {
let language: Siren.LanguageType = .vietnamese
siren.forceLanguageLocalization = language
// Update Available
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update Available", forceLanguageLocalization: language), "Cập nhật mới")
// Next time
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Next time", forceLanguageLocalization: language), "Lần tới")
// Skip this version
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Skip this version", forceLanguageLocalization: language), "Bỏ qua phiên bản này")
// Update
XCTAssertEqual(Bundle().testLocalizedString(forKey: "Update", forceLanguageLocalization: language), "Cập nhật")
}
}
-744
View File
@@ -1,744 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Siren Class 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/Class/Siren" class="dashAnchor"></a>
<a title="Siren Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
Siren Class 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Siren</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Siren</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
<p>The Siren Class. A singleton that is initialized using the <code>shared</code> constant.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC0A11ErrorDomainSSv"></a>
<a name="//apple_ref/swift/Property/SirenErrorDomain" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC0A11ErrorDomainSSv">SirenErrorDomain</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The error domain for all errors created 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">public</span> <span class="k">let</span> <span class="nv">SirenErrorDomain</span> <span class="o">=</span> <span class="s">"Siren Error Domain"</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC8delegateAA0A8Delegate_pSgXwv"></a>
<a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC8delegateAA0A8Delegate_pSgXwv">delegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The SirenDelegate variable, which should be set if you&rsquo;d like to be notified:</p>
<p>When a user views or interacts with the alert</p>
<ul>
<li>sirenDidShowUpdateDialog(alertType: AlertType)</li>
<li>sirenUserDidLaunchAppStore()</li>
<li>sirenUserDidSkipVersion()</li>
<li>sirenUserDidCancel()</li>
</ul>
<p>When a new version has been detected, and you would like to present a localized message in a custom UI. use this delegate method:</p>
<ul>
<li>sirenDidDetectNewVersionWithoutAlert(message: String)</li>
</ul>
</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="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SirenDelegate.html">SirenDelegate</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC12debugEnabledSbv"></a>
<a name="//apple_ref/swift/Property/debugEnabled" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC12debugEnabledSbv">debugEnabled</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The debug flag, which is disabled by default.
When enabled, a stream of print() statements are logged to your console when a version check is performed.</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">lazy</span> <span class="k">var</span> <span class="nv">debugEnabled</span> <span class="o">=</span> <span class="kc">false</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC9alertTypeAB05AlertC0Ov"></a>
<a name="//apple_ref/swift/Property/alertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC9alertTypeAB05AlertC0Ov">alertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Determines the type of alert that should be shown.
See the Siren.AlertType enum for full 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">public</span> <span class="k">var</span> <span class="nv">alertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC20majorUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/majorUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC20majorUpdateAlertTypeAB0dE0Ov">majorUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">majorUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC20minorUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/minorUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC20minorUpdateAlertTypeAB0dE0Ov">minorUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">minorUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC20patchUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/patchUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC20patchUpdateAlertTypeAB0dE0Ov">patchUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">patchUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC23revisionUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/revisionUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC23revisionUpdateAlertTypeAB0dE0Ov">revisionUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">revisionUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC7appNameSSv"></a>
<a name="//apple_ref/swift/Property/appName" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC7appNameSSv">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 your app.
By default, it&rsquo;s set to the name of the app that&rsquo;s stored in your plist.</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">lazy</span> <span class="k">var</span> <span class="nv">appName</span> <span class="o">=</span> <span class="kt">Bundle</span><span class="o">.</span><span class="nf">bestMatchingAppName</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC14alertMessagingAA0a5AlertC0Vv"></a>
<a name="//apple_ref/swift/Property/alertMessaging" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC14alertMessagingAA0a5AlertC0Vv">alertMessaging</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Overrides all the Strings to which Siren defaults.
Defaults to the values defined in <code><a href="../Structs/SirenAlertMessaging/Constants.html">SirenAlertMessaging.Constants</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">public</span> <span class="k">var</span> <span class="nv">alertMessaging</span> <span class="o">=</span> <span class="kt"><a href="../Structs/SirenAlertMessaging.html">SirenAlertMessaging</a></span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC11countryCodeSSSgv"></a>
<a name="//apple_ref/swift/Property/countryCode" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC11countryCodeSSSgv">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 your app is available.
By default, all version checks are performed against the US App Store.
If your app is not available in the US App Store, set it to the identifier of at least one App Store within which it is available.</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="k">var</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>
<a name="/s:5SirenAAC25forceLanguageLocalizationAB0C4TypeOSgv"></a>
<a name="//apple_ref/swift/Property/forceLanguageLocalization" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC25forceLanguageLocalizationAB0C4TypeOSgv">forceLanguageLocalization</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&rsquo;s device when presenting the update message and button titles in the alert.
See the Siren.LanguageType 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">public</span> <span class="k">var</span> <span class="nv">forceLanguageLocalization</span><span class="p">:</span> <span class="kt">Siren</span><span class="o">.</span><span class="kt"><a href="../Classes/Siren/LanguageType.html">LanguageType</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC24alertControllerTintColorSo7UIColorCSgv"></a>
<a name="//apple_ref/swift/Property/alertControllerTintColor" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC24alertControllerTintColorSo7UIColorCSgv">alertControllerTintColor</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 tint color for UIAlertController.</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="k">var</span> <span class="nv">alertControllerTintColor</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:5SirenAAC50showAlertAfterCurrentVersionHasBeenReleasedForDaysSiv"></a>
<a name="//apple_ref/swift/Property/showAlertAfterCurrentVersionHasBeenReleasedForDays" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC50showAlertAfterCurrentVersionHasBeenReleasedForDaysSiv">showAlertAfterCurrentVersionHasBeenReleasedForDays</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>When this is set, the alert will only show up if the current version has already been released for X days
Defaults to 1 day 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="kd">public</span> <span class="k">var</span> <span class="nv">showAlertAfterCurrentVersionHasBeenReleasedForDays</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">1</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC22currentAppStoreVersionSSSgv"></a>
<a name="//apple_ref/swift/Property/currentAppStoreVersion" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC22currentAppStoreVersionSSSgv">currentAppStoreVersion</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 version of your app that is available for download on 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="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">currentAppStoreVersion</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>
<a name="/s:5SirenAAC6sharedABvZ"></a>
<a name="//apple_ref/swift/Variable/shared" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC6sharedABvZ">shared</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&rsquo;s Singleton</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">let</span> <span class="nv">shared</span> <span class="o">=</span> <span class="kt">Siren</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC12checkVersionyAB0C9CheckTypeO0bE0_tF"></a>
<a name="//apple_ref/swift/Method/checkVersion(checkType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC12checkVersionyAB0C9CheckTypeO0bE0_tF">checkVersion(checkType:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Checks the currently installed version of your app against the App Store.
The default check is against the US App Store, but if your app is not listed in the US,
you should set the <code><a href="../Classes/Siren.html#/s:5SirenAAC11countryCodeSSSgv">countryCode</a></code> property before calling this method. Please refer to the countryCode property for more information.</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">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>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>checkType</em>
</code>
</td>
<td>
<div>
<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>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC14launchAppStoreyyF"></a>
<a name="//apple_ref/swift/Method/launchAppStore()" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC14launchAppStoreyyF">launchAppStore()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Launches the AppStore in two situations:</p>
<ul>
<li>User clicked the <code>Update</code> button in the UIAlertController modal.</li>
<li>Developer built a custom alert modal and needs to be able to call this function when the user chooses to update the app in the aforementioned custom modal.</li>
</ul>
</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">func</span> <span class="nf">launchAppStore</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC9AlertTypeO"></a>
<a name="//apple_ref/swift/Enum/AlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC9AlertTypeO">AlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Determines the type of alert to present after a successful version check has been performed.</p>
<a href="../Classes/Siren/AlertType.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">enum</span> <span class="kt">AlertType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC16VersionCheckTypeO"></a>
<a name="//apple_ref/swift/Enum/VersionCheckType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC16VersionCheckTypeO">VersionCheckType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<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/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 swift"><code><span class="kd">enum</span> <span class="kt">VersionCheckType</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:5SirenAAC12LanguageTypeO"></a>
<a name="//apple_ref/swift/Enum/LanguageType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC12LanguageTypeO">LanguageType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Determines the available languages in which the update message and alert button titles should appear.</p>
<p>By default, the operating system&rsquo;s default lanuage setting is used. However, you can force a specific language
by setting the forceLanguageLocalization property before calling checkVersion()</p>
<a href="../Classes/Siren/LanguageType.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">enum</span> <span class="kt">LanguageType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
-142
View File
@@ -1,142 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Enumerations 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 title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Enumerations 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Enumerations</h1>
<p>The following enumerations are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren10UpdateTypeO"></a>
<a name="//apple_ref/swift/Enum/UpdateType" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10UpdateTypeO">UpdateType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>MARK - Siren UpdateType
<code>UpdateType</code> defines what kind of update is available
It is used as parameter if user wants to use
custom alert to inform the user about an update.</p>
<ul>
<li>major: Major release available: A.b.c.d</li>
<li>minor: Minor release available: a.B.c.d</li>
<li>patch: Patch release available: a.b.C.d</li>
<li>revision: Revision release available: a.b.c.D</li>
<li>unknown: No information available about the update</li>
</ul>
<a href="Enums/UpdateType.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">UpdateType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
-138
View File
@@ -1,138 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Protocols 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 title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Protocols 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Protocols</h1>
<p>The following protocols are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/SirenDelegate%20Protocol"></a>
<a name="//apple_ref/swift/Section/SirenDelegate Protocol" class="dashAnchor"></a>
<a href="#/SirenDelegate%20Protocol">
<h3 class="section-name">SirenDelegate Protocol</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP"></a>
<a name="//apple_ref/swift/Protocol/SirenDelegate" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP">SirenDelegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Delegate that handles all codepaths for Siren upon version check completion.</p>
<a href="Protocols/SirenDelegate.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">protocol</span> <span class="kt">SirenDelegate</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
@@ -1,138 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Classes 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 title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Classes 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Classes</h1>
<p>The following classes are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Siren"></a>
<a name="//apple_ref/swift/Section/Siren" class="dashAnchor"></a>
<a href="#/Siren">
<h3 class="section-name">Siren</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@Siren@objc(cs)Siren"></a>
<a name="//apple_ref/swift/Class/Siren" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Siren@objc(cs)Siren">Siren</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The Siren Class. A singleton that is initialized using the <code>shared</code> constant.</p>
<a href="Classes/Siren.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">final</span> <span class="kd">class</span> <span class="kt">Siren</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
@@ -1,744 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Siren Class 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/Class/Siren" class="dashAnchor"></a>
<a title="Siren Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
Siren Class 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Siren</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Siren</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
<p>The Siren Class. A singleton that is initialized using the <code>shared</code> constant.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC0A11ErrorDomainSSv"></a>
<a name="//apple_ref/swift/Property/SirenErrorDomain" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC0A11ErrorDomainSSv">SirenErrorDomain</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The error domain for all errors created 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">public</span> <span class="k">let</span> <span class="nv">SirenErrorDomain</span> <span class="o">=</span> <span class="s">"Siren Error Domain"</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC8delegateAA0A8Delegate_pSgXwv"></a>
<a name="//apple_ref/swift/Property/delegate" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC8delegateAA0A8Delegate_pSgXwv">delegate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The SirenDelegate variable, which should be set if you&rsquo;d like to be notified:</p>
<p>When a user views or interacts with the alert</p>
<ul>
<li>sirenDidShowUpdateDialog(alertType: AlertType)</li>
<li>sirenUserDidLaunchAppStore()</li>
<li>sirenUserDidSkipVersion()</li>
<li>sirenUserDidCancel()</li>
</ul>
<p>When a new version has been detected, and you would like to present a localized message in a custom UI. use this delegate method:</p>
<ul>
<li>sirenDidDetectNewVersionWithoutAlert(message: String)</li>
</ul>
</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="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SirenDelegate.html">SirenDelegate</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC12debugEnabledSbv"></a>
<a name="//apple_ref/swift/Property/debugEnabled" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC12debugEnabledSbv">debugEnabled</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The debug flag, which is disabled by default.
When enabled, a stream of print() statements are logged to your console when a version check is performed.</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">lazy</span> <span class="k">var</span> <span class="nv">debugEnabled</span> <span class="o">=</span> <span class="kc">false</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC9alertTypeAB05AlertC0Ov"></a>
<a name="//apple_ref/swift/Property/alertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC9alertTypeAB05AlertC0Ov">alertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Determines the type of alert that should be shown.
See the Siren.AlertType enum for full 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">public</span> <span class="k">var</span> <span class="nv">alertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC20majorUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/majorUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC20majorUpdateAlertTypeAB0dE0Ov">majorUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">majorUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC20minorUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/minorUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC20minorUpdateAlertTypeAB0dE0Ov">minorUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">minorUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC20patchUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/patchUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC20patchUpdateAlertTypeAB0dE0Ov">patchUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">patchUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC23revisionUpdateAlertTypeAB0dE0Ov"></a>
<a name="//apple_ref/swift/Property/revisionUpdateAlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC23revisionUpdateAlertTypeAB0dE0Ov">revisionUpdateAlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<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 Siren.AlertType.option.
See the Siren.AlertType enum for full 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">public</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">revisionUpdateAlertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren/AlertType.html">AlertType</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">option</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC7appNameSSv"></a>
<a name="//apple_ref/swift/Property/appName" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC7appNameSSv">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 your app.
By default, it&rsquo;s set to the name of the app that&rsquo;s stored in your plist.</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">lazy</span> <span class="k">var</span> <span class="nv">appName</span> <span class="o">=</span> <span class="kt">Bundle</span><span class="o">.</span><span class="nf">bestMatchingAppName</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC14alertMessagingAA0a5AlertC0Vv"></a>
<a name="//apple_ref/swift/Property/alertMessaging" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC14alertMessagingAA0a5AlertC0Vv">alertMessaging</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Overrides all the Strings to which Siren defaults.
Defaults to the values defined in <code><a href="../Structs/SirenAlertMessaging/Constants.html">SirenAlertMessaging.Constants</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">public</span> <span class="k">var</span> <span class="nv">alertMessaging</span> <span class="o">=</span> <span class="kt"><a href="../Structs/SirenAlertMessaging.html">SirenAlertMessaging</a></span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC11countryCodeSSSgv"></a>
<a name="//apple_ref/swift/Property/countryCode" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC11countryCodeSSSgv">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 your app is available.
By default, all version checks are performed against the US App Store.
If your app is not available in the US App Store, set it to the identifier of at least one App Store within which it is available.</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="k">var</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>
<a name="/s:5SirenAAC25forceLanguageLocalizationAB0C4TypeOSgv"></a>
<a name="//apple_ref/swift/Property/forceLanguageLocalization" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC25forceLanguageLocalizationAB0C4TypeOSgv">forceLanguageLocalization</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&rsquo;s device when presenting the update message and button titles in the alert.
See the Siren.LanguageType 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">public</span> <span class="k">var</span> <span class="nv">forceLanguageLocalization</span><span class="p">:</span> <span class="kt">Siren</span><span class="o">.</span><span class="kt"><a href="../Classes/Siren/LanguageType.html">LanguageType</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC24alertControllerTintColorSo7UIColorCSgv"></a>
<a name="//apple_ref/swift/Property/alertControllerTintColor" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC24alertControllerTintColorSo7UIColorCSgv">alertControllerTintColor</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 tint color for UIAlertController.</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="k">var</span> <span class="nv">alertControllerTintColor</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:5SirenAAC50showAlertAfterCurrentVersionHasBeenReleasedForDaysSiv"></a>
<a name="//apple_ref/swift/Property/showAlertAfterCurrentVersionHasBeenReleasedForDays" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC50showAlertAfterCurrentVersionHasBeenReleasedForDaysSiv">showAlertAfterCurrentVersionHasBeenReleasedForDays</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>When this is set, the alert will only show up if the current version has already been released for X days
Defaults to 1 day 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="kd">public</span> <span class="k">var</span> <span class="nv">showAlertAfterCurrentVersionHasBeenReleasedForDays</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">1</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC22currentAppStoreVersionSSSgv"></a>
<a name="//apple_ref/swift/Property/currentAppStoreVersion" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC22currentAppStoreVersionSSSgv">currentAppStoreVersion</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 version of your app that is available for download on 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="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">currentAppStoreVersion</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>
<a name="/s:5SirenAAC6sharedABvZ"></a>
<a name="//apple_ref/swift/Variable/shared" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC6sharedABvZ">shared</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&rsquo;s Singleton</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">let</span> <span class="nv">shared</span> <span class="o">=</span> <span class="kt">Siren</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC12checkVersionyAB0C9CheckTypeO0bE0_tF"></a>
<a name="//apple_ref/swift/Method/checkVersion(checkType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC12checkVersionyAB0C9CheckTypeO0bE0_tF">checkVersion(checkType:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Checks the currently installed version of your app against the App Store.
The default check is against the US App Store, but if your app is not listed in the US,
you should set the <code><a href="../Classes/Siren.html#/s:5SirenAAC11countryCodeSSSgv">countryCode</a></code> property before calling this method. Please refer to the countryCode property for more information.</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">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>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>checkType</em>
</code>
</td>
<td>
<div>
<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>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC14launchAppStoreyyF"></a>
<a name="//apple_ref/swift/Method/launchAppStore()" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC14launchAppStoreyyF">launchAppStore()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Launches the AppStore in two situations:</p>
<ul>
<li>User clicked the <code>Update</code> button in the UIAlertController modal.</li>
<li>Developer built a custom alert modal and needs to be able to call this function when the user chooses to update the app in the aforementioned custom modal.</li>
</ul>
</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">func</span> <span class="nf">launchAppStore</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC9AlertTypeO"></a>
<a name="//apple_ref/swift/Enum/AlertType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC9AlertTypeO">AlertType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Determines the type of alert to present after a successful version check has been performed.</p>
<a href="../Classes/Siren/AlertType.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">enum</span> <span class="kt">AlertType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5SirenAAC16VersionCheckTypeO"></a>
<a name="//apple_ref/swift/Enum/VersionCheckType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC16VersionCheckTypeO">VersionCheckType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<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/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 swift"><code><span class="kd">enum</span> <span class="kt">VersionCheckType</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:5SirenAAC12LanguageTypeO"></a>
<a name="//apple_ref/swift/Enum/LanguageType" class="dashAnchor"></a>
<a class="token" href="#/s:5SirenAAC12LanguageTypeO">LanguageType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Determines the available languages in which the update message and alert button titles should appear.</p>
<p>By default, the operating system&rsquo;s default lanuage setting is used. However, you can force a specific language
by setting the forceLanguageLocalization property before calling checkVersion()</p>
<a href="../Classes/Siren/LanguageType.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">enum</span> <span class="kt">LanguageType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
@@ -1,142 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Enumerations 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 title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Enumerations 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Enumerations</h1>
<p>The following enumerations are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren10UpdateTypeO"></a>
<a name="//apple_ref/swift/Enum/UpdateType" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10UpdateTypeO">UpdateType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>MARK - Siren UpdateType
<code>UpdateType</code> defines what kind of update is available
It is used as parameter if user wants to use
custom alert to inform the user about an update.</p>
<ul>
<li>major: Major release available: A.b.c.d</li>
<li>minor: Minor release available: a.B.c.d</li>
<li>patch: Patch release available: a.b.C.d</li>
<li>revision: Revision release available: a.b.c.D</li>
<li>unknown: No information available about the update</li>
</ul>
<a href="Enums/UpdateType.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">UpdateType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
@@ -1,348 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>SirenDelegate Protocol 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/Protocol/SirenDelegate" class="dashAnchor"></a>
<a title="SirenDelegate Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
SirenDelegate Protocol 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>SirenDelegate</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SirenDelegate</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
<p>Delegate that handles all codepaths for Siren upon version check completion.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP24sirenDidShowUpdateDialogyA2AC9AlertTypeO05alertI0_tF"></a>
<a name="//apple_ref/swift/Method/sirenDidShowUpdateDialog(alertType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP24sirenDidShowUpdateDialogyA2AC9AlertTypeO05alertI0_tF">sirenDidShowUpdateDialog(alertType:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User presented with update dialog.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenDidShowUpdateDialog</span><span class="p">(</span><span class="nv">alertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren.html">Siren</a></span><span class="o">.</span><span class="kt">AlertType</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP26sirenUserDidLaunchAppStoreyyF"></a>
<a name="//apple_ref/swift/Method/sirenUserDidLaunchAppStore()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP26sirenUserDidLaunchAppStoreyyF">sirenUserDidLaunchAppStore()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User did click on button that launched App Store.app.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenUserDidLaunchAppStore</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP23sirenUserDidSkipVersionyyF"></a>
<a name="//apple_ref/swift/Method/sirenUserDidSkipVersion()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP23sirenUserDidSkipVersionyyF">sirenUserDidSkipVersion()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User did click on button that skips version update.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenUserDidSkipVersion</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP18sirenUserDidCancelyyF"></a>
<a name="//apple_ref/swift/Method/sirenUserDidCancel()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP18sirenUserDidCancelyyF">sirenUserDidCancel()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User did click on button that cancels update dialog.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenUserDidCancel</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP24sirenDidFailVersionCheckys5Error_p5error_tF"></a>
<a name="//apple_ref/swift/Method/sirenDidFailVersionCheck(error:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP24sirenDidFailVersionCheckys5Error_p5error_tF">sirenDidFailVersionCheck(error:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren failed to perform version check (may return system-level error).</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenDidFailVersionCheck</span><span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP36sirenDidDetectNewVersionWithoutAlertySS7message_AA10UpdateTypeO06updateL0tF"></a>
<a name="//apple_ref/swift/Method/sirenDidDetectNewVersionWithoutAlert(message:updateType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP36sirenDidDetectNewVersionWithoutAlertySS7message_AA10UpdateTypeO06updateL0tF">sirenDidDetectNewVersionWithoutAlert(message:updateType:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren performed version check and did not display alert.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenDidDetectNewVersionWithoutAlert</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">updateType</span><span class="p">:</span> <span class="kt"><a href="../Enums/UpdateType.html">UpdateType</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP27sirenLatestVersionInstalledyyF"></a>
<a name="//apple_ref/swift/Method/sirenLatestVersionInstalled()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP27sirenLatestVersionInstalledyyF">sirenLatestVersionInstalled()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren performed version check and latest version is installed.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenLatestVersionInstalled</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
@@ -1,183 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Structures 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 title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Structures 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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Structures</h1>
<p>The following structures are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Siren%20Error%20Handling"></a>
<a name="//apple_ref/swift/Section/Siren Error Handling" class="dashAnchor"></a>
<a href="#/Siren%20Error%20Handling">
<h3 class="section-name">Siren Error Handling</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A5ErrorV"></a>
<a name="//apple_ref/swift/Struct/SirenError" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A5ErrorV">SirenError</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Structs/SirenError.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">struct</span> <span class="kt">SirenError</span><span class="p">:</span> <span class="kt">LocalizedError</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Siren%20Alert%20Messaging%20Customization"></a>
<a name="//apple_ref/swift/Section/Siren Alert Messaging Customization" class="dashAnchor"></a>
<a href="#/Siren%20Alert%20Messaging%20Customization">
<h3 class="section-name">Siren Alert Messaging Customization</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A14AlertMessagingV"></a>
<a name="//apple_ref/swift/Struct/SirenAlertMessaging" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A14AlertMessagingV">SirenAlertMessaging</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Allows the overriding of all the <code>UIAlertController</code> and <code>UIActionSheet</code> Strings to which Siren defaults.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Overriding any of these keys will result in the loss of the built-in internationalization that Siren provides.
</div>
<p>As SirenAlertMessaging is a Struct, one <em>or</em> more keys can be modified. Overriding only one string will result in the other keys retaining their default (and internationalizable) values.</p>
<a href="Structs/SirenAlertMessaging.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">struct</span> <span class="kt">SirenAlertMessaging</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
@@ -1,200 +0,0 @@
/* Credit to https://gist.github.com/wataru420/2048287 */
.highlight {
/* Comment */
/* Error */
/* Keyword */
/* Operator */
/* Comment.Multiline */
/* Comment.Preproc */
/* Comment.Single */
/* Comment.Special */
/* Generic.Deleted */
/* Generic.Deleted.Specific */
/* Generic.Emph */
/* Generic.Error */
/* Generic.Heading */
/* Generic.Inserted */
/* Generic.Inserted.Specific */
/* Generic.Output */
/* Generic.Prompt */
/* Generic.Strong */
/* Generic.Subheading */
/* Generic.Traceback */
/* Keyword.Constant */
/* Keyword.Declaration */
/* Keyword.Pseudo */
/* Keyword.Reserved */
/* Keyword.Type */
/* Literal.Number */
/* Literal.String */
/* Name.Attribute */
/* Name.Builtin */
/* Name.Class */
/* Name.Constant */
/* Name.Entity */
/* Name.Exception */
/* Name.Function */
/* Name.Namespace */
/* Name.Tag */
/* Name.Variable */
/* Operator.Word */
/* Text.Whitespace */
/* Literal.Number.Float */
/* Literal.Number.Hex */
/* Literal.Number.Integer */
/* Literal.Number.Oct */
/* Literal.String.Backtick */
/* Literal.String.Char */
/* Literal.String.Doc */
/* Literal.String.Double */
/* Literal.String.Escape */
/* Literal.String.Heredoc */
/* Literal.String.Interpol */
/* Literal.String.Other */
/* Literal.String.Regex */
/* Literal.String.Single */
/* Literal.String.Symbol */
/* Name.Builtin.Pseudo */
/* Name.Variable.Class */
/* Name.Variable.Global */
/* Name.Variable.Instance */
/* Literal.Number.Integer.Long */ }
.highlight .c {
color: #999988;
font-style: italic; }
.highlight .err {
color: #a61717;
background-color: #e3d2d2; }
.highlight .k {
color: #000000;
font-weight: bold; }
.highlight .o {
color: #000000;
font-weight: bold; }
.highlight .cm {
color: #999988;
font-style: italic; }
.highlight .cp {
color: #999999;
font-weight: bold; }
.highlight .c1 {
color: #999988;
font-style: italic; }
.highlight .cs {
color: #999999;
font-weight: bold;
font-style: italic; }
.highlight .gd {
color: #000000;
background-color: #ffdddd; }
.highlight .gd .x {
color: #000000;
background-color: #ffaaaa; }
.highlight .ge {
color: #000000;
font-style: italic; }
.highlight .gr {
color: #aa0000; }
.highlight .gh {
color: #999999; }
.highlight .gi {
color: #000000;
background-color: #ddffdd; }
.highlight .gi .x {
color: #000000;
background-color: #aaffaa; }
.highlight .go {
color: #888888; }
.highlight .gp {
color: #555555; }
.highlight .gs {
font-weight: bold; }
.highlight .gu {
color: #aaaaaa; }
.highlight .gt {
color: #aa0000; }
.highlight .kc {
color: #000000;
font-weight: bold; }
.highlight .kd {
color: #000000;
font-weight: bold; }
.highlight .kp {
color: #000000;
font-weight: bold; }
.highlight .kr {
color: #000000;
font-weight: bold; }
.highlight .kt {
color: #445588; }
.highlight .m {
color: #009999; }
.highlight .s {
color: #d14; }
.highlight .na {
color: #008080; }
.highlight .nb {
color: #0086B3; }
.highlight .nc {
color: #445588;
font-weight: bold; }
.highlight .no {
color: #008080; }
.highlight .ni {
color: #800080; }
.highlight .ne {
color: #990000;
font-weight: bold; }
.highlight .nf {
color: #990000; }
.highlight .nn {
color: #555555; }
.highlight .nt {
color: #000080; }
.highlight .nv {
color: #008080; }
.highlight .ow {
color: #000000;
font-weight: bold; }
.highlight .w {
color: #bbbbbb; }
.highlight .mf {
color: #009999; }
.highlight .mh {
color: #009999; }
.highlight .mi {
color: #009999; }
.highlight .mo {
color: #009999; }
.highlight .sb {
color: #d14; }
.highlight .sc {
color: #d14; }
.highlight .sd {
color: #d14; }
.highlight .s2 {
color: #d14; }
.highlight .se {
color: #d14; }
.highlight .sh {
color: #d14; }
.highlight .si {
color: #d14; }
.highlight .sx {
color: #d14; }
.highlight .sr {
color: #009926; }
.highlight .s1 {
color: #d14; }
.highlight .ss {
color: #990073; }
.highlight .bp {
color: #999999; }
.highlight .vc {
color: #008080; }
.highlight .vg {
color: #008080; }
.highlight .vi {
color: #008080; }
.highlight .il {
color: #009999; }
@@ -1,337 +0,0 @@
html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
background: transparent;
border: 0;
margin: 0;
outline: 0;
padding: 0;
vertical-align: baseline; }
body {
background-color: #f2f2f2;
font-family: Helvetica, freesans, Arial, sans-serif;
font-size: 14px;
-webkit-font-smoothing: subpixel-antialiased;
word-wrap: break-word; }
h1, h2, h3 {
margin-top: 0.8em;
margin-bottom: 0.3em;
font-weight: 100;
color: black; }
h1 {
font-size: 2.5em; }
h2 {
font-size: 2em;
border-bottom: 1px solid #e2e2e2; }
h4 {
font-size: 13px;
line-height: 1.5;
margin-top: 21px; }
h5 {
font-size: 1.1em; }
h6 {
font-size: 1.1em;
color: #777; }
.section-name {
color: gray;
display: block;
font-family: Helvetica;
font-size: 22px;
font-weight: 100;
margin-bottom: 15px; }
pre, code {
font: 0.95em Menlo, monospace;
color: #777;
word-wrap: normal; }
p code, li code {
background-color: #eee;
padding: 2px 4px;
border-radius: 4px; }
a {
color: #0088cc;
text-decoration: none; }
ul {
padding-left: 15px; }
li {
line-height: 1.8em; }
img {
max-width: 100%; }
blockquote {
margin-left: 0;
padding: 0 10px;
border-left: 4px solid #ccc; }
.content-wrapper {
margin: 0 auto;
width: 980px; }
header {
font-size: 0.85em;
line-height: 26px;
background-color: #414141;
position: fixed;
width: 100%;
z-index: 1; }
header img {
padding-right: 6px;
vertical-align: -4px;
height: 16px; }
header a {
color: #fff; }
header p {
float: left;
color: #999; }
header .header-right {
float: right;
margin-left: 16px; }
#breadcrumbs {
background-color: #f2f2f2;
height: 27px;
padding-top: 17px;
position: fixed;
width: 100%;
z-index: 1;
margin-top: 26px; }
#breadcrumbs #carat {
height: 10px;
margin: 0 5px; }
.sidebar {
background-color: #f9f9f9;
border: 1px solid #e2e2e2;
overflow-y: auto;
overflow-x: hidden;
position: fixed;
top: 70px;
bottom: 0;
width: 230px;
word-wrap: normal; }
.nav-groups {
list-style-type: none;
background: #fff;
padding-left: 0; }
.nav-group-name {
border-bottom: 1px solid #e2e2e2;
font-size: 1.1em;
font-weight: 100;
padding: 15px 0 15px 20px; }
.nav-group-name > a {
color: #333; }
.nav-group-tasks {
margin-top: 5px; }
.nav-group-task {
font-size: 0.9em;
list-style-type: none;
white-space: nowrap; }
.nav-group-task a {
color: #888; }
.main-content {
background-color: #fff;
border: 1px solid #e2e2e2;
margin-left: 246px;
position: absolute;
overflow: hidden;
padding-bottom: 60px;
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 {
margin-bottom: 1em; }
.main-content p {
line-height: 1.8em; }
.main-content section .section:first-child {
margin-top: 0;
padding-top: 0; }
.main-content section .task-group-section .task-group:first-of-type {
padding-top: 10px; }
.main-content section .task-group-section .task-group:first-of-type .section-name {
padding-top: 15px; }
.main-content section .heading:before {
content: "";
display: block;
padding-top: 70px;
margin: -70px 0 0; }
.section {
padding: 0 25px; }
.highlight {
background-color: #eee;
padding: 10px 12px;
border: 1px solid #e2e2e2;
border-radius: 4px;
overflow-x: auto; }
.declaration .highlight {
overflow-x: initial;
padding: 0 40px 40px 0;
margin-bottom: -25px;
background-color: transparent;
border: none; }
.section-name {
margin: 0;
margin-left: 18px; }
.task-group-section {
padding-left: 6px;
border-top: 1px solid #e2e2e2; }
.task-group {
padding-top: 0px; }
.task-name-container a[name]:before {
content: "";
display: block;
padding-top: 70px;
margin: -70px 0 0; }
.item {
padding-top: 8px;
width: 100%;
list-style-type: none; }
.item a[name]:before {
content: "";
display: block;
padding-top: 70px;
margin: -70px 0 0; }
.item code {
background-color: transparent;
padding: 0; }
.item .token {
padding-left: 3px;
margin-left: 15px;
font-size: 11.9px; }
.item .declaration-note {
font-size: .85em;
color: gray;
font-style: italic; }
.pointer-container {
border-bottom: 1px solid #e2e2e2;
left: -23px;
padding-bottom: 13px;
position: relative;
width: 110%; }
.pointer {
background: #f9f9f9;
border-left: 1px solid #e2e2e2;
border-top: 1px solid #e2e2e2;
height: 12px;
left: 21px;
top: -7px;
-webkit-transform: rotate(45deg);
-moz-transform: rotate(45deg);
-o-transform: rotate(45deg);
transform: rotate(45deg);
position: absolute;
width: 12px; }
.height-container {
display: none;
left: -25px;
padding: 0 25px;
position: relative;
width: 100%;
overflow: hidden; }
.height-container .section {
background: #f9f9f9;
border-bottom: 1px solid #e2e2e2;
left: -25px;
position: relative;
width: 100%;
padding-top: 10px;
padding-bottom: 5px; }
.aside, .language {
padding: 6px 12px;
margin: 12px 0;
border-left: 5px solid #dddddd;
overflow-y: hidden; }
.aside .aside-title, .language .aside-title {
font-size: 9px;
letter-spacing: 2px;
text-transform: uppercase;
padding-bottom: 0;
margin: 0;
color: #aaa;
-webkit-user-select: none; }
.aside p:last-child, .language p:last-child {
margin-bottom: 0; }
.language {
border-left: 5px solid #cde9f4; }
.language .aside-title {
color: #4b8afb; }
.aside-warning {
border-left: 5px solid #ff6666; }
.aside-warning .aside-title {
color: #ff0000; }
.graybox {
border-collapse: collapse;
width: 100%; }
.graybox p {
margin: 0;
word-break: break-word;
min-width: 50px; }
.graybox td {
border: 1px solid #e2e2e2;
padding: 5px 25px 5px 10px;
vertical-align: middle; }
.graybox tr td:first-of-type {
text-align: right;
padding: 7px;
vertical-align: top;
word-break: normal;
width: 40px; }
.slightly-smaller {
font-size: 0.9em; }
#footer {
position: absolute;
bottom: 10px;
margin-left: 25px; }
#footer p {
margin: 0;
color: #aaa;
font-size: 0.8em; }
html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
display: none; }
html.dash .main-content {
width: 980px;
margin-left: 0;
border: none;
width: 100%;
top: 0;
padding-bottom: 0; }
html.dash .height-container {
display: block; }
html.dash .item .token {
margin-left: 0; }
html.dash .content-wrapper {
width: auto; }
html.dash #footer {
position: static; }
@@ -1,97 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title> 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 title=" Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h3 id='authors' class='heading'>Authors</h3>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 274 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.5 KiB

-97
View File
@@ -1,97 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title> 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 title=" Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
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/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</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/SirenAlertMessaging.html">SirenAlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h3 id='authors' class='heading'>Authors</h3>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
-46
View File
@@ -1,46 +0,0 @@
window.jazzy = {'docset': false}
if (typeof window.dash != 'undefined') {
document.documentElement.className += ' dash'
window.jazzy.docset = true
}
if (navigator.userAgent.match(/xcode/i)) {
document.documentElement.className += ' xcode'
window.jazzy.docset = true
}
// On doc load, toggle the URL hash discussion if present
$(document).ready(function() {
if (!window.jazzy.docset) {
var linkToHash = $('a[href="' + window.location.hash +'"]');
linkToHash.trigger("click");
}
});
// On token click, toggle its discussion and animate token.marginLeft
$(".token").click(function(event) {
if (window.jazzy.docset) {
return;
}
var link = $(this);
var animationDuration = 300;
var tokenOffset = "15px";
var original = link.css('marginLeft') == tokenOffset;
link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
$content = link.parent().parent().next();
$content.slideToggle(animationDuration);
// Keeps the document from jumping to the hash.
var href = $(this).attr('href');
if (history.pushState) {
history.pushState({}, '', href);
} else {
location.hash = href;
}
event.preventDefault();
});
// Dumb down quotes within code blocks that delimit strings instead of quotations
// https://github.com/realm/jazzy/issues/714
$("code q").replaceWith(function () {
return ["\"", $(this).contents(), "\""];
});
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
-6
View File
@@ -1,6 +0,0 @@
{
"warnings": [
],
"source_directory": "/Users/Arthur/Documents/oss/siren/SirenExample"
}
+111
View File
@@ -0,0 +1,111 @@
//
// BundleExtension.swift
// Siren
//
// Created by Arthur Sabintsev on 3/17/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// `Bundle` Extension for Siren.
extension Bundle {
/// Constants used in the `Bundle` extension.
struct Constants {
/// Constant for the `.bundle` file extension.
static let bundleExtension = "bundle"
/// Constant for `CFBundleDisplayName`.
static let displayName = "CFBundleDisplayName"
/// Constant for the default US English localization.
static let englishLocalization = "en"
/// Constant for the project file extension.
static let projectExtension = "lproj"
/// Constant for `CFBundleShortVersionString`.
static let shortVersionString = "CFBundleShortVersionString"
/// Constant for the localization table.
static let table = "SirenLocalizable"
}
/// Fetches the current verison of the app.
///
/// - Returns: The current installed version of the app.
final class func version() -> String? {
return Bundle.main.object(forInfoDictionaryKey: Constants.shortVersionString) as? String
}
/// Returns the localized string for a given default string.
///
/// By default, the English language localization is used.
/// If the device's localization is set to another locale, that local's language is used if it's supported by Siren.
/// If `forcedLanguage` is set to `true`, the chosen language is shown for all devices, irrespective of their device's localization.
///
///
/// - Parameters:
/// - key: The default string used to search the localization table for a specific translation.
/// - forcedLanguage: Returns
/// - Returns: The localized string for a given key.
final class func localizedString(forKey key: String, andForceLocalization forcedLanguage: Localization.Language?) -> String {
guard var path = sirenBundlePath() else {
return key
}
if let deviceLangauge = deviceLanguage(),
let devicePath = sirenForcedBundlePath(forceLanguageLocalization: deviceLangauge) {
path = devicePath
}
if let forcedLanguage = forcedLanguage,
let forcedPath = sirenForcedBundlePath(forceLanguageLocalization: forcedLanguage) {
path = forcedPath
}
return Bundle(path: path)?.localizedString(forKey: key, value: key, table: Constants.table) ?? key
}
/// The appropriate name for the app to be displayed in the update alert.
///
/// Siren checks `CFBundleDisplayName` first. It then falls back to
/// to `kCFBundleNameKey` and ultimately to an empty string
/// if the aforementioned values are nil.
///
/// - Returns: The name of the app.
final class func bestMatchingAppName() -> String {
let bundleDisplayName = Bundle.main.object(forInfoDictionaryKey: Constants.displayName) as? String
let bundleName = Bundle.main.object(forInfoDictionaryKey: kCFBundleNameKey as String) as? String
return bundleDisplayName ?? bundleName ?? ""
}
}
private extension Bundle {
/// The path to Siren's localization `Bundle`.
///
/// - Returns: The bundle's path or `nil`.
final class func sirenBundlePath() -> String? {
return Bundle(for: Siren.self).path(forResource: "\(Siren.self)", ofType: Constants.bundleExtension)
}
/// The path for a particular language localizationin Siren's localization `Bundle`.
///
/// - Parameter forceLanguageLocalization: The language localization that should be searched for in Siren's localization `bundle`.
/// - Returns: The path to the forced language localization.
final class func sirenForcedBundlePath(forceLanguageLocalization: Localization.Language) -> String? {
guard let path = sirenBundlePath() else { return nil }
let name = forceLanguageLocalization.rawValue
return Bundle(path: path)?.path(forResource: name, ofType: Constants.projectExtension)
}
/// The user's preferred language based on their device's localization.
///
/// - Returns: The user's preferred language.
final class func deviceLanguage() -> Localization.Language? {
guard let preferredLocalization = Bundle.main.preferredLocalizations.first,
preferredLocalization != Constants.englishLocalization,
let preferredLanguage = Localization.Language(rawValue: preferredLocalization) else {
return nil
}
return preferredLanguage
}
}
@@ -1,6 +1,6 @@
//
// SirenDateExtension.swift
// SirenExample
// DateExtension.swift
// Siren
//
// Created by Arthur Sabintsev on 3/21/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
@@ -8,15 +8,22 @@
import Foundation
// MARK: - Date Extension for Siren
// `Date` Extension for Siren.
extension Date {
/// The amount of days passed from a specific source date.
///
/// - Parameter date: The source date.
/// - Returns: The amount of days passed since the source date.
static func days(since date: Date) -> Int {
let calendar = Calendar.current
let components = calendar.dateComponents([.day], from: date, to: Date())
return components.day ?? 0
}
/// The amount of days passed from a specific source date string.
///
/// - Parameter dateString: The source date string.
/// - Returns: The amount of days passed since the source date.
static func days(since dateString: String) -> Int? {
let dateformatter = DateFormatter()
dateformatter.locale = Locale(identifier: "en_US_POSIX")
@@ -0,0 +1,27 @@
//
// UIAlertControllerExtension.swift
// Siren
//
// Created by Arthur Sabintsev on 3/17/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import UIKit
// `UIAlertController` Extension for Siren.
extension UIAlertController {
/// Presents Siren's `UIAlertController` in a new `UIWindow`.
///
/// - Parameter window: The `UIWindow` that _should_ reference Siren's `UIAlertController`.
func show(window: UIWindow) {
window.makeKeyAndVisible()
window.rootViewController?.present(self, animated: true, completion: nil)
}
/// Hides Siren's `UIAlertController` within a given window.
///
/// - Parameter window: The `UIWindow` that references Siren's `UIAlertController`.
func hide(window: UIWindow) {
window.isHidden = true
}
}
@@ -0,0 +1,43 @@
//
// UserDefaultsExtension.swift
// Siren
//
// Created by Arthur Sabintsev on 9/25/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// `UserDefaults` Extension for Siren.
extension UserDefaults {
/// Siren-specific `UserDefaults` Keys
private enum SirenKeys: String {
/// Key that notifies Siren to perform a version check and present
/// the Siren alert the next time the user launches the app.
case PerformVersionCheckOnSubsequentLaunch
/// Key that stores the timestamp of the last version check.
case StoredVersionCheckDate
/// Key that stores the version that a user decided to skip.
case StoredSkippedVersion
}
/// Sets and Gets a `UserDefault` around storing a version that the user wants to skip updating.
static var storedSkippedVersion: String? {
get {
return standard.string(forKey: SirenKeys.StoredSkippedVersion.rawValue)
} set {
standard.set(newValue, forKey: SirenKeys.StoredSkippedVersion.rawValue)
}
}
/// Sets and Gets a `UserDefault` around the last time the user was presented a version update alert.
static var alertPresentationDate: Date? {
get {
return standard.object(forKey: SirenKeys.StoredVersionCheckDate.rawValue) as? Date
} set {
standard.set(newValue, forKey: SirenKeys.StoredVersionCheckDate.rawValue)
}
}
}
+131
View File
@@ -0,0 +1,131 @@
//
// APIManager.swift
// Siren
//
// Created by Arthur Sabintsev on 11/24/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// APIManager for Siren
public struct APIManager {
/// Constants used in the `APIManager`.
private struct Constants {
/// Constant for the `bundleId` parameter in the iTunes Lookup API request.
static let bundleID = "bundleId"
/// Constant for the `country` parameter in the iTunes Lookup API request.
static let country = "country"
}
/// Return results or errors obtained from performing a version check with Siren.
typealias CompletionHandler = (LookupModel?, KnownError?) -> Void
/// 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.
///
/// [List of country codes](https://help.apple.com/app-store-connect/#/dev997f9cf7c)
///
let countryCode: String?
/// Initializes `APIManager` to 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.
///
/// [List of country codes](https://help.apple.com/app-store-connect/#/dev997f9cf7c)
///
/// - Parameter countryCode: The country code for the App Store in which the app is availabe. Defaults to nil (e.g., the US App Store)
public init(countryCode: String? = nil) {
self.countryCode = countryCode
}
/// The default `APIManager`.
///
/// The version check is performed against the US App Store.
public static let `default` = APIManager()
}
extension APIManager {
/// Creates and performs a URLRequest against the iTunes Lookup API.
///
/// - Parameter handler: The completion handler for the iTunes Lookup API request.
func performVersionCheckRequest(completion handler: CompletionHandler?) {
guard Bundle.main.bundleIdentifier != nil else {
handler?(nil, .missingBundleID)
return
}
do {
let url = try makeITunesURL()
let request = URLRequest(url: url, cachePolicy: .reloadIgnoringLocalAndRemoteCacheData, timeoutInterval: 30)
URLSession.shared.dataTask(with: request) { (data, response, error) in
URLCache.shared.removeCachedResponse(for: request)
self.processVersionCheckResults(withData: data, response: response, error: error, completion: handler)
}.resume()
} catch {
handler?(nil, .malformedURL)
}
}
/// Parses and maps the the results from the iTunes Lookup API request.
///
/// - Parameters:
/// - data: The JSON data returned from the request.
/// - response: The response metadata returned from the request.
/// - error: The error returned from the request.
/// - handler: The completion handler to call once the results of the request has been processed.
private func processVersionCheckResults(withData data: Data?,
response: URLResponse?,
error: Error?,
completion handler: CompletionHandler?) {
if let error = error {
handler?(nil, .appStoreDataRetrievalFailure(underlyingError: error))
} else {
guard let data = data else {
handler?(nil, .appStoreDataRetrievalFailure(underlyingError: nil))
return
}
do {
let lookupModel = try JSONDecoder().decode(LookupModel.self, from: data)
guard !lookupModel.results.isEmpty else {
handler?(nil, .appStoreDataRetrievalEmptyResults)
return
}
DispatchQueue.main.async {
handler?(lookupModel, nil)
}
} catch {
handler?(nil, .appStoreJSONParsingFailure(underlyingError: error))
}
}
}
/// Creates the URL that points to the iTunes Lookup API.
///
/// - Returns: The iTunes Lookup API URL.
/// - Throws: An error if the URL cannot be created.
private func makeITunesURL() throws -> URL {
var components = URLComponents()
components.scheme = "https"
components.host = "itunes.apple.com"
components.path = "/lookup"
var items: [URLQueryItem] = [URLQueryItem(name: Constants.bundleID, value: Bundle.main.bundleIdentifier)]
if let countryCode = countryCode {
let item = URLQueryItem(name: Constants.country, value: countryCode)
items.append(item)
}
components.queryItems = items
guard let url = components.url, !url.absoluteString.isEmpty else {
throw KnownError.malformedURL
}
return url
}
}
+225
View File
@@ -0,0 +1,225 @@
//
// PresentationManager.swift
// Siren
//
// Created by Arthur Sabintsev on 12/6/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import UIKit
/// PresentationManager for Siren
public struct PresentationManager {
/// Return results or errors obtained from performing a version check with Siren.
typealias CompletionHandler = (AlertAction) -> Void
/// The localization data structure that will be used to construct localized strings for the update alert.
let localization: Localization
/// The tint color of the `UIAlertController` buttons.
let tintColor: UIColor?
/// The descriptive update message of the `UIAlertController`.
let alertMessage: String
/// The main message of the `UIAlertController`.
let alertTitle: String
/// The "Next time" button text of the `UIAlertController`.
let nextTimeButtonTitle: String
/// The "Skip this version" button text of the `UIAlertController`.
let skipButtonTitle: String
/// The "Update" button text of the `UIAlertController`.
let updateButtonTitle: String
/// The instance of the `UIAlertController` used to present the update alert.
var alertController: UIAlertController?
/// The `UIWindow` instance that presents the `SirenViewController`.
private var updaterWindow: UIWindow {
let window = UIWindow(frame: UIScreen.main.bounds)
window.rootViewController = SirenViewController()
window.windowLevel = UIWindow.Level.alert + 1
return window
}
/// `PresentationManager`'s public initializer.
///
/// - Parameters:
/// - tintColor: The alert's tintColor. Settings this to `nil` defaults to the system default color.
/// - appName: The name of the app (overrides the default/bundled name).
/// - alertTitle: The title field of the `UIAlertController`.
/// - alertMessage: The `message` field of the `UIAlertController`.
/// - nextTimeButtonTitle: The `title` field of the Next Time Button `UIAlertAction`.
/// - skipButtonTitle: The `title` field of the Skip Button `UIAlertAction`.
/// - updateButtonTitle: The `title` field of the Update Button `UIAlertAction`.
/// - forceLanguage: The language the alert to which the alert should be set. If `nil`, it falls back to the device's preferred locale.
public init(alertTintColor tintColor: UIColor? = nil,
appName: String? = nil,
alertTitle: String = AlertConstants.alertTitle,
alertMessage: String = AlertConstants.alertMessage,
updateButtonTitle: String = AlertConstants.updateButtonTitle,
nextTimeButtonTitle: String = AlertConstants.nextTimeButtonTitle,
skipButtonTitle: String = AlertConstants.skipButtonTitle,
forceLanguageLocalization forceLanguage: Localization.Language? = nil) {
self.alertTitle = alertTitle
self.alertMessage = alertMessage
self.localization = Localization(appName: appName, andForceLanguageLocalization: forceLanguage)
self.nextTimeButtonTitle = nextTimeButtonTitle
self.updateButtonTitle = updateButtonTitle
self.skipButtonTitle = skipButtonTitle
self.tintColor = tintColor
}
/// The default `PresentationManager`.
///
/// By default:
/// - There is no tint color (defaults to Apple's system `blue` color.)
/// - The name of the app is equal to the name that appears in `Info.plist`.
/// - The strings are all set to that of the user's device localization (if supported) or it falls back to English.
public static let `default` = PresentationManager()
}
extension PresentationManager {
/// Constructs the localized update alert `UIAlertController` object.
///
/// - Parameters:
/// - rules: The rules that are used to define the type of alert that should be presented.
/// - currentAppStoreVersion: The current version of the app in the App Store.
/// - handler: The completion handler that returns the an `AlertAction` depending on the type of action the end-user took.
mutating func presentAlert(withRules rules: Rules,
forCurrentAppStoreVersion currentAppStoreVersion: String,
completion handler: CompletionHandler?) {
UserDefaults.alertPresentationDate = Date()
// Alert Title
let alertTitle: String
if self.alertTitle == AlertConstants.alertTitle {
alertTitle = localization.alertTitle()
} else {
alertTitle = self.alertTitle
}
// Alert Message
let alertMessage: String
if self.alertMessage == AlertConstants.alertMessage {
alertMessage = localization.alertMessage(forCurrentAppStoreVersion: currentAppStoreVersion)
} else {
alertMessage = self.alertMessage
}
alertController = UIAlertController(title: alertTitle,
message: alertMessage,
preferredStyle: .alert)
if let tintColor = tintColor {
alertController?.view.tintColor = tintColor
}
switch rules.alertType {
case .force:
alertController?.addAction(updateAlertAction(completion: handler))
case .option:
alertController?.addAction(updateAlertAction(completion: handler))
alertController?.addAction(nextTimeAlertAction(completion: handler))
case .skip:
alertController?.addAction(updateAlertAction(completion: handler))
alertController?.addAction(nextTimeAlertAction(completion: handler))
alertController?.addAction(skipAlertAction(forCurrentAppStoreVersion: currentAppStoreVersion, completion: handler))
case .none:
handler?(.unknown)
}
// If the alertType is .none, an alert will not be 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)
}
}
/// The `UIAlertAction` that is executed when the `Update` option is selected.
///
/// - Parameters:
/// - handler: The completion handler that returns the `.update` option.
/// - Returns: The `Update` alert action.
private func updateAlertAction(completion handler: CompletionHandler?) -> UIAlertAction {
let title: String
if self.updateButtonTitle == AlertConstants.updateButtonTitle {
title = localization.updateButtonTitle()
} else {
title = self.updateButtonTitle
}
let action = UIAlertAction(title: title, style: .default) { _ in
self.cleanUpAlertController()
Siren.shared.launchAppStore()
handler?(.appStore)
return
}
return action
}
/// The `UIAlertAction` that is executed when the `Next time` option is selected.
///
/// - Parameters:
/// - handler: The completion handler that returns the `.nextTime` option.
/// - Returns: The `Next time` alert action.
private func nextTimeAlertAction(completion handler: CompletionHandler?) -> UIAlertAction {
let title: String
if self.nextTimeButtonTitle == AlertConstants.nextTimeButtonTitle {
title = localization.nextTimeButtonTitle()
} else {
title = self.nextTimeButtonTitle
}
let action = UIAlertAction(title: title, style: .default) { _ in
self.cleanUpAlertController()
handler?(.nextTime)
return
}
return action
}
/// The `UIAlertAction` that is executed when the `Skip this version` option is selected.
///
/// - Parameters:
/// - currentAppStoreVersion: The current version of the app in the App Store.
/// - handler: The completion handler that returns the `.skip` option.
/// - Returns: The `Skip this version` alert action.
private func skipAlertAction(forCurrentAppStoreVersion currentAppStoreVersion: String, completion handler: CompletionHandler?) -> UIAlertAction {
let title: String
if self.skipButtonTitle == AlertConstants.skipButtonTitle {
title = localization.skipButtonTitle()
} else {
title = self.skipButtonTitle
}
let action = UIAlertAction(title: title, style: .default) { _ in
UserDefaults.storedSkippedVersion = currentAppStoreVersion
UserDefaults.standard.synchronize()
self.cleanUpAlertController()
handler?(.skip)
return
}
return action
}
/// Removes the `alertController` from memory.
private func cleanUpAlertController() {
alertController?.hide(window: self.updaterWindow)
alertController?.dismiss(animated: false, completion: nil)
}
}
+125
View File
@@ -0,0 +1,125 @@
//
// RulesManager.swift
// Siren
//
// Created by Arthur Sabintsev on 12/1/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// RulesManager for Siren
public struct RulesManager {
/// The alert will only show up if the current version has already been released for X days.
///
/// This value defaults to 1 day (in `RulesManager`'s initializer) to avoid an issue where
/// Apple updates the JSON faster than the app binary propogates to the App Store.
let releasedForDays: Int
/// The `Rules` that should be used when the App Store version of the app signifies that it is a **major** version update (A.b.c.d).
var majorUpdateRules: Rules
/// The `Rules` that should be used when the App Store version of the app signifies that it is a **minor** version update (a.B.c.d).
var minorUpdateRules: Rules
/// The `Rules` that should be used when the App Store version of the app signifies that it is a **patch** version update (a.b.C.d).
var patchUpdateRules: Rules
/// The `Rules` that should be used when the App Store version of the app signifies that it is a **revision** version update (a.b.c.D).
var revisionUpdateRules: Rules
/// Initializer that sets update-specific `Rules` 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.
///
/// By default, the `releasedForDays` parameter delays the update alert from being presented for _1 day_
/// to avoid an issue where the _iTunes Lookup_ 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 _1 day_ delay.
///
/// - Warning: Setting `releasedForDays` to _0 days_ causes the alert to appear right away, even if the binary isn't available.
/// If this value is set to _0 days_, and an `AlertType` of type `.force` 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.
///
/// - Parameters:
/// - rules: The rules that should be set for all version updates.
/// - releasedForDays: The amount of time (in days) that the app should delay before presenting the user
public init(majorUpdateRules: Rules = .default,
minorUpdateRules: Rules = .default,
patchUpdateRules: Rules = .default,
revisionUpdateRules: Rules = .default,
showAlertAfterCurrentVersionHasBeenReleasedForDays releasedForDays: Int = 1) {
self.majorUpdateRules = majorUpdateRules
self.minorUpdateRules = minorUpdateRules
self.patchUpdateRules = patchUpdateRules
self.revisionUpdateRules = revisionUpdateRules
self.releasedForDays = releasedForDays
}
/// Initializer that sets the same update `Rules` for all types of updates (e.g., major, minor, patch, revision).
/// This means that all four update types will use the same presentation rules.
///
/// By default, the `releasedForDays` parameter delays the update alert from being presented for _1 day_
/// to avoid an issue where the _iTunes Lookup_ 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 _1 day_ delay.
///
/// - Warning: Setting `releasedForDays` to _0 days_ causes the alert to appear right away, even if the binary isn't available.
/// If this value is set to _0 days_, and an `AlertType` of type `.force` 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.
///
/// - Parameters:
/// - rules: The rules that should be set for all version updates.
/// - releasedForDays: The amount of time (in days) that the app should delay before presenting the user
public init(globalRules rules: Rules = .default,
showAlertAfterCurrentVersionHasBeenReleasedForDays releasedForDays: Int = 1) {
self.init(majorUpdateRules: rules,
minorUpdateRules: rules,
patchUpdateRules: rules,
revisionUpdateRules: rules,
showAlertAfterCurrentVersionHasBeenReleasedForDays: releasedForDays)
}
/// Returns the appropriate update rules based on the type of version that is returned from the API.
///
/// - Parameter type: The type of app update.
/// - Returns: The appropriate rule based on the type of app update that is returned by the API.
func loadRulesForUpdateType(_ type: UpdateType) -> Rules {
switch type {
case .major: return majorUpdateRules
case .minor: return minorUpdateRules
case .patch: return patchUpdateRules
case .revision: return revisionUpdateRules
case .unknown: return majorUpdateRules
}
}
/// The default `RulesManager`.
///
/// By default, the `Rules.default` rule is used for all update typs.
public static let `default` = RulesManager(globalRules: .default)
}
// MARK: - RulesManager-related Constants
extension RulesManager {
/// Informs Siren of the type of update that is available so that
/// the appropriate ruleset is used to present the update alert.
///
/// - major: Major release available: A.b.c.d
/// - minor: Minor release available: a.B.c.d
/// - patch: Patch release available: a.b.C.d
/// - revision: Revision release available: a.b.c.D
/// - unknown: No information available about the update.
public enum UpdateType: String {
/// Major release available: A.b.c.d
case major
/// Minor release available: a.B.c.d
case minor
/// Patch release available: a.b.C.d
case patch
/// Revision release available: a.b.c.D
case revision
/// No information available about the update.
case unknown
}
}
+21
View File
@@ -0,0 +1,21 @@
//
// AlertAction.swift
// Siren
//
// Created by Arthur Sabintsev on 12/1/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// The `UIAlertController` button that was pressed upon being presented an update alert.
public enum AlertAction {
/// The user clicked on the `Update` option, which took them to the app's App Store page.
case appStore
/// The user clicked on the `Next Time` option, which dismissed the alert.
case nextTime
/// The user clicked on the `Skip this version` option, which dismissed the alert.
case skip
/// (Default) The user never chose an option. This is returned when an error is thrown by Siren.
case unknown
}
+27
View File
@@ -0,0 +1,27 @@
//
// AlertConstants.swift
// Siren
//
// Created by Arthur Sabintsev on 12/18/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// The default constants used for the update alert's messaging.
public struct AlertConstants {
/// The text that conveys the message that there is an app update available
public static let alertMessage = "A new version of %@ is available. Please update to version %@ now."
/// The alert title which defaults to *Update Available*.
public static let alertTitle = "Update Available"
/// The button text that conveys the message that the user should be prompted to update next time the app launches.
public static let nextTimeButtonTitle = "Next time"
/// The text that conveys the message that the the user wants to skip this verison update.
public static let skipButtonTitle = "Skip this version"
/// The button text that conveys the message that the user would like to update the app right away.
public static let updateButtonTitle = "Update"
}
+166
View File
@@ -0,0 +1,166 @@
//
// Localization.swift
// Siren
//
// Created by Arthur Sabintsev on 9/25/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// Localization information and strings for Siren.
public struct Localization {
/// Determines the available languages in which the update message and alert button titles should appear.
///
/// By default, the operating system's default lanuage setting is used. However, you can force a specific language
/// by setting the forceLanguageLocalization property before calling checkVersion()
public enum Language: String {
/// Arabic Language Localization
case arabic = "ar"
/// Armenian Language Localization
case armenian = "hy"
/// Basque Language Localization
case basque = "eu"
/// Simplified Chinese Language Localization
case chineseSimplified = "zh-Hans"
/// Traditional Chinese Localization Localization
case chineseTraditional = "zh-Hant"
/// Croatian Language Localization
case croatian = "hr"
/// Czech Language Localization
case czech = "cs"
/// Danish Language Localization
case danish = "da"
/// Dutch Language Localization
case dutch = "nl"
/// English Language Localization
case english = "en"
/// Estonian Language Localization
case estonian = "et"
/// Finnish Language Localization
case finnish = "fi"
/// French Language Localization
case french = "fr"
/// German Language Localization
case german = "de"
/// Greek Language Localization
case greek = "el"
/// Hebrew Language Localization
case hebrew = "he"
/// Hungarian Language Localization
case hungarian = "hu"
/// Indonesian Language Localization
case indonesian = "id"
/// Italian Language Localization
case italian = "it"
/// Japanese Language Localization
case japanese = "ja"
/// Korean Language Localization
case korean = "ko"
/// Latvian Language Localization
case latvian = "lv"
/// Lithuanian Language Localization
case lithuanian = "lt"
/// Malay Language Localization
case malay = "ms"
/// Norwegian Language Localization
case norwegian = "nb-NO"
/// Persian Language Localization
case persian = "fa"
/// Persian (Afghanistan) Language Localization
case persianAfghanistan = "fa-AF"
/// Persian (Iran) Language Localization
case persianIran = "fa-IR"
/// Polish Language Localization
case polish = "pl"
/// Brazilian Portuguese Language Localization
case portugueseBrazil = "pt"
/// Portugal's Portuguese Language Localization
case portuguesePortugal = "pt-PT"
/// Russian Language Localization
case russian = "ru"
/// Serbian (Cyrillic) Language Localization
case serbianCyrillic = "sr-Cyrl"
/// Serbian (Latin) Language Localization
case serbianLatin = "sr-Latn"
/// Slovenian Language Localization
case slovenian = "sl"
/// Spanish Language Localization
case spanish = "es"
/// Swedish Language Localization
case swedish = "sv"
/// Thai Language Localization
case thai = "th"
/// Turkish Language Localization
case turkish = "tr"
/// Urdu Language Localization
case urdu = "ur"
/// Ukranian Language Localization
case ukrainian = "uk"
/// Vietnamese Language Localization
case vietnamese = "vi"
}
/// The name of the app as defined by the `Info.plist`.
private var appName: String = Bundle.bestMatchingAppName()
/// Overrides the default localization of a user's device when presenting the update message and button titles in the alert.
///
/// See the Siren.Localization.Language enum for more details.
private let forceLanguage: Language?
/// Initializes
///
/// - Parameters:
/// - appName: Overrides the default name of the app. This is optional and defaults to the app that is defined in the `Info.plist`.
/// - forceLanguage: The language the alert to which the alert should be set. If `nil`, it falls back to the device's preferred locale.
init(appName: String?, andForceLanguageLocalization forceLanguage: Language?) {
if let appName = appName {
self.appName = appName
}
self.forceLanguage = forceLanguage
}
/// The localized string for the `UIAlertController`'s message field. .
///
/// - Returns: A localized string for the update message.
public func alertMessage(forCurrentAppStoreVersion currentAppStoreVersion: String) -> String {
let message = Bundle.localizedString(forKey: AlertConstants.alertMessage,
andForceLocalization: forceLanguage)
return String(format: message, appName, currentAppStoreVersion)
}
/// The localized string for the `UIAlertController`'s title field. .
///
/// - Returns: A localized string for the phrase "Update Available".
public func alertTitle() -> String {
return Bundle.localizedString(forKey: AlertConstants.alertTitle,
andForceLocalization: forceLanguage)
}
/// The localized string for the "Next time" `UIAlertAction`.
///
/// - Returns: A localized string for the phrase "Next time".
public func nextTimeButtonTitle() -> String {
return Bundle.localizedString(forKey: AlertConstants.nextTimeButtonTitle,
andForceLocalization: forceLanguage)
}
/// The localized string for the "Skip this version" `UIAlertAction`.
///
/// - Returns: A localized string for the phrase "Skip this version".
public func skipButtonTitle() -> String {
return Bundle.localizedString(forKey: AlertConstants.skipButtonTitle,
andForceLocalization: forceLanguage)
}
/// The localized string for the "Update" `UIAlertAction`.
///
/// - Returns: A localized string for the phrase "Update".
public func updateButtonTitle() -> String {
return Bundle.localizedString(forKey: AlertConstants.updateButtonTitle,
andForceLocalization: forceLanguage)
}
}
+53
View File
@@ -0,0 +1,53 @@
//
// LookupModel.swift
// Siren
//
// Created by Arthur Sabintsev on 8/6/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// Model representing a selection of results from the iTunes Lookup API.
public struct LookupModel: Decodable {
/// Codable Coding Keys for the Top-Level iTunes Lookup API JSON response.
private enum CodingKeys: String, CodingKey {
/// The results JSON key.
case results
}
/// The array of results objects from the iTunes Lookup API.
public let results: [Results]
/// The Results object from the the iTunes Lookup API.
public struct Results: Decodable {
/// Codable Coding Keys for the Results array in the iTunes Lookup API JSON response.
private enum CodingKeys: String, CodingKey {
/// The appID JSON key.
case appID = "trackId"
/// The current version release date JSON key.
case currentVersionReleaseDate
/// The minimum device iOS version compatibility JSON key.
case minimumOSVersion = "minimumOsVersion"
/// The release notes JSON key.
case releaseNotes
/// The current App Store version JSON key.
case version
}
/// The app's App ID.
public let appID: Int
/// The release date for the latest verison of the app.
public let currentVersionReleaseDate: String
/// The minimum verison of iOS that the current verison of the app requires.
public let minimumOSVersion: String
/// The releases notes from the latest version of the app.
public let releaseNotes: String?
/// The latest version of the app.
public let version: String
}
}
+24
View File
@@ -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
}
+25
View File
@@ -0,0 +1,25 @@
//
// Results.swift
// Siren
//
// Created by Arthur Sabintsev on 12/1/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// The relevant metadata returned from Siren upon completing a successful version check.
public struct Results {
/// The `UIAlertAction` the user chose upon being presented with the update alert.
/// Defaults to `unknown` until an alert is actually presented.
public var alertAction: AlertAction = .unknown
/// The Siren-supported locale that was used for the string in the update alert.
public let localization: Localization
/// The Swift-mapped API model, if a successful version check was performed.
public let lookupModel: LookupModel
/// The type of update that was returned for the API.
public var updateType: RulesManager.UpdateType = .unknown
}
+91
View File
@@ -0,0 +1,91 @@
//
// Rules.swift
// Siren
//
// Created by Sabintsev, Arthur on 11/18/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// Alert Presentation Rules for Siren.
public struct Rules {
/// The type of alert that should be presented.
let alertType: AlertType
/// 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.
let frequency: UpdatePromptFrequency
/// Initializes the alert presentation rules.
///
/// - Parameters:
/// - frequency: How often a user should be prompted to update the app once a new version is available in the App Store.
/// - alertType: The type of alert that should be presented.
public init(promptFrequency frequency: UpdatePromptFrequency,
forAlertType alertType: AlertType) {
self.frequency = frequency
self.alertType = alertType
}
/// Performs a version check immediately, but allows the user to skip updating the app until the next time the app becomes active.
public static var annoying: Rules {
return Rules(promptFrequency: .immediately, forAlertType: .option)
}
/// Performs a version check immediately and forces the user to update the app.
public static var critical: Rules {
return Rules(promptFrequency: .immediately, forAlertType: .force)
}
/// Performs a version check once a day, but allows the user to skip updating the app until
/// the next time the app becomes active or skipping the update all together until another version is released.
///
/// This is the default setting.
public static var `default`: 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)
}
/// Performs a version check weekly, but allows the user to skip updating the app until
/// the next time the app becomes active or skipping the update all together until another version is released.
public static var relaxed: Rules {
return Rules(promptFrequency: .weekly, forAlertType: .skip)
}
}
// Rules-related Constants
public extension Rules {
/// Determines the type of alert to present after a successful version check has been performed.
public enum AlertType {
/// Forces the user to update your app (1 button alert).
case force
/// Presents the user with option to update app now or at next launch (2 button alert).
case option
/// Presents the user with option to update the app now, at next launch, or to skip this version all together (3 button alert).
case skip
/// Doesn't present the alert.
/// Use this option if you would like to present a custom alert to the end-user.
case none
}
/// Determines the frequency in which 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.
public enum UpdatePromptFrequency: UInt {
/// Version check performed every time the app is launched.
case immediately = 0
/// Version check performed once a day.
case daily = 1
/// Version check performed once a week.
case weekly = 7
}
}
+212 -510
View File
@@ -8,591 +8,293 @@
import UIKit
// MARK: - Siren
/// The Siren Class. A singleton that is initialized using the `shared` constant.
/// The Siren Class.
public final class Siren: NSObject {
/// Return results or errors obtained from performing a version check with Siren.
public typealias ResultsHandler = (Results?, KnownError?) -> Void
/// Current installed version of your app.
internal var currentInstalledVersion: String? = {
return Bundle.main.object(forInfoDictionaryKey: "CFBundleShortVersionString") as? String
}()
/// The error domain for all errors created by Siren.
public let SirenErrorDomain = "Siren Error Domain"
/// The SirenDelegate variable, which should be set if you'd like to be notified:
///
/// When a user views or interacts with the alert
/// - sirenDidShowUpdateDialog(alertType: AlertType)
/// - sirenUserDidLaunchAppStore()
/// - sirenUserDidSkipVersion()
/// - sirenUserDidCancel()
///
/// When a new version has been detected, and you would like to present a localized message in a custom UI. use this delegate method:
/// - sirenDidDetectNewVersionWithoutAlert(message: String)
public weak var delegate: SirenDelegate?
/// The debug flag, which is disabled by default.
/// When enabled, a stream of print() statements are logged to your console when a version check is performed.
public lazy var debugEnabled = false
/// Determines the type of alert that should be shown.
/// See the Siren.AlertType enum for full details.
public var alertType: AlertType = .option {
didSet {
majorUpdateAlertType = alertType
minorUpdateAlertType = alertType
patchUpdateAlertType = alertType
revisionUpdateAlertType = alertType
}
}
/// Determines the type of alert that should be shown for major version updates: A.b.c
/// 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 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 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 Siren.AlertType.option.
/// See the Siren.AlertType enum for full details.
public lazy var revisionUpdateAlertType: AlertType = .option
/// The name of your app.
/// By default, it's set to the name of the app that's stored in your plist.
public lazy var appName = Bundle.bestMatchingAppName()
/// Overrides all the Strings to which Siren defaults.
/// Defaults to the values defined in `SirenAlertMessaging.Constants`
public var alertMessaging = SirenAlertMessaging()
/// The region or country of an App Store in which your app is available.
/// By default, all version checks are performed against the US App Store.
/// If your app is not available in the US App Store, set it to the identifier of at least one App Store within which it is available.
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 Siren.LanguageType enum for more details.
public var forceLanguageLocalization: Siren.LanguageType?
/// Overrides the tint color for UIAlertController.
public var alertControllerTintColor: UIColor?
/// When this is set, the alert will only show up if the current version has already been released for X days
/// Defaults to 1 day to avoid an issue where Apple updates the JSON faster than the app binary propogates to the App Store.
public var showAlertAfterCurrentVersionHasBeenReleasedForDays: Int = 1
/// The current version of your app that is available for download on the App Store
public internal(set) var currentAppStoreVersion: String?
internal var updaterWindow: UIWindow?
fileprivate var appID: Int?
fileprivate var lastVersionCheckPerformedOnDate: Date?
fileprivate lazy var alertViewIsVisible: Bool = false
/// Type of the available update
fileprivate var updateType: UpdateType = .unknown
/// The App's Singleton
/// The Siren singleton. The main point of entry to the Siren library.
public static let shared = Siren()
@available(*, deprecated: 1.2.0, unavailable, renamed: "shared")
public static let sharedInstance = Siren()
/// The manager that controls the App Store API that is
/// used to fetch the latest version of the app.
///
/// Defaults to the US App Store.
public lazy var apiManager: APIManager = .default
override init() {
lastVersionCheckPerformedOnDate = UserDefaults.standard.object(forKey: SirenDefaults.StoredVersionCheckDate.rawValue) as? Date
/// The manager that controls the update alert's string localization and tint color.
///
/// Defaults the string's lange localization to the user's device localization.
public lazy var presentationManager: PresentationManager = .default
/// The manager that controls the type of alert that should be displayed
/// and how often an alert should be displayed dpeneding on the type
/// of update that is available relative to the installed version of the app
/// (e.g., different rules for major, minor, patch and revision updated can be used).
///
/// Defaults to performing a version check once a day with an alert that allows
/// the user to skip updating the app until the next time the app becomes active or
/// skipping the update all together until another version is released.
public lazy var rulesManager: RulesManager = .default
/// The current installed version of your app.
lazy var currentInstalledVersion: String? = Bundle.version()
/// 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? = UserDefaults.alertPresentationDate
/// The App Store's unique identifier for an app.
private var appID: Int?
/// The completion handler used to return the results or errors returned by Siren.
private var resultsHandler: ResultsHandler?
/// The deinitialization method that clears out all observers,
deinit {
presentationManager.alertController?.dismiss(animated: true, completion: nil)
removeForegroundObservers()
removeBackgroundObservers()
}
}
/// Checks the currently installed version of your app against the App Store.
/// The default check is against the US App Store, but if your app is not listed in the US,
/// you should set the `countryCode` property before calling this method. Please refer to the countryCode property for more information.
// MARK: - Public API Interface
public extension Siren {
/// This method executes the Siren version checking and alert presentation flow.
///
/// - Parameters:
/// - 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) {
updateType = .unknown
/// - 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
guard Bundle.bundleID() != nil else {
printMessage("Please make sure that you have set a `Bundle Identifier` in your project.")
return
}
if checkType == .immediately {
switch performCheck {
case .onDemand:
removeForegroundObservers()
performVersionCheck()
} else {
guard let lastVersionCheckPerformedOnDate = lastVersionCheckPerformedOnDate else {
performVersionCheck()
return
}
if Date.days(since: lastVersionCheckPerformedOnDate) >= checkType.rawValue {
performVersionCheck()
} else {
postError(.recentlyCheckedAlready)
}
case .onForeground:
addForegroundObservers()
}
// Add background app state change observers.
addBackgroundObservers()
}
/// Launches the AppStore in two situations:
///
/// - User clicked the `Update` button in the UIAlertController modal.
/// - Developer built a custom alert modal and needs to be able to call this function when the user chooses to update the app in the aforementioned custom modal.
public func launchAppStore() {
/// Launches the AppStore in two situations when the user clicked the `Update` button in the UIAlertController modal.
///
/// This function is marked `public` as a convenience for those developers who decide to build a custom alert modal
/// instead of using Siren's prebuilt update alert.
func launchAppStore() {
guard let appID = appID,
let url = URL(string: "https://itunes.apple.com/app/id\(appID)") else {
resultsHandler?(nil, .malformedURL)
return
}
DispatchQueue.main.async {
UIApplication.shared.openURL(url)
if #available(iOS 10.0, *) {
UIApplication.shared.open(url, options: [:], completionHandler: nil)
} else {
UIApplication.shared.openURL(url)
}
}
}
}
// MARK: - Helpers (Networking)
// MARK: - Version Check and Alert Presentation Flow
private extension Siren {
/// Initiates the unidirectional version checking flow.
func performVersionCheck() {
do {
let url = try iTunesURLFromString()
let request = URLRequest(url: url, cachePolicy: .reloadIgnoringCacheData, timeoutInterval: 30)
URLSession.shared.dataTask(with: request, completionHandler: { [weak self] (data, response, error) in
self?.processResults(withData: data, response: response, error: error)
}).resume()
} catch _ {
postError(.malformedURL)
}
}
func processResults(withData data: Data?, response: URLResponse?, error: Error?) {
if let error = error {
postError(.appStoreDataRetrievalFailure(underlyingError: error))
} else {
guard let data = data else {
postError(.appStoreDataRetrievalFailure(underlyingError: nil))
alertPresentationDate = UserDefaults.alertPresentationDate
apiManager.performVersionCheckRequest { [weak self] (lookupModel, error) in
guard let self = self else { return }
guard let lookupModel = lookupModel, error == nil else {
self.resultsHandler?(nil, error)
return
}
do {
let decodedData = try JSONDecoder().decode(SirenLookupModel.self, from: data)
guard !decodedData.results.isEmpty else {
return postError(.appStoreDataRetrievalEmptyResults)
}
DispatchQueue.main.async { [unowned self] in
self.printMessage("Decoded JSON results: \(decodedData)")
// Process Results (e.g., extract current version that is available on the AppStore)
self.processVersionCheck(with: decodedData)
}
} catch let error as NSError {
postError(.appStoreJSONParsingFailure(underlyingError: error))
}
self.validate(model: lookupModel)
}
}
func processVersionCheck(with model: SirenLookupModel) {
guard isUpdateCompatibleWithDeviceOS(for: model) else {
/// Validates the parsed and mapped iTunes Lookup Model
/// to guarantee all the relevant data was returned before
/// attempting to present an alert.
///
/// - Parameter model: The iTunes Lookup Model.
func validate(model: LookupModel) {
// Check if the latest version is compatible with current device's version of iOS.
guard DataParser.isUpdateCompatibleWithDeviceOS(for: model) else {
resultsHandler?(nil, .appStoreOSVersionUnsupported)
return
}
// Check and store the App ID .
guard let appID = model.results.first?.appID else {
postError(.appStoreAppIDFailure)
resultsHandler?(nil, .appStoreAppIDFailure)
return
}
self.appID = appID
// Check and store the current App Store version.
guard let currentAppStoreVersion = model.results.first?.version else {
postError(.appStoreVersionArrayFailure)
resultsHandler?(nil, .appStoreVersionArrayFailure)
return
}
self.currentAppStoreVersion = currentAppStoreVersion
guard isAppStoreVersionNewer() else {
delegate?.sirenLatestVersionInstalled()
postError(.noUpdateAvailable)
// Check if the App Store version is newer than the currently installed version.
guard DataParser.isAppStoreVersionNewer(installedVersion: currentInstalledVersion,
appStoreVersion: currentAppStoreVersion) else {
resultsHandler?(nil, .noUpdateAvailable)
return
}
// Check the release date of the current version.
guard let currentVersionReleaseDate = model.results.first?.currentVersionReleaseDate,
let daysSinceRelease = Date.days(since: currentVersionReleaseDate) else {
resultsHandler?(nil, .currentVersionReleaseDate)
return
}
// Check if applicaiton has been released for the amount of days defined by the app consuming Siren.
guard daysSinceRelease >= rulesManager.releasedForDays else {
resultsHandler?(nil, .releasedTooSoon(daysSinceRelease: daysSinceRelease,
releasedForDays: rulesManager.releasedForDays))
return
}
guard daysSinceRelease >= showAlertAfterCurrentVersionHasBeenReleasedForDays else {
let message = "Your app has been released for \(daysSinceRelease) days, but Siren cannot prompt the user until \(showAlertAfterCurrentVersionHasBeenReleasedForDays) days have passed."
self.printMessage(message)
return
}
showAlertIfCurrentAppStoreVersionNotSkipped()
determineIfAlertPresentationRulesAreSatisfied(forCurrentAppStoreVersion: currentAppStoreVersion, andLookupModel: model)
}
func iTunesURLFromString() throws -> URL {
var components = URLComponents()
components.scheme = "https"
components.host = "itunes.apple.com"
components.path = "/lookup"
var items: [URLQueryItem] = [URLQueryItem(name: "bundleId", value: Bundle.bundleID())]
if let countryCode = countryCode {
let item = URLQueryItem(name: "country", value: countryCode)
items.append(item)
/// Determines if the update alert can be presented based on the
/// rules set in the `RulesManager` and the the skip version settings.
///
/// - Parameters:
/// - currentAppStoreVersion: The curren version of the app in the App Store.
/// - model: The iTunes Lookup Model.
func determineIfAlertPresentationRulesAreSatisfied(forCurrentAppStoreVersion currentAppStoreVersion: String, andLookupModel model: LookupModel) {
// Did the user:
// - request to skip being prompted with version update alerts for a specific version
// - and is the latest App Store update the same version that was requested?
if let previouslySkippedVersion = UserDefaults.storedSkippedVersion,
let currentInstalledVersion = currentInstalledVersion,
!currentAppStoreVersion.isEmpty,
currentAppStoreVersion == previouslySkippedVersion {
resultsHandler?(nil, .skipVersionUpdate(installedVersion: currentInstalledVersion, appStoreVersion: currentAppStoreVersion))
return
}
components.queryItems = items
let updateType = DataParser.parseForUpdate(forInstalledVersion: currentInstalledVersion,
andAppStoreVersion: currentAppStoreVersion)
let rules = rulesManager.loadRulesForUpdateType(updateType)
guard let url = components.url, !url.absoluteString.isEmpty else {
throw SirenError.Known.malformedURL
}
return url
}
}
// MARK: - Helpers (Alert)
private extension Siren {
func showAlertIfCurrentAppStoreVersionNotSkipped() {
alertType = setAlertType()
guard let previouslySkippedVersion = UserDefaults.standard.object(forKey: SirenDefaults.StoredSkippedVersion.rawValue) as? String else {
showAlert()
return
}
if let currentAppStoreVersion = currentAppStoreVersion, currentAppStoreVersion != previouslySkippedVersion {
showAlert()
}
}
func showAlert() {
storeVersionCheckDate()
let updateAvailableMessage = Bundle.localizedString(forKey: alertMessaging.updateTitle, forceLanguageLocalization: forceLanguageLocalization)
let newVersionMessage = localizedNewVersionMessage()
let alertController = UIAlertController(title: updateAvailableMessage, message: newVersionMessage, preferredStyle: .alert)
if let alertControllerTintColor = alertControllerTintColor {
alertController.view.tintColor = alertControllerTintColor
}
switch alertType {
case .force:
alertController.addAction(updateAlertAction())
case .option:
alertController.addAction(nextTimeAlertAction())
alertController.addAction(updateAlertAction())
case .skip:
alertController.addAction(nextTimeAlertAction())
alertController.addAction(updateAlertAction())
alertController.addAction(skipAlertAction())
case .none:
delegate?.sirenDidDetectNewVersionWithoutAlert(message: newVersionMessage, updateType: updateType)
}
if alertType != .none && !alertViewIsVisible {
alertController.show()
alertViewIsVisible = true
delegate?.sirenDidShowUpdateDialog(alertType: alertType)
}
}
func updateAlertAction() -> UIAlertAction {
let title = localizedUpdateButtonTitle()
let action = UIAlertAction(title: title, style: .default) { [weak self] _ in
guard let strongSelf = self else {
if rules.frequency == .immediately {
presentAlert(withRules: rules, forCurrentAppStoreVersion: currentAppStoreVersion, model: model, andUpdateType: updateType)
} else {
guard let alertPresentationDate = alertPresentationDate else {
presentAlert(withRules: rules, forCurrentAppStoreVersion: currentAppStoreVersion, model: model, andUpdateType: updateType)
return
}
strongSelf.hideWindow()
strongSelf.launchAppStore()
strongSelf.delegate?.sirenUserDidLaunchAppStore()
strongSelf.alertViewIsVisible = false
return
}
return action
}
func nextTimeAlertAction() -> UIAlertAction {
let title = localizedNextTimeButtonTitle()
let action = UIAlertAction(title: title, style: .default) { [weak self] _ in
guard let strongSelf = self else {
return
if Date.days(since: alertPresentationDate) >= rules.frequency.rawValue {
presentAlert(withRules: rules, forCurrentAppStoreVersion: currentAppStoreVersion, model: model, andUpdateType: updateType)
} else {
resultsHandler?(nil, .recentlyPrompted)
}
strongSelf.hideWindow()
strongSelf.delegate?.sirenUserDidCancel()
strongSelf.alertViewIsVisible = false
return
}
return action
}
func skipAlertAction() -> UIAlertAction {
let title = localizedSkipButtonTitle()
let action = UIAlertAction(title: title, style: .default) { [weak self] _ in
guard let strongSelf = self else {
return
/// 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.
///
/// - Parameters:
/// - rules: The rules for how to present the alert.
/// - currentAppStoreVersion: The current version of the app in the App Store.
/// - model: The iTunes Lookup Model.
/// - updateType: The type of update that is available based on the version found in the App Store.
func presentAlert(withRules rules: Rules,
forCurrentAppStoreVersion currentAppStoreVersion: String,
model: LookupModel,
andUpdateType updateType: RulesManager.UpdateType) {
presentationManager.presentAlert(withRules: rules, forCurrentAppStoreVersion: currentAppStoreVersion) { [weak self] alertAction in
guard let self = self else { return }
let results = Results(alertAction: alertAction,
localization: self.presentationManager.localization,
lookupModel: model,
updateType: updateType)
self.resultsHandler?(results, nil)
}
}
}
// MARK: - Add Observers
private extension Siren {
/// Adds an observer that listens for app launching/relaunching.
func addForegroundObservers() {
guard didBecomeActiveObserver == nil else { return }
didBecomeActiveObserver = NotificationCenter
.default
.addObserver(forName: UIApplication.didBecomeActiveNotification,
object: nil,
queue: nil) { [weak self] _ in
guard let self = self else { return }
self.performVersionCheck()
}
}
/// 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 let currentAppStoreVersion = strongSelf.currentAppStoreVersion {
UserDefaults.standard.set(currentAppStoreVersion, forKey: SirenDefaults.StoredSkippedVersion.rawValue)
UserDefaults.standard.synchronize()
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)
}
strongSelf.hideWindow()
strongSelf.delegate?.sirenUserDidSkipVersion()
strongSelf.alertViewIsVisible = false
return
}
return action
}
func setAlertType() -> Siren.AlertType {
guard let currentInstalledVersion = currentInstalledVersion,
let currentAppStoreVersion = currentAppStoreVersion else {
return .option
}
let oldVersion = (currentInstalledVersion).split {$0 == "."}.map { String($0) }.map {Int($0) ?? 0}
let newVersion = (currentAppStoreVersion).split {$0 == "."}.map { String($0) }.map {Int($0) ?? 0}
guard let newVersionFirst = newVersion.first, let oldVersionFirst = oldVersion.first else {
return alertType // Default value is .Option
}
if newVersionFirst > oldVersionFirst { // A.b.c.d
alertType = majorUpdateAlertType
updateType = .major
} else if newVersion.count > 1 && (oldVersion.count <= 1 || newVersion[1] > oldVersion[1]) { // a.B.c.d
alertType = minorUpdateAlertType
updateType = .minor
} else if newVersion.count > 2 && (oldVersion.count <= 2 || newVersion[2] > oldVersion[2]) { // a.b.C.d
alertType = patchUpdateAlertType
updateType = .patch
} else if newVersion.count > 3 && (oldVersion.count <= 3 || newVersion[3] > oldVersion[3]) { // a.b.c.D
alertType = revisionUpdateAlertType
updateType = .revision
}
return alertType
}
}
// MARK: - Helpers (Localization)
// MARK: - Remove Observers
private extension Siren {
func localizedNewVersionMessage() -> String {
let newVersionMessageToLocalize = alertMessaging.updateMessage
let newVersionMessage = Bundle.localizedString(forKey: newVersionMessageToLocalize, forceLanguageLocalization: forceLanguageLocalization)
guard let currentAppStoreVersion = currentAppStoreVersion else {
return String(format: newVersionMessage, appName, "Unknown")
}
return String(format: newVersionMessage, appName, currentAppStoreVersion)
/// Removes the observer that listens for app launching/relaunching.
func removeForegroundObservers() {
NotificationCenter.default.removeObserver(didBecomeActiveObserver as Any)
didBecomeActiveObserver = nil
}
func localizedUpdateButtonTitle() -> String {
return Bundle.localizedString(forKey: alertMessaging.updateButtonMessage, forceLanguageLocalization: forceLanguageLocalization)
}
/// Remove the observers that list to app resignation and app backgrounding.
func removeBackgroundObservers() {
NotificationCenter.default.removeObserver(willResignActiveObserver as Any)
willResignActiveObserver = nil
func localizedNextTimeButtonTitle() -> String {
return Bundle.localizedString(forKey: alertMessaging.nextTimeButtonMessage, forceLanguageLocalization: forceLanguageLocalization)
}
func localizedSkipButtonTitle() -> String {
return Bundle.localizedString(forKey: alertMessaging.skipVersionButtonMessage, forceLanguageLocalization: forceLanguageLocalization)
}
}
// MARK: - Helpers (Version)
extension Siren {
func isAppStoreVersionNewer() -> Bool {
var newVersionExists = false
if let currentInstalledVersion = currentInstalledVersion,
let currentAppStoreVersion = currentAppStoreVersion,
(currentInstalledVersion.compare(currentAppStoreVersion, options: .numeric) == .orderedAscending) {
newVersionExists = true
}
return newVersionExists
}
fileprivate func storeVersionCheckDate() {
lastVersionCheckPerformedOnDate = Date()
if let lastVersionCheckPerformedOnDate = lastVersionCheckPerformedOnDate {
UserDefaults.standard.set(lastVersionCheckPerformedOnDate, forKey: SirenDefaults.StoredVersionCheckDate.rawValue)
UserDefaults.standard.synchronize()
}
}
}
// MARK: - Helpers (Misc.)
private extension Siren {
func isUpdateCompatibleWithDeviceOS(for model: SirenLookupModel) -> Bool {
guard let requiredOSVersion = model.results.first?.minimumOSVersion else {
postError(.appStoreOSVersionNumberFailure)
return false
}
let systemVersion = UIDevice.current.systemVersion
guard systemVersion.compare(requiredOSVersion, options: .numeric) == .orderedDescending ||
systemVersion.compare(requiredOSVersion, options: .numeric) == .orderedSame else {
postError(.appStoreOSVersionUnsupported)
return false
}
return true
}
func hideWindow() {
if let updaterWindow = updaterWindow {
updaterWindow.isHidden = true
self.updaterWindow = nil
}
}
/// Routes a console-bound message to the `SirenLog` struct, which decorates the log message.
///
/// - Parameter message: The message to decorate and log to the console.
func printMessage(_ message: String) {
if debugEnabled {
SirenLog(message)
}
}
}
// MARK: - Enumerated Types (Public)
public extension Siren {
/// Determines the type of alert to present after a successful version check has been performed.
enum AlertType {
/// Forces user to update your app (1 button alert).
case force
/// (DEFAULT) Presents user with option to update app now or at next launch (2 button alert).
case option
/// Presents user with option to update the app now, at next launch, or to skip this version all together (3 button alert).
case skip
/// Doesn't show the alert, but instead returns a localized message
/// for use in a custom UI within the sirenDidDetectNewVersionWithoutAlert() delegate method.
case none
}
/// Determines the frequency in which the the version check is performed and the user is prompted to update the app.
///
enum VersionCheckType: Int {
/// Version check performed every time the app is launched.
case immediately = 0
/// Version check performed once a day.
case daily = 1
/// Version check performed once a week.
case weekly = 7
}
/// Determines the available languages in which the update message and alert button titles should appear.
///
/// By default, the operating system's default lanuage setting is used. However, you can force a specific language
/// by setting the forceLanguageLocalization property before calling checkVersion()
enum LanguageType: String {
case arabic = "ar"
case armenian = "hy"
case basque = "eu"
case chineseSimplified = "zh-Hans"
case chineseTraditional = "zh-Hant"
case croatian = "hr"
case czech = "cs"
case danish = "da"
case dutch = "nl"
case english = "en"
case estonian = "et"
case finnish = "fi"
case french = "fr"
case german = "de"
case greek = "el"
case hebrew = "he"
case hungarian = "hu"
case indonesian = "id"
case italian = "it"
case japanese = "ja"
case korean = "ko"
case latvian = "lv"
case lithuanian = "lt"
case malay = "ms"
case norwegian = "nb-NO"
case persian = "fa"
case persianAfghanistan = "fa-AF"
case persianIran = "fa-IR"
case polish = "pl"
case portugueseBrazil = "pt"
case portuguesePortugal = "pt-PT"
case russian = "ru"
case serbianCyrillic = "sr-Cyrl"
case serbianLatin = "sr-Latn"
case slovenian = "sl"
case spanish = "es"
case swedish = "sv"
case thai = "th"
case turkish = "tr"
case urdu = "ur"
case ukrainian = "uk"
case vietnamese = "vi"
}
}
// MARK: - Enumerated Types (Private)
private extension Siren {
/// Siren-specific UserDefaults Keys
enum SirenDefaults: String {
/// Key that stores the timestamp of the last version check in UserDefaults
case StoredVersionCheckDate
/// Key that stores the version that a user decided to skip in UserDefaults.
case StoredSkippedVersion
}
}
// MARK: - Error Handling
private extension Siren {
func postError(_ error: SirenError.Known) {
delegate?.sirenDidFailVersionCheck(error: error)
printMessage(error.localizedDescription)
NotificationCenter.default.removeObserver(didEnterBackgroundObserver as Any)
didEnterBackgroundObserver = nil
}
}
-54
View File
@@ -1,54 +0,0 @@
//
// SirenAlertMessaging.swift
// Siren
//
// Created by Arthur Sabintsev on 12/6/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// MARK: - Siren Alert Messaging Customization
/// Allows the overriding of all the `UIAlertController` and `UIActionSheet` Strings to which Siren defaults.
///
/// - Warning: Overriding any of these keys will result in the loss of the built-in internationalization that Siren provides.
///
/// As SirenAlertMessaging is a Struct, one _or_ more keys can be modified. Overriding only one string will result in the other keys retaining their default (and internationalizable) values.
public struct SirenAlertMessaging {
public struct Constants {
public static let nextTime = "Next time"
public static let skipVersion = "Skip this version"
public static let updateMessage = "A new version of %@ is available. Please update to version %@ now."
public static let updateTitle = "Update Available"
public static let updateNow = "Update"
}
let nextTimeButtonMessage: String
let skipVersionButtonMessage: String
let updateButtonMessage: String
let updateMessage: String
let updateTitle: String
/// The public initializer
///
/// - Parameters:
/// - title: The title field of the `UIAlertController`.
/// - message: The `message` field of the `UIAlertController`.
/// - updateButtonMessage: The `title` field of the Update Button `UIAlertAction`.
/// - nextTimeButtonMessage: The `title` field of the Next Time Button `UIAlertAction`.
/// - skipVersionButtonMessage: The `title` field of the Skip Button `UIAlertAction`.
public init(updateTitle title: String = Constants.updateTitle,
updateMessage message: String = Constants.updateMessage,
updateButtonMessage: String = Constants.updateNow,
nextTimeButtonMessage: String = Constants.nextTime,
skipVersionButtonMessage: String = Constants.skipVersion) {
self.updateTitle = title
self.nextTimeButtonMessage = nextTimeButtonMessage
self.updateButtonMessage = updateButtonMessage
self.updateMessage = message
self.skipVersionButtonMessage = skipVersionButtonMessage
}
}
-54
View File
@@ -1,54 +0,0 @@
//
// SirenBundleExtension.swift
// SirenExample
//
// Created by Arthur Sabintsev on 3/17/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// MARK: - Bundle Extension for Siren
extension Bundle {
class func bundleID() -> String? {
return Bundle.main.bundleIdentifier
}
class func sirenBundlePath() -> String {
return Bundle(for: Siren.self).path(forResource: "Siren", ofType: "bundle") as String!
}
class func sirenForcedBundlePath(forceLanguageLocalization: Siren.LanguageType) -> String {
let path = sirenBundlePath()
let name = forceLanguageLocalization.rawValue
return Bundle(path: path)!.path(forResource: name, ofType: "lproj")!
}
class func localizedString(forKey key: String, forceLanguageLocalization: Siren.LanguageType?) -> String {
var path = sirenBundlePath()
let table = "SirenLocalizable"
if let forceLanguageLocalization = forceLanguageLocalization {
path = sirenForcedBundlePath(forceLanguageLocalization: forceLanguageLocalization)
}
return Bundle(path: path)!.localizedString(forKey: key, value: key, table: table)
}
class func bestMatchingAppName() -> String {
let bundleDisplayName = Bundle.main.object(forInfoDictionaryKey: "CFBundleDisplayName") as? String
let bundleName = Bundle.main.object(forInfoDictionaryKey: kCFBundleNameKey as String) as? String
return bundleDisplayName ?? bundleName ?? ""
}
}
// MARK: - Bundle Extension for Testing Siren
extension Bundle {
func testLocalizedString(forKey key: String, forceLanguageLocalization: Siren.LanguageType?) -> String {
return Bundle.localizedString(forKey: key, forceLanguageLocalization: forceLanguageLocalization)
}
}
-92
View File
@@ -1,92 +0,0 @@
//
// SirenDelegate.swift
// SirenExample
//
// Created by Arthur Sabintsev on 4/8/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// MARK - Siren UpdateType
/// `UpdateType` defines what kind of update is available
/// It is used as parameter if user wants to use
/// custom alert to inform the user about an update.
///
/// - major: Major release available: A.b.c.d
/// - minor: Minor release available: a.B.c.d
/// - patch: Patch release available: a.b.C.d
/// - revision: Revision release available: a.b.c.D
/// - unknown: No information available about the update
public enum UpdateType: String {
case major
case minor
case patch
case revision
case unknown
}
// MARK: - SirenDelegate Protocol
/// Delegate that handles all codepaths for Siren upon version check completion.
public protocol SirenDelegate: NSObjectProtocol {
/// User presented with update dialog.
func sirenDidShowUpdateDialog(alertType: Siren.AlertType)
/// User did click on button that launched App Store.app.
func sirenUserDidLaunchAppStore()
/// User did click on button that skips version update.
func sirenUserDidSkipVersion()
/// User did click on button that cancels update dialog.
func sirenUserDidCancel()
/// Siren failed to perform version check (may return system-level error).
func sirenDidFailVersionCheck(error: Error)
/// Siren performed version check and did not display alert.
func sirenDidDetectNewVersionWithoutAlert(message: String, updateType: UpdateType)
/// Siren performed version check and latest version is installed.
func sirenLatestVersionInstalled()
}
// MARK: - SirenDelegate Protocol Extension
public extension SirenDelegate {
func sirenDidShowUpdateDialog(alertType: Siren.AlertType) {
printMessage()
}
func sirenUserDidLaunchAppStore() {
printMessage()
}
func sirenUserDidSkipVersion() {
printMessage()
}
func sirenUserDidCancel() {
printMessage()
}
func sirenDidFailVersionCheck(error: Error) {
printMessage()
}
func sirenDidDetectNewVersionWithoutAlert(message: String, updateType: UpdateType) {
printMessage()
}
func sirenLatestVersionInstalled() {
printMessage()
}
private func printMessage(_ function: String = #function) {
SirenLog("The default implementation of \(function) is being called. You can ignore this message if you do not care to implement this method in your `SirenDelegate` conforming structure.")
}
}
-54
View File
@@ -1,54 +0,0 @@
//
// SirenError.swift
// Siren
//
// Created by Arthur Sabintsev on 8/6/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// MARK: - Siren Error Handling
public struct SirenError: LocalizedError {
public enum Known: Error {
case appStoreAppIDFailure
case appStoreDataRetrievalFailure(underlyingError: Error?)
case appStoreJSONParsingFailure(underlyingError: Error)
case appStoreDataRetrievalEmptyResults
case appStoreOSVersionNumberFailure
case appStoreOSVersionUnsupported
case appStoreVersionArrayFailure
case malformedURL
case noUpdateAvailable
case recentlyCheckedAlready
var localizedDescription: String {
switch self {
case .appStoreAppIDFailure:
return "Error retrieving trackId as the JSON does not contain a 'trackId' key."
case .appStoreDataRetrievalFailure(let error?):
return "Error retrieving App Store data as an error was returned\nAlso, the following system level error was returned: \(error)"
case .appStoreDataRetrievalFailure(.none):
return "Error retrieving App Store data as an error was returned."
case .appStoreDataRetrievalEmptyResults:
return "Error retrieving App Store data as the JSON results were empty. Is your app available in the US? If not, change the `countryCode` variable to fix this error."
case .appStoreJSONParsingFailure(let error):
return "Error parsing App Store JSON data.\nAlso, the following system level error was returned: \(error)"
case .appStoreOSVersionNumberFailure:
return "Error retrieving iOS version number as there was no data returned."
case .appStoreOSVersionUnsupported:
return "The version of iOS on the device is lower than that of the one required by the app verison update."
case .appStoreVersionArrayFailure:
return "Error retrieving App Store verson number as the JSON does not contain a 'version' key."
case .malformedURL:
return "The iTunes URL is malformed. Please leave an issue on http://github.com/ArtSabintsev/Siren with as many details as possible."
case .noUpdateAvailable:
return "No new update available."
case .recentlyCheckedAlready:
return "Not checking the version, because it already checked recently."
}
}
}
}
-20
View File
@@ -1,20 +0,0 @@
//
// SirenLog.swift
// SirenExample
//
// Created by Arthur Sabintsev on 8/5/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// MARK: - Log and decorate Siren-specific messages to the console.
struct SirenLog {
@discardableResult
init(_ message: String) {
print("[Siren] \(message)")
}
}
-33
View File
@@ -1,33 +0,0 @@
//
// SirenLookupModel.swift
// Siren
//
// Created by Arthur Sabintsev on 8/6/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// MARK: - Model representing a selection of results from the iTunes Lookup API
struct SirenLookupModel: Decodable {
private enum CodingKeys: String, CodingKey {
case results
}
let results: [Results]
struct Results: Decodable {
private enum CodingKeys: String, CodingKey {
case appID = "trackId"
case currentVersionReleaseDate
case minimumOSVersion = "minimumOsVersion"
case version
}
let appID: Int
let currentVersionReleaseDate: String
let minimumOSVersion: String
let version: String
}
}
-25
View File
@@ -1,25 +0,0 @@
//
// SirenTestHelper.swift
// SirenExample
//
// Created by Arthur Sabintsev on 4/8/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
// MARK: - Test Target Helpers
extension Siren {
func testSetCurrentInstalledVersion(version: String) {
currentInstalledVersion = version
}
func testSetAppStoreVersion(version: String) {
currentAppStoreVersion = version
}
func testIsAppStoreVersionNewer() -> Bool {
return isAppStoreVersionNewer()
}
}
@@ -1,25 +0,0 @@
//
// SirenUIAlertControllerExtension.swift
// SirenExample
//
// Created by Arthur Sabintsev on 3/17/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
import UIKit
// MARK: - UIAlertController Extension for Siren
extension UIAlertController {
func show() {
let window = UIWindow(frame: UIScreen.main.bounds)
window.rootViewController = SirenViewController()
window.windowLevel = UIWindowLevelAlert + 1
Siren.shared.updaterWindow = window
window.makeKeyAndVisible()
window.rootViewController!.present(self, animated: true, completion: nil)
}
}
+92
View File
@@ -0,0 +1,92 @@
//
// DataParser.swift
// Siren
//
// Created by Arthur Sabintsev on 11/25/18.
// Copyright © 2018 Sabintsev iOS Projects. All rights reserved.
//
import UIKit
/// Version parsing functions for Siren.
struct DataParser {
/// Checks to see if the App Store version of the app is newer than the installed version.
///
/// - Parameters:
/// - installedVersion: The installed version of the app.
/// - appStoreVersion: The App Store version of the app.
/// - Returns: `true` if the App Store version is newer. Otherwise, `false`.
static func isAppStoreVersionNewer(installedVersion: String?, appStoreVersion: String?) -> Bool {
guard let installedVersion = installedVersion,
let appStoreVersion = appStoreVersion,
(installedVersion.compare(appStoreVersion, options: .numeric) == .orderedAscending) else {
return false
}
return true
}
/// Validates that the latest version in the App Store is compatible with the device's current version of iOS.
///
/// - Parameter model: The iTunes Lookup Model.
/// - Returns: `true` if the latest version is compatible with the device's current version of iOS. Otherwise, `false`.
static func isUpdateCompatibleWithDeviceOS(for model: LookupModel) -> Bool {
guard let requiredOSVersion = model.results.first?.minimumOSVersion else {
return false
}
let systemVersion = UIDevice.current.systemVersion
guard systemVersion.compare(requiredOSVersion, options: .numeric) == .orderedDescending ||
systemVersion.compare(requiredOSVersion, options: .numeric) == .orderedSame else {
return false
}
return true
}
/// The type of update that is returned from the API in relation to the verison of the app that is installed.
///
/// - Parameters:
/// - installedVersion: The installed version of the app.
/// - appStoreVersion: The App Store version of the app.
/// - Returns: The type of update in relation to the verison of the app that is installed.
static func parseForUpdate(forInstalledVersion installedVersion: String?,
andAppStoreVersion appStoreVersion: String?) -> RulesManager.UpdateType {
guard let installedVersion = installedVersion,
let appStoreVersion = appStoreVersion else {
return .unknown
}
let oldVersion = split(version: installedVersion)
let newVersion = split(version: appStoreVersion)
guard let newVersionFirst = newVersion.first,
let oldVersionFirst = oldVersion.first else {
return .unknown
}
if newVersionFirst > oldVersionFirst { // A.b.c.d
return .major
} else if newVersion.count > 1 && (oldVersion.count <= 1 || newVersion[1] > oldVersion[1]) { // a.B.c.d
return .minor
} else if newVersion.count > 2 && (oldVersion.count <= 2 || newVersion[2] > oldVersion[2]) { // a.b.C.d
return .patch
} else if newVersion.count > 3 && (oldVersion.count <= 3 || newVersion[3] > oldVersion[3]) { // a.b.c.D
return .revision
} else {
return .unknown
}
}
/// Splits a version-formatted `String into an `[Int]`.
///
/// Converts `"a.b.c.d"` into `[a, b, c, d]`.
///
/// - Parameter version: The version formatted `String`.
///
/// - Returns: An array of integers representing a version of the app.
private static func split(version: String) -> [Int] {
return version.lazy.split {$0 == "."}.map { String($0) }.map {Int($0) ?? 0}
}
}
+78
View File
@@ -0,0 +1,78 @@
//
// KnownError.swift
// Siren
//
// Created by Arthur Sabintsev on 8/6/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
/// Enumerates all potentials errors that Siren can handle.
public enum KnownError: LocalizedError {
/// Error retrieving trackId as the JSON does not contain a 'trackId' key.
case appStoreAppIDFailure
/// Error retrieving App Store data as JSON results were empty. Is your app available in the US? If not, change the `countryCode` variable to fix this error.
case appStoreDataRetrievalEmptyResults
/// Error retrieving App Store data as an error was returned.
case appStoreDataRetrievalFailure(underlyingError: Error?)
/// Error parsing App Store JSON data.
case appStoreJSONParsingFailure(underlyingError: Error)
/// The version of iOS on the device is lower than that of the one required by the app verison update.
case appStoreOSVersionUnsupported
/// Error retrieving App Store verson number as the JSON does not contain a `version` key.
case appStoreVersionArrayFailure
/// The `currentVersionReleaseDate` key is missing in the JSON payload. Please leave an issue on https://github.com/ArtSabintsev/Siren with as many details as possible.
case currentVersionReleaseDate
/// One of the iTunes URLs used in Siren is malformed. Please leave an issue on https://github.com/ArtSabintsev/Siren with as many details as possible.
case malformedURL
/// Please make sure that you have set a `Bundle Identifier` in your project.
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`
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)
/// The user has opted to skip updating their current version of the app to the current App Store version.
case skipVersionUpdate(installedVersion: String, appStoreVersion: String)
/// The localized description for each error handled by Siren.
public var localizedDescription: String {
switch self {
case .appStoreAppIDFailure:
return "\(KnownError.sirenError) Error retrieving trackId as the JSON does not contain a `trackId` key."
case .appStoreDataRetrievalFailure(let error?):
return "\(KnownError.sirenError) Error retrieving App Store data as an error was returned\nAlso, the following system level error was returned: \(error)"
case .appStoreDataRetrievalEmptyResults:
return "\(KnownError.sirenError) Error retrieving App Store data as the JSON results were empty. Is your app available in the US? If not, change the `countryCode` variable to fix this error."
case .appStoreDataRetrievalFailure(.none):
return "\(KnownError.sirenError) Error retrieving App Store data as an error was returned."
case .appStoreJSONParsingFailure(let error):
return "\(KnownError.sirenError) Error parsing App Store JSON data.\nAlso, the following system level error was returned: \(error)"
case .appStoreOSVersionUnsupported:
return "\(KnownError.sirenError) The version of iOS on the device is lower than that of the one required by the app verison update."
case .appStoreVersionArrayFailure:
return "\(KnownError.sirenError) Error retrieving App Store verson number as the JSON does not contain a `version` key."
case .currentVersionReleaseDate:
return "\(KnownError.sirenError) The `currentVersionReleaseDate` key is missing in the JSON payload. Please leave an issue on https://github.com/ArtSabintsev/Siren with as many details as possible."
case .malformedURL:
return "\(KnownError.sirenError) One of the iTunes URLs used in Siren is malformed. Please leave an issue on https://github.com/ArtSabintsev/Siren with as many details as possible."
case .missingBundleID:
return "\(KnownError.sirenError) Please make sure that you have set a `Bundle Identifier` in your project."
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)`"
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):
return "\(KnownError.sirenError) The user has opted to skip updating their current version of the app (\(installedVersion)) to the current App Store version (\(appStoreVersion))."
}
}
/// An easily identifiable prefix for all errors thrown by Siren.
private static var sirenError: String {
return "[Siren Error]"
}
}
@@ -1,16 +1,17 @@
//
// SirenViewController.swift
// SirenExample
// Siren
//
// Created by Arthur Sabintsev on 3/17/17.
// Copyright © 2017 Sabintsev iOS Projects. All rights reserved.
//
import Foundation
import UIKit
// MARK: - UIViewController Extension for Siren
/// `UIViewController` Extension for Siren
final class SirenViewController: UIViewController {
override var preferredStatusBarStyle: UIStatusBarStyle { return UIApplication.shared.statusBarStyle }
/// `UIStatusBarStyle` override.
override var preferredStatusBarStyle: UIStatusBarStyle {
return UIApplication.shared.statusBarStyle
}
}
+103 -27
View File
@@ -10,11 +10,11 @@
</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="img/gh.png"/>View on GitHub</a></p>
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -34,13 +34,7 @@
<a href="Classes/Siren.html">Siren</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</a>
<a href="Classes/SirenViewController.html">SirenViewController</a>
</li>
</ul>
</li>
@@ -48,15 +42,36 @@
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/UpdateType.html">UpdateType</a>
<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="Protocols.html">Protocols</a>
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</a>
<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>
@@ -64,16 +79,52 @@
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="Structs/APIManager.html">APIManager</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="Structs/APIManager/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
<a href="Structs/AlertConstants.html">AlertConstants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
<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>
@@ -88,13 +139,6 @@
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Siren"></a>
<a name="//apple_ref/swift/Section/Siren" class="dashAnchor"></a>
<a href="#/Siren">
<h3 class="section-name">Siren</h3>
</a>
</div>
<ul>
<li class="item">
<div>
@@ -109,7 +153,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The Siren Class. A singleton that is initialized using the <code>shared</code> constant.</p>
<p>The Siren Class.</p>
<a href="Classes/Siren.html" class="slightly-smaller">See more</a>
</div>
@@ -117,7 +161,39 @@
<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">final</span> <span class="kd">class</span> <span class="kt">Siren</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Siren</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</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>
@@ -129,8 +205,8 @@
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 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>
+715 -474
View File
File diff suppressed because it is too large Load Diff
+14 -21
View File
@@ -14,8 +14,7 @@
<a title="AlertType Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="../../img/gh.png"/>View on GitHub</a></p>
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -65,16 +64,22 @@
<a href="../../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="../../Structs/AlertMessaging.html">AlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="../../Structs/AlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenError.html">SirenError</a>
<a href="../../Structs/CapturedError.html">CapturedError</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenError/Known.html"> Known</a>
<a href="../../Structs/CapturedError/Known.html"> Known</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/LookupModel.html">LookupModel</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/LookupModel/Results.html"> Results</a>
</li>
</ul>
</li>
@@ -123,10 +128,6 @@
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -154,10 +155,6 @@
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -185,10 +182,6 @@
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -202,7 +195,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Doesn&rsquo;t show the alert, but instead returns a localized message
<p>Doesn&rsquo;t show the alert, but instead returns a localized message
for use in a custom UI within the sirenDidDetectNewVersionWithoutAlert() delegate method.</p>
</div>
@@ -222,8 +215,8 @@ for use in a custom UI within the sirenDidDetectNewVersionWithoutAlert() delegat
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2018-11-17)</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>
</section>
</article>
</div>
+56 -215
View File
@@ -14,8 +14,7 @@
<a title="LanguageType Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="../../img/gh.png"/>View on GitHub</a></p>
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -65,16 +64,22 @@
<a href="../../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="../../Structs/AlertMessaging.html">AlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="../../Structs/AlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenError.html">SirenError</a>
<a href="../../Structs/CapturedError.html">CapturedError</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenError/Known.html"> Known</a>
<a href="../../Structs/CapturedError/Known.html"> Known</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/LookupModel.html">LookupModel</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/LookupModel/Results.html"> Results</a>
</li>
</ul>
</li>
@@ -86,7 +91,7 @@
<h1>LanguageType</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">LanguageType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">LanguageType</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
@@ -112,7 +117,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Arabic</p>
</div>
<div class="declaration">
@@ -126,10 +131,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -143,7 +144,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Armenian</p>
</div>
<div class="declaration">
@@ -157,10 +158,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -174,7 +171,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Basque</p>
</div>
<div class="declaration">
@@ -188,10 +185,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -205,7 +198,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Simplified Chinese</p>
</div>
<div class="declaration">
@@ -219,10 +212,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -236,7 +225,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Traditional Chinese</p>
</div>
<div class="declaration">
@@ -250,10 +239,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -267,7 +252,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Croatian</p>
</div>
<div class="declaration">
@@ -281,10 +266,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -298,7 +279,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Czech</p>
</div>
<div class="declaration">
@@ -312,10 +293,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -329,7 +306,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Danish</p>
</div>
<div class="declaration">
@@ -343,10 +320,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -360,7 +333,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Dutch</p>
</div>
<div class="declaration">
@@ -374,10 +347,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -391,7 +360,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>English</p>
</div>
<div class="declaration">
@@ -405,10 +374,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -422,7 +387,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Estonian</p>
</div>
<div class="declaration">
@@ -436,10 +401,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -453,7 +414,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Finnish</p>
</div>
<div class="declaration">
@@ -467,10 +428,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -484,7 +441,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>French</p>
</div>
<div class="declaration">
@@ -498,10 +455,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -515,7 +468,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>German</p>
</div>
<div class="declaration">
@@ -529,10 +482,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -546,7 +495,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Greek</p>
</div>
<div class="declaration">
@@ -560,10 +509,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -577,7 +522,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Hebrew</p>
</div>
<div class="declaration">
@@ -591,10 +536,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -608,7 +549,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Hungarian</p>
</div>
<div class="declaration">
@@ -622,10 +563,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -639,7 +576,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Indonesian</p>
</div>
<div class="declaration">
@@ -653,10 +590,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -670,7 +603,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Italian</p>
</div>
<div class="declaration">
@@ -684,10 +617,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -701,7 +630,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Japanese</p>
</div>
<div class="declaration">
@@ -715,10 +644,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -732,7 +657,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Korean</p>
</div>
<div class="declaration">
@@ -746,10 +671,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -763,7 +684,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Latvian</p>
</div>
<div class="declaration">
@@ -777,10 +698,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -794,7 +711,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Lithuanian</p>
</div>
<div class="declaration">
@@ -808,10 +725,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -825,7 +738,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Malaysian</p>
</div>
<div class="declaration">
@@ -839,10 +752,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -856,7 +765,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Norwegian</p>
</div>
<div class="declaration">
@@ -870,10 +779,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -887,7 +792,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Persian</p>
</div>
<div class="declaration">
@@ -901,10 +806,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -918,7 +819,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Persian (Afghanistan)</p>
</div>
<div class="declaration">
@@ -932,10 +833,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -949,7 +846,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Persian (Iran)</p>
</div>
<div class="declaration">
@@ -963,10 +860,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -980,7 +873,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Polish</p>
</div>
<div class="declaration">
@@ -994,10 +887,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1011,7 +900,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Portuguese (Brazil)</p>
</div>
<div class="declaration">
@@ -1025,10 +914,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1042,7 +927,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Portuguese (Portugal)</p>
</div>
<div class="declaration">
@@ -1056,10 +941,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1073,7 +954,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Russian</p>
</div>
<div class="declaration">
@@ -1087,10 +968,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1104,7 +981,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Serbian (Cyrillic)</p>
</div>
<div class="declaration">
@@ -1118,10 +995,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1135,7 +1008,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Serbian (Latin)</p>
</div>
<div class="declaration">
@@ -1149,10 +1022,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1166,7 +1035,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Slovenian</p>
</div>
<div class="declaration">
@@ -1180,10 +1049,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1197,7 +1062,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Spanish</p>
</div>
<div class="declaration">
@@ -1211,10 +1076,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1228,7 +1089,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Swedish</p>
</div>
<div class="declaration">
@@ -1242,10 +1103,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1259,7 +1116,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Thai</p>
</div>
<div class="declaration">
@@ -1273,10 +1130,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1290,7 +1143,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Turkish</p>
</div>
<div class="declaration">
@@ -1304,10 +1157,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1321,7 +1170,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Urdu</p>
</div>
<div class="declaration">
@@ -1335,10 +1184,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1352,7 +1197,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Ukranian</p>
</div>
<div class="declaration">
@@ -1366,10 +1211,6 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -1383,7 +1224,7 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Vietnamese</p>
</div>
<div class="declaration">
@@ -1402,8 +1243,8 @@ by setting the forceLanguageLocalization property before calling checkVersion()<
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2018-11-17)</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>
</section>
</article>
</div>
+14 -17
View File
@@ -14,8 +14,7 @@
<a title="VersionCheckType Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="../../img/gh.png"/>View on GitHub</a></p>
<p><a href="../../index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -65,16 +64,22 @@
<a href="../../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="../../Structs/AlertMessaging.html">AlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="../../Structs/AlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenError.html">SirenError</a>
<a href="../../Structs/CapturedError.html">CapturedError</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SirenError/Known.html"> Known</a>
<a href="../../Structs/CapturedError/Known.html"> Known</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/LookupModel.html">LookupModel</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/LookupModel/Results.html"> Results</a>
</li>
</ul>
</li>
@@ -86,7 +91,7 @@
<h1>VersionCheckType</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">VersionCheckType</span><span class="p">:</span> <span class="kt">Int</span></code></pre>
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">VersionCheckType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
</div>
</div>
@@ -123,10 +128,6 @@
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -154,10 +155,6 @@
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -190,8 +187,8 @@
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2018-11-17)</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>
</section>
</article>
</div>
+188
View File
@@ -0,0 +1,188 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>SirenViewController Class 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/Class/SirenViewController" class="dashAnchor"></a>
<a title="SirenViewController Class 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" />
SirenViewController Class 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>SirenViewController</h1>
<div class="declaration">
<div class="language">
<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>
<p><code>UIViewController</code> Extension for Siren</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:@M@Siren@objc(cs)SirenViewController(py)preferredStatusBarStyle"></a>
<a name="//apple_ref/swift/Property/preferredStatusBarStyle" class="dashAnchor"></a>
<a class="token" href="#/c:@M@Siren@objc(cs)SirenViewController(py)preferredStatusBarStyle">preferredStatusBarStyle</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>UIStatusBarStyle</code> override.</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">override</span> <span class="k">var</span> <span class="nv">preferredStatusBarStyle</span><span class="p">:</span> <span class="kt">UIStatusBarStyle</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>&copy; 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>
+145 -35
View File
@@ -10,11 +10,11 @@
</head>
<body>
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="img/gh.png"/>View on GitHub</a></p>
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -34,13 +34,7 @@
<a href="Classes/Siren.html">Siren</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</a>
<a href="Classes/SirenViewController.html">SirenViewController</a>
</li>
</ul>
</li>
@@ -48,15 +42,36 @@
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/UpdateType.html">UpdateType</a>
<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="Protocols.html">Protocols</a>
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/SirenDelegate.html">SirenDelegate</a>
<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>
@@ -64,16 +79,52 @@
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="Structs/APIManager.html">APIManager</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="Structs/APIManager/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
<a href="Structs/AlertConstants.html">AlertConstants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
<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>
@@ -92,9 +143,9 @@
<li class="item">
<div>
<code>
<a name="/s:5Siren10UpdateTypeO"></a>
<a name="//apple_ref/swift/Enum/UpdateType" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10UpdateTypeO">UpdateType</a>
<a name="/s:5Siren11AlertActionO"></a>
<a name="//apple_ref/swift/Enum/AlertAction" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren11AlertActionO">AlertAction</a>
</code>
</div>
<div class="height-container">
@@ -102,26 +153,85 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>MARK - Siren UpdateType
<code>UpdateType</code> defines what kind of update is available
It is used as parameter if user wants to use
custom alert to inform the user about an update.</p>
<p>The <code>UIAlertController</code> button that was pressed upon being presented an update alert.</p>
<ul>
<li>major: Major release available: A.b.c.d</li>
<li>minor: Minor release available: a.B.c.d</li>
<li>patch: Patch release available: a.b.C.d</li>
<li>revision: Revision release available: a.b.c.D</li>
<li>unknown: No information available about the update</li>
</ul>
<a href="Enums/UpdateType.html" class="slightly-smaller">See more</a>
<a href="Enums/AlertAction.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">UpdateType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AlertAction</span></code></pre>
</div>
</div>
</section>
</div>
</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&rsquo;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">
<div>
<code>
<a name="/s:5Siren10KnownErrorO"></a>
<a name="//apple_ref/swift/Enum/KnownError" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO">KnownError</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Enumerates all potentials errors that Siren can handle.</p>
<a href="Enums/KnownError.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">KnownError</span> <span class="p">:</span> <span class="kt">LocalizedError</span></code></pre>
</div>
</div>
@@ -133,8 +243,8 @@ custom alert to inform the user about an update.</p>
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 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>
+269
View File
@@ -0,0 +1,269 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>AlertAction 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/AlertAction" class="dashAnchor"></a>
<a title="AlertAction 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" />
AlertAction 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>AlertAction</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">AlertAction</span></code></pre>
</div>
</div>
<p>The <code>UIAlertController</code> button that was pressed upon being presented an update alert.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren11AlertActionO8appStoreyA2CmF"></a>
<a name="//apple_ref/swift/Element/appStore" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren11AlertActionO8appStoreyA2CmF">appStore</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The user clicked on the <code>Update</code> option, which took them to the app&rsquo;s App Store page.</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">appStore</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren11AlertActionO8nextTimeyA2CmF"></a>
<a name="//apple_ref/swift/Element/nextTime" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren11AlertActionO8nextTimeyA2CmF">nextTime</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The user clicked on the <code>Next Time</code> option, which dismissed the 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">case</span> <span class="n">nextTime</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren11AlertActionO4skipyA2CmF"></a>
<a name="//apple_ref/swift/Element/skip" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren11AlertActionO4skipyA2CmF">skip</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The user clicked on the <code>Skip this version</code> option, which dismissed the 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">case</span> <span class="n">skip</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren11AlertActionO7unknownyA2CmF"></a>
<a name="//apple_ref/swift/Element/unknown" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren11AlertActionO7unknownyA2CmF">unknown</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>(Default) The user never chose an option. This is returned when an error is 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="k">case</span> <span class="n">unknown</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+566
View File
@@ -0,0 +1,566 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>KnownError 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/KnownError" class="dashAnchor"></a>
<a title="KnownError 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" />
KnownError 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>KnownError</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">KnownError</span> <span class="p">:</span> <span class="kt">LocalizedError</span></code></pre>
</div>
</div>
<p>Enumerates all potentials errors that Siren can handle.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO20appStoreAppIDFailureyA2CmF"></a>
<a name="//apple_ref/swift/Element/appStoreAppIDFailure" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO20appStoreAppIDFailureyA2CmF">appStoreAppIDFailure</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Error retrieving trackId as the JSON does not contain a &lsquo;trackId&rsquo; key.</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">appStoreAppIDFailure</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO33appStoreDataRetrievalEmptyResultsyA2CmF"></a>
<a name="//apple_ref/swift/Element/appStoreDataRetrievalEmptyResults" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO33appStoreDataRetrievalEmptyResultsyA2CmF">appStoreDataRetrievalEmptyResults</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Error retrieving App Store data as JSON results were empty. Is your app available in the US? If not, change the <code>countryCode</code> variable to fix this error.</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">appStoreDataRetrievalEmptyResults</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO28appStoreDataRetrievalFailureyACs0C0_pSg_tcACmF"></a>
<a name="//apple_ref/swift/Element/appStoreDataRetrievalFailure(underlyingError:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO28appStoreDataRetrievalFailureyACs0C0_pSg_tcACmF">appStoreDataRetrievalFailure(underlyingError:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Error retrieving App Store data as an error was returned.</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="nf">appStoreDataRetrievalFailure</span><span class="p">(</span><span class="nv">underlyingError</span><span class="p">:</span> <span class="kt">Error</span><span class="p">?)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO26appStoreJSONParsingFailureyACs0C0_p_tcACmF"></a>
<a name="//apple_ref/swift/Element/appStoreJSONParsingFailure(underlyingError:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO26appStoreJSONParsingFailureyACs0C0_p_tcACmF">appStoreJSONParsingFailure(underlyingError:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Error parsing App Store JSON data.</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="nf">appStoreJSONParsingFailure</span><span class="p">(</span><span class="nv">underlyingError</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO28appStoreOSVersionUnsupportedyA2CmF"></a>
<a name="//apple_ref/swift/Element/appStoreOSVersionUnsupported" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO28appStoreOSVersionUnsupportedyA2CmF">appStoreOSVersionUnsupported</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The version of iOS on the device is lower than that of the one required by the app verison update.</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">appStoreOSVersionUnsupported</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO27appStoreVersionArrayFailureyA2CmF"></a>
<a name="//apple_ref/swift/Element/appStoreVersionArrayFailure" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO27appStoreVersionArrayFailureyA2CmF">appStoreVersionArrayFailure</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Error retrieving App Store verson number as the JSON does not contain a <code>version</code> key.</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">appStoreVersionArrayFailure</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO25currentVersionReleaseDateyA2CmF"></a>
<a name="//apple_ref/swift/Element/currentVersionReleaseDate" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO25currentVersionReleaseDateyA2CmF">currentVersionReleaseDate</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>currentVersionReleaseDate</code> key is missing in the JSON payload. Please leave an issue on <a href="https://github.com/ArtSabintsev/Siren">https://github.com/ArtSabintsev/Siren</a> with as many details as possible.</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">currentVersionReleaseDate</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO12malformedURLyA2CmF"></a>
<a name="//apple_ref/swift/Element/malformedURL" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO12malformedURLyA2CmF">malformedURL</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>One of the iTunes URLs used in Siren is malformed. Please leave an issue on <a href="https://github.com/ArtSabintsev/Siren">https://github.com/ArtSabintsev/Siren</a> with as many details as possible.</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">malformedURL</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO15missingBundleIDyA2CmF"></a>
<a name="//apple_ref/swift/Element/missingBundleID" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO15missingBundleIDyA2CmF">missingBundleID</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Please make sure that you have set a <code>Bundle Identifier</code> in your project.</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">missingBundleID</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO17noUpdateAvailableyA2CmF"></a>
<a name="//apple_ref/swift/Element/noUpdateAvailable" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO17noUpdateAvailableyA2CmF">noUpdateAvailable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>No new update available.</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">noUpdateAvailable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO16recentlyPromptedyA2CmF"></a>
<a name="//apple_ref/swift/Element/recentlyPrompted" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO16recentlyPromptedyA2CmF">recentlyPrompted</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<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>
</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">recentlyPrompted</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren10KnownErrorO15releasedTooSoonyACSi_SitcACmF"></a>
<a name="//apple_ref/swift/Element/releasedTooSoon(daysSinceRelease:releasedForDays:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO15releasedTooSoonyACSi_SitcACmF">releasedTooSoon(daysSinceRelease: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 app has been released for X days, but Siren cannot prompt the user until Y (where Y &gt; X) days have passed.</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="nf">releasedTooSoon</span><span class="p">(</span><span class="nv">daysSinceRelease</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">releasedForDays</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:5Siren10KnownErrorO17skipVersionUpdateyACSS_SStcACmF"></a>
<a name="//apple_ref/swift/Element/skipVersionUpdate(installedVersion:appStoreVersion:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO17skipVersionUpdateyACSS_SStcACmF">skipVersionUpdate(installedVersion:appStoreVersion:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The user has opted to skip updating their current version of the app to the current App Store version.</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="nf">skipVersionUpdate</span><span class="p">(</span><span class="nv">installedVersion</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appStoreVersion</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>
<a name="/s:5Siren10KnownErrorO20localizedDescriptionSSvp"></a>
<a name="//apple_ref/swift/Property/localizedDescription" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren10KnownErrorO20localizedDescriptionSSvp">localizedDescription</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The localized description for each error handled 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">public</span> <span class="k">var</span> <span class="nv">localizedDescription</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>
<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>&copy; 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>
+224
View File
@@ -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&rsquo;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&rsquo;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&rsquo;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>&copy; 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>
+21 -32
View File
@@ -14,8 +14,7 @@
<a title="UpdateType Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="../img/gh.png"/>View on GitHub</a></p>
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -65,16 +64,22 @@
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="../Structs/AlertMessaging.html">AlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="../Structs/AlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError.html">SirenError</a>
<a href="../Structs/CapturedError.html">CapturedError</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError/Known.html"> Known</a>
<a href="../Structs/CapturedError/Known.html"> Known</a>
</li>
<li class="nav-group-task">
<a href="../Structs/LookupModel.html">LookupModel</a>
</li>
<li class="nav-group-task">
<a href="../Structs/LookupModel/Results.html"> Results</a>
</li>
</ul>
</li>
@@ -86,12 +91,12 @@
<h1>UpdateType</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">UpdateType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">UpdateType</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
<p>MARK - Siren UpdateType
<code>UpdateType</code> defines what kind of update is available
<code>UpdateType</code> defines what kind of update is available.
It is used as parameter if user wants to use
custom alert to inform the user about an update.</p>
@@ -100,7 +105,7 @@ custom alert to inform the user about an update.</p>
<li>minor: Minor release available: a.B.c.d</li>
<li>patch: Patch release available: a.b.C.d</li>
<li>revision: Revision release available: a.b.c.D</li>
<li>unknown: No information available about the update</li>
<li>unknown: No information available about the update.</li>
</ul>
</section>
@@ -120,7 +125,7 @@ custom alert to inform the user about an update.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Major release available: A.b.c.d</p>
</div>
<div class="declaration">
@@ -134,10 +139,6 @@ custom alert to inform the user about an update.</p>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -151,7 +152,7 @@ custom alert to inform the user about an update.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Minor release available: a.B.c.d</p>
</div>
<div class="declaration">
@@ -165,10 +166,6 @@ custom alert to inform the user about an update.</p>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -182,7 +179,7 @@ custom alert to inform the user about an update.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Patch release available: a.b.C.d</p>
</div>
<div class="declaration">
@@ -196,10 +193,6 @@ custom alert to inform the user about an update.</p>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -213,7 +206,7 @@ custom alert to inform the user about an update.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Revision release available: a.b.c.D</p>
</div>
<div class="declaration">
@@ -227,10 +220,6 @@ custom alert to inform the user about an update.</p>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
@@ -244,7 +233,7 @@ custom alert to inform the user about an update.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>No information available about the update.</p>
</div>
<div class="declaration">
@@ -263,8 +252,8 @@ custom alert to inform the user about an update.</p>
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2018-11-17)</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>
</section>
</article>
</div>
+275
View File
@@ -0,0 +1,275 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions 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/Section/Extensions" class="dashAnchor"></a>
<a title="Extensions 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" />
Extensions 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>Extensions</h1>
<p>The following extensions are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSBundle"></a>
<a name="//apple_ref/swift/Extension/Bundle" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSBundle">Bundle</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Extensions/Bundle.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">class</span> <span class="kt">Bundle</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:10Foundation4DateV"></a>
<a name="//apple_ref/swift/Extension/Date" class="dashAnchor"></a>
<a class="token" href="#/s:10Foundation4DateV">Date</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Extensions/Date.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">Date</span> <span class="p">:</span> <span class="kt">ReferenceConvertible</span><span class="p">,</span> <span class="kt">Comparable</span><span class="p">,</span> <span class="kt">Equatable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)UIAlertController"></a>
<a name="//apple_ref/swift/Extension/UIAlertController" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)UIAlertController">UIAlertController</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Extensions/UIAlertController.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">class</span> <span class="kt">UIAlertController</span> <span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSUserDefaults"></a>
<a name="//apple_ref/swift/Extension/UserDefaults" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSUserDefaults">UserDefaults</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Extensions/UserDefaults.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">class</span> <span class="kt">UserDefaults</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+436
View File
@@ -0,0 +1,436 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Bundle Extension 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/Extension/Bundle" class="dashAnchor"></a>
<a title="Bundle Extension 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" />
Bundle Extension 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>Bundle</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Bundle</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE9ConstantsV"></a>
<a name="//apple_ref/swift/Struct/Constants" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE9ConstantsV">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>Bundle</code> extension.</p>
<a href="../Extensions/Bundle/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">struct</span> <span class="kt">Constants</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE7versionSSSgyFZ"></a>
<a name="//apple_ref/swift/Method/version()" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE7versionSSSgyFZ">version()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Fetches the current verison of 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">final</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">version</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>The current installed version of the app.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE15localizedString6forKey20andForceLocalizationS2S_AC0I0V8LanguageOSgtFZ"></a>
<a name="//apple_ref/swift/Method/localizedString(forKey:andForceLocalization:)" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE15localizedString6forKey20andForceLocalizationS2S_AC0I0V8LanguageOSgtFZ">localizedString(forKey:andForceLocalization:)</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 localized string for a given default string.</p>
<p>By default, the English language localization is used.
If the device&rsquo;s localization is set to another locale, that local&rsquo;s language is used if it&rsquo;s supported by Siren.
If <code>forcedLanguage</code> is set to <code>true</code>, the chosen language is shown for all devices, irrespective of their device&rsquo;s localization.</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">final</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">localizedString</span><span class="p">(</span><span class="n">forKey</span> <span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">andForceLocalization</span> <span class="nv">forcedLanguage</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">-&gt;</span> <span class="kt">String</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>key</em>
</code>
</td>
<td>
<div>
<p>The default string used to search the localization table for a specific translation.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>forcedLanguage</em>
</code>
</td>
<td>
<div>
<p>Returns</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The localized string for a given key.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE19bestMatchingAppNameSSyFZ"></a>
<a name="//apple_ref/swift/Method/bestMatchingAppName()" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE19bestMatchingAppNameSSyFZ">bestMatchingAppName()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The appropriate name for the app to be displayed in the update alert.</p>
<p>Siren checks <code>CFBundleDisplayName</code> first. It then falls back to
to <code>kCFBundleNameKey</code> and ultimately to an empty string
if the aforementioned values are nil.</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">final</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">bestMatchingAppName</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>The name of the app.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE15sirenBundlePath33_9C775CF4CEC7A5F21E625F58C71BDF22LLSSSgyFZ"></a>
<a name="//apple_ref/swift/Method/sirenBundlePath()" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE15sirenBundlePath33_9C775CF4CEC7A5F21E625F58C71BDF22LLSSSgyFZ">sirenBundlePath()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The path to Siren&rsquo;s localization <code>Bundle</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">final</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">sirenBundlePath</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>The bundle&rsquo;s path or <code>nil</code>.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE21sirenForcedBundlePath33_9C775CF4CEC7A5F21E625F58C71BDF22LL25forceLanguageLocalizationSSSgAC0R0V0Q0O_tFZ"></a>
<a name="//apple_ref/swift/Method/sirenForcedBundlePath(forceLanguageLocalization:)" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE21sirenForcedBundlePath33_9C775CF4CEC7A5F21E625F58C71BDF22LL25forceLanguageLocalizationSSSgAC0R0V0Q0O_tFZ">sirenForcedBundlePath(forceLanguageLocalization:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The path for a particular language localizationin Siren&rsquo;s localization <code>Bundle</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">final</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">sirenForcedBundlePath</span><span class="p">(</span><span class="nv">forceLanguageLocalization</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">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>forceLanguageLocalization</em>
</code>
</td>
<td>
<div>
<p>The language localization that should be searched for in Siren&rsquo;s localization <code>bundle</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The path to the forced language localization.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE14deviceLanguage33_9C775CF4CEC7A5F21E625F58C71BDF22LLAC12LocalizationV0D0OSgyFZ"></a>
<a name="//apple_ref/swift/Method/deviceLanguage()" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE14deviceLanguage33_9C775CF4CEC7A5F21E625F58C71BDF22LLAC12LocalizationV0D0OSgyFZ">deviceLanguage()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The user&rsquo;s preferred language based on their device&rsquo;s localization.</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">final</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">deviceLanguage</span><span class="p">()</span> <span class="o">-&gt;</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></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>The user&rsquo;s preferred language.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+323
View File
@@ -0,0 +1,323 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Constants Structure 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/Struct/Constants" class="dashAnchor"></a>
<a title="Constants Structure 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" />
Constants Structure 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>Constants</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">Constants</span></code></pre>
</div>
</div>
<p>Constants used in the <code>Bundle</code> extension.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:So8NSBundleC5SirenE9ConstantsV15bundleExtensionSSvpZ"></a>
<a name="//apple_ref/swift/Variable/bundleExtension" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE9ConstantsV15bundleExtensionSSvpZ">bundleExtension</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Constant for the <code>.bundle</code> file extension.</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">let</span> <span class="nv">bundleExtension</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:So8NSBundleC5SirenE9ConstantsV11displayNameSSvpZ"></a>
<a name="//apple_ref/swift/Variable/displayName" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE9ConstantsV11displayNameSSvpZ">displayName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Constant for <code>CFBundleDisplayName</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">static</span> <span class="k">let</span> <span class="nv">displayName</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:So8NSBundleC5SirenE9ConstantsV19englishLocalizationSSvpZ"></a>
<a name="//apple_ref/swift/Variable/englishLocalization" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE9ConstantsV19englishLocalizationSSvpZ">englishLocalization</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Constant for the default US English localization.</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">let</span> <span class="nv">englishLocalization</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:So8NSBundleC5SirenE9ConstantsV16projectExtensionSSvpZ"></a>
<a name="//apple_ref/swift/Variable/projectExtension" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE9ConstantsV16projectExtensionSSvpZ">projectExtension</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Constant for the project file extension.</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">let</span> <span class="nv">projectExtension</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:So8NSBundleC5SirenE9ConstantsV18shortVersionStringSSvpZ"></a>
<a name="//apple_ref/swift/Variable/shortVersionString" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE9ConstantsV18shortVersionStringSSvpZ">shortVersionString</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Constant for <code>CFBundleShortVersionString</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">static</span> <span class="k">let</span> <span class="nv">shortVersionString</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:So8NSBundleC5SirenE9ConstantsV5tableSSvpZ"></a>
<a name="//apple_ref/swift/Variable/table" class="dashAnchor"></a>
<a class="token" href="#/s:So8NSBundleC5SirenE9ConstantsV5tableSSvpZ">table</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Constant for the localization table.</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">let</span> <span class="nv">table</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+260
View File
@@ -0,0 +1,260 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Date Extension 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/Extension/Date" class="dashAnchor"></a>
<a title="Date Extension 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" />
Date Extension 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>Date</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">Date</span> <span class="p">:</span> <span class="kt">ReferenceConvertible</span><span class="p">,</span> <span class="kt">Comparable</span><span class="p">,</span> <span class="kt">Equatable</span></code></pre>
</div>
</div>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:10Foundation4DateV5SirenE4days5sinceSiAC_tFZ"></a>
<a name="//apple_ref/swift/Method/days(since:)" class="dashAnchor"></a>
<a class="token" href="#/s:10Foundation4DateV5SirenE4days5sinceSiAC_tFZ">days(since:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The amount of days passed from a specific source date.</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="kd">func</span> <span class="nf">days</span><span class="p">(</span><span class="n">since</span> <span class="nv">date</span><span class="p">:</span> <span class="kt">Date</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Int</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>date</em>
</code>
</td>
<td>
<div>
<p>The source date.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The amount of days passed since the source date.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10Foundation4DateV5SirenE4days5sinceSiSgSS_tFZ"></a>
<a name="//apple_ref/swift/Method/days(since:)" class="dashAnchor"></a>
<a class="token" href="#/s:10Foundation4DateV5SirenE4days5sinceSiSgSS_tFZ">days(since:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The amount of days passed from a specific source date string.</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="kd">func</span> <span class="nf">days</span><span class="p">(</span><span class="n">since</span> <span class="nv">dateString</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>dateString</em>
</code>
</td>
<td>
<div>
<p>The source date string.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The amount of days passed since the source date.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+252
View File
@@ -0,0 +1,252 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>UIAlertController Extension 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/Extension/UIAlertController" class="dashAnchor"></a>
<a title="UIAlertController Extension 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" />
UIAlertController Extension 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>UIAlertController</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">UIAlertController</span> <span class="p">:</span> <span class="kt">UIViewController</span></code></pre>
</div>
</div>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:So17UIAlertControllerC5SirenE4show6windowySo8UIWindowC_tF"></a>
<a name="//apple_ref/swift/Method/show(window:)" class="dashAnchor"></a>
<a class="token" href="#/s:So17UIAlertControllerC5SirenE4show6windowySo8UIWindowC_tF">show(window:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Presents Siren&rsquo;s <code>UIAlertController</code> in a new <code>UIWindow</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">func</span> <span class="nf">show</span><span class="p">(</span><span class="nv">window</span><span class="p">:</span> <span class="kt">UIWindow</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>window</em>
</code>
</td>
<td>
<div>
<p>The <code>UIWindow</code> that <em>should</em> reference Siren&rsquo;s <code>UIAlertController</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So17UIAlertControllerC5SirenE4hide6windowySo8UIWindowC_tF"></a>
<a name="//apple_ref/swift/Method/hide(window:)" class="dashAnchor"></a>
<a class="token" href="#/s:So17UIAlertControllerC5SirenE4hide6windowySo8UIWindowC_tF">hide(window:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Hides Siren&rsquo;s <code>UIAlertController</code> within a given window.</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">hide</span><span class="p">(</span><span class="nv">window</span><span class="p">:</span> <span class="kt">UIWindow</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>window</em>
</code>
</td>
<td>
<div>
<p>The <code>UIWindow</code> that references Siren&rsquo;s <code>UIAlertController</code>.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+242
View File
@@ -0,0 +1,242 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>UserDefaults Extension 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/Extension/UserDefaults" class="dashAnchor"></a>
<a title="UserDefaults Extension 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" />
UserDefaults Extension 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>UserDefaults</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">UserDefaults</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO"></a>
<a name="//apple_ref/swift/Enum/SirenKeys" class="dashAnchor"></a>
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO">SirenKeys</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren-specific <code>UserDefaults</code> Keys</p>
<a href="../Extensions/UserDefaults/SirenKeys.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">SirenKeys</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:So14NSUserDefaultsC5SirenE20storedSkippedVersionSSSgvpZ"></a>
<a name="//apple_ref/swift/Variable/storedSkippedVersion" class="dashAnchor"></a>
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE20storedSkippedVersionSSSgvpZ">storedSkippedVersion</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 storing a version that the user wants to skip updating.</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">storedSkippedVersion</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:So14NSUserDefaultsC5SirenE21alertPresentationDate10Foundation0F0VSgvpZ"></a>
<a name="//apple_ref/swift/Variable/alertPresentationDate" class="dashAnchor"></a>
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE21alertPresentationDate10Foundation0F0VSgvpZ">alertPresentationDate</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 the last time the user was presented a version 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="kd">static</span> <span class="k">var</span> <span class="nv">alertPresentationDate</span><span class="p">:</span> <span class="kt">Date</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>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+243
View File
@@ -0,0 +1,243 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>SirenKeys 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/SirenKeys" class="dashAnchor"></a>
<a title="SirenKeys 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" />
SirenKeys 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>SirenKeys</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">private</span> <span class="kd">enum</span> <span class="kt">SirenKeys</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
<p>Siren-specific <code>UserDefaults</code> Keys</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO37PerformVersionCheckOnSubsequentLaunchyA2FmF"></a>
<a name="//apple_ref/swift/Element/PerformVersionCheckOnSubsequentLaunch" class="dashAnchor"></a>
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO37PerformVersionCheckOnSubsequentLaunchyA2FmF">PerformVersionCheckOnSubsequentLaunch</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Key that notifies Siren to perform a version check and present
the Siren alert the next time the user launches 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="k">case</span> <span class="kt">PerformVersionCheckOnSubsequentLaunch</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO22StoredVersionCheckDateyA2FmF"></a>
<a name="//apple_ref/swift/Element/StoredVersionCheckDate" class="dashAnchor"></a>
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO22StoredVersionCheckDateyA2FmF">StoredVersionCheckDate</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Key that stores the timestamp of the last version check.</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="kt">StoredVersionCheckDate</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO20StoredSkippedVersionyA2FmF"></a>
<a name="//apple_ref/swift/Element/StoredSkippedVersion" class="dashAnchor"></a>
<a class="token" href="#/s:So14NSUserDefaultsC5SirenE0C4Keys33_0884631E60E090AA276701A736B793BBLLO20StoredSkippedVersionyA2FmF">StoredSkippedVersion</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Key that stores the version that a user decided to skip.</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="kt">StoredSkippedVersion</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+33 -26
View File
@@ -10,11 +10,11 @@
</head>
<body>
<a name="//apple_ref/swift/Section/Protocols" class="dashAnchor"></a>
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="img/gh.png"/>View on GitHub</a></p>
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -33,23 +33,6 @@
<li class="nav-group-task">
<a href="Classes/Siren.html">Siren</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
@@ -64,16 +47,40 @@
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="Structs/AlertMessaging.html">AlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="Structs/AlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError.html">SirenError</a>
<a href="Structs/CapturedError.html">CapturedError</a>
</li>
<li class="nav-group-task">
<a href="Structs/SirenError/Known.html"> Known</a>
<a href="Structs/CapturedError/Known.html"> Known</a>
</li>
<li class="nav-group-task">
<a href="Structs/Constants.html">Constants</a>
</li>
<li class="nav-group-task">
<a href="Structs/Constants/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="Structs/Constants/UpdateType.html"> UpdateType</a>
</li>
<li class="nav-group-task">
<a href="Structs/Constants/VersionCheckFrequency.html"> VersionCheckFrequency</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/Results.html"> Results</a>
</li>
</ul>
</li>
@@ -117,7 +124,7 @@
<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">protocol</span> <span class="kt">SirenDelegate</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SirenDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
@@ -129,8 +136,8 @@
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2018-11-18)</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>
</section>
</article>
</div>
+252 -168
View File
@@ -14,8 +14,7 @@
<a title="SirenDelegate Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Siren Docs</a> (42% documented)</p>
<p class="header-right"><a href="https://github.com/artsabintsev/siren"><img src="../img/gh.png"/>View on GitHub</a></p>
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
@@ -34,23 +33,6 @@
<li class="nav-group-task">
<a href="../Classes/Siren.html">Siren</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/VersionCheckType.html"> VersionCheckType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Siren/LanguageType.html"> LanguageType</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/UpdateType.html">UpdateType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
@@ -65,16 +47,40 @@
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/SirenAlertMessaging.html">SirenAlertMessaging</a>
<a href="../Structs/AlertMessaging.html">AlertMessaging</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenAlertMessaging/Constants.html"> Constants</a>
<a href="../Structs/AlertMessaging/Constants.html"> Constants</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError.html">SirenError</a>
<a href="../Structs/CapturedError.html">CapturedError</a>
</li>
<li class="nav-group-task">
<a href="../Structs/SirenError/Known.html"> Known</a>
<a href="../Structs/CapturedError/Known.html"> Known</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Constants.html">Constants</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Constants/AlertType.html"> AlertType</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Constants/UpdateType.html"> UpdateType</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Constants/VersionCheckFrequency.html"> VersionCheckFrequency</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/Results.html"> Results</a>
</li>
</ul>
</li>
@@ -86,7 +92,7 @@
<h1>SirenDelegate</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SirenDelegate</span><span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SirenDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
@@ -99,9 +105,9 @@
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP24sirenDidShowUpdateDialogyA2AC9AlertTypeO05alertI0_tF"></a>
<a name="//apple_ref/swift/Method/sirenDidShowUpdateDialog(alertType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP24sirenDidShowUpdateDialogyA2AC9AlertTypeO05alertI0_tF">sirenDidShowUpdateDialog(alertType:)</a>
<a name="/s:5Siren0A8DelegateP36sirenDidDetectNewVersionWithoutAlertySS5title_SS7messageAA9ConstantsV10UpdateTypeO06updateN0tF"></a>
<a name="//apple_ref/swift/Method/sirenDidDetectNewVersionWithoutAlert(title:message:updateType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP36sirenDidDetectNewVersionWithoutAlertySS5title_SS7messageAA9ConstantsV10UpdateTypeO06updateN0tF">sirenDidDetectNewVersionWithoutAlert(title:message:updateType:)</a>
</code>
<span class="declaration-note">
Default implementation
@@ -112,7 +118,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User presented with update dialog.</p>
<p>Siren performed a version check and did not display an alert.</p>
</div>
<h4>Default Implementation</h4>
@@ -123,7 +129,221 @@
<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">sirenDidShowUpdateDialog</span><span class="p">(</span><span class="nv">alertType</span><span class="p">:</span> <span class="kt"><a href="../Classes/Siren.html">Siren</a></span><span class="o">.</span><span class="kt">AlertType</span><span class="p">)</span></code></pre>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sirenDidDetectNewVersionWithoutAlert</span><span class="p">(</span><span class="nv">title</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">updateType</span><span class="p">:</span> <span class="kt"><a href="../Structs/Constants.html">Constants</a></span><span class="o">.</span><span class="kt">UpdateType</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP24sirenDidFailVersionCheckys5Error_p5error_tF"></a>
<a name="//apple_ref/swift/Method/sirenDidFailVersionCheck(error:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP24sirenDidFailVersionCheckys5Error_p5error_tF">sirenDidFailVersionCheck(error:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren failed to perform version check.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
Depending on the reason for failure,
a system-level error may be returned.
</div>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenDidFailVersionCheck</span><span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP24sirenDidShowUpdateDialogyAA9ConstantsV9AlertTypeO05alertJ0_tF"></a>
<a name="//apple_ref/swift/Method/sirenDidShowUpdateDialog(alertType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP24sirenDidShowUpdateDialogyAA9ConstantsV9AlertTypeO05alertJ0_tF">sirenDidShowUpdateDialog(alertType:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User presented with an update dialog.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenDidShowUpdateDialog</span><span class="p">(</span><span class="nv">alertType</span><span class="p">:</span> <span class="kt"><a href="../Structs/Constants.html">Constants</a></span><span class="o">.</span><span class="kt">AlertType</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>alertType</em>
</code>
</td>
<td>
<div>
<p>The type of alert that was presented.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP27sirenLatestVersionInstalledyyF"></a>
<a name="//apple_ref/swift/Method/sirenLatestVersionInstalled()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP27sirenLatestVersionInstalledyyF">sirenLatestVersionInstalled()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren performed a version check and the latest version was already installed.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenLatestVersionInstalled</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP50sirenNetworkCallDidReturnWithNewVersionInformationyAA11LookupModelV06lookupM0_tF"></a>
<a name="//apple_ref/swift/Method/sirenNetworkCallDidReturnWithNewVersionInformation(lookupModel:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP50sirenNetworkCallDidReturnWithNewVersionInformationyAA11LookupModelV06lookupM0_tF">sirenNetworkCallDidReturnWithNewVersionInformation(lookupModel:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Provides the decoded JSON information from a successful version check call.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenNetworkCallDidReturnWithNewVersionInformation</span><span class="p">(</span><span class="nv">lookupModel</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>lookupModel</em>
</code>
</td>
<td>
<div>
<p>The <code>Decodable</code> model representing the JSON results from the iTunes Lookup API.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP18sirenUserDidCancelyyF"></a>
<a name="//apple_ref/swift/Method/sirenUserDidCancel()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP18sirenUserDidCancelyyF">sirenUserDidCancel()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User did click on button that cancels update dialog.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenUserDidCancel</span><span class="p">()</span></code></pre>
</div>
</div>
@@ -146,7 +366,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User did click on button that launched App Store.app.</p>
<p>User did click on button that launched <q>App Store.app</q>.</p>
</div>
<h4>Default Implementation</h4>
@@ -198,149 +418,13 @@
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP18sirenUserDidCancelyyF"></a>
<a name="//apple_ref/swift/Method/sirenUserDidCancel()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP18sirenUserDidCancelyyF">sirenUserDidCancel()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>User did click on button that cancels update dialog.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenUserDidCancel</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP24sirenDidFailVersionCheckys5Error_p5error_tF"></a>
<a name="//apple_ref/swift/Method/sirenDidFailVersionCheck(error:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP24sirenDidFailVersionCheckys5Error_p5error_tF">sirenDidFailVersionCheck(error:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren failed to perform version check (may return system-level error).</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenDidFailVersionCheck</span><span class="p">(</span><span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP36sirenDidDetectNewVersionWithoutAlertySS7message_AA10UpdateTypeO06updateL0tF"></a>
<a name="//apple_ref/swift/Method/sirenDidDetectNewVersionWithoutAlert(message:updateType:)" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP36sirenDidDetectNewVersionWithoutAlertySS7message_AA10UpdateTypeO06updateL0tF">sirenDidDetectNewVersionWithoutAlert(message:updateType:)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren performed version check and did not display alert.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenDidDetectNewVersionWithoutAlert</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">updateType</span><span class="p">:</span> <span class="kt"><a href="../Enums/UpdateType.html">UpdateType</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:5Siren0A8DelegateP27sirenLatestVersionInstalledyyF"></a>
<a name="//apple_ref/swift/Method/sirenLatestVersionInstalled()" class="dashAnchor"></a>
<a class="token" href="#/s:5Siren0A8DelegateP27sirenLatestVersionInstalledyyF">sirenLatestVersionInstalled()</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Siren performed version check and latest version is installed.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</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">sirenLatestVersionInstalled</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>© 2015-2017 <a class="link" href="http://www.sabintsev.com" target="_blank" rel="external">Arthur Ariel Sabintsev</a></p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2018 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2018-11-18)</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>
</section>
</article>
</div>

Some files were not shown because too many files have changed in this diff Show More