Documentation improvements for BITAuthenticator

This commit is contained in:
Andreas Linde
2013-09-19 15:42:07 +02:00
parent b30c0df468
commit 18ab864eef
3 changed files with 5 additions and 1 deletions

View File

@@ -83,7 +83,8 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error);
* various authentication and validation mechanisms which provide different levels of authentication.
*
* This does not provide DRM or copy protection in any form. Each authentication type and validation type provide
* a different level of user authorization.
* a different level of user authorization. Validation is the process of checking against the HockeyApp server if
* the provided/existing authorization is still valid.
*
* This module automatically disables itself when running in an App Store build by default!
*
@@ -107,6 +108,8 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error);
* 3. on first launch of a new app version (`BITAuthenticatorValidationTypeOnFirstLaunch`)
* 4. every time the app becomes active (needs internet connection) (`BITAuthenticatorValidationTypeOnAppActive`)
*
* We have created a detailed guide on how to use this class: [Authenticating Users on iOS](HowTo-Authenticating-Users-on-iOS)
*
*/
@interface BITAuthenticator : BITHockeyBaseManager

View File

@@ -26,6 +26,7 @@ The main SDK class is `BITHockeyManager`. It initializes all modules and provide
- [Installation & Setup](Guide-Installation-Setup)
- [Installation & Setup Advanced](Guide-Installation-Setup-Advanced) (Using Git submodule and Xcode sub-project)
- [Authenticating Users on iOS](HowTo-Authenticating-Users-on-iOS)
- [Migration from previous SDK Versions](Guide-Migration-Kits)
- [Mac Desktop Uploader](Guide-Installation-Mac-App)