ThePain/Swiftgram
1
0
Fork 0
mirror of https://github.com/Swiftgram/Telegram-iOS.git synced 2025-12-22 14:20:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation improvements

Browse Source
This commit is contained in:
Andreas Linde
2013-09-16 12:53:40 +02:00
parent fed4684969
commit 88b50694d7
2 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Classes/BITAuthenticator.h
View File

@@ -90,21 +90,21 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error);
* Authentication is a 2 step process:
*
* 1. authenticate:
* a token is acquired depending on the authenticationType
* a token is acquired depending on the `authenticationType`
* 2. validation:
* the acquired token from step 1 is validated depending the validationType
* the acquired token from step 1 is validated depending the `validationType`
*
* There are currently 3 ways of authentication:
* There are currently 3 ways of authentication (`BITAuthenticatorAuthType`):
*
* 1. authenticate the user via email only (`BITAuthenticatorAuthTypeEmail`)
* 2. authenticate the user via email & password (`BITAuthenticatorAuthTypeEmailAndPassword`)
* 3. authenticate the device via its UDID (_Default_) (`BITAuthenticatorAuthTypeUDIDProvider`)
*
* There are currently 4 ways of validation:
* There are currently 4 ways of validation (`BITAuthenticatorValidationType`):
*
* 1. never (_Default_) (`BITAuthenticatorValidationTypeNever`)
* 2. optional (`BITAuthenticatorValidationTypeOptional`)
* 3. on first launch of a new app version(`BITAuthenticatorValidationTypeOnFirstLaunch`)
* 3. on first launch of a new app version (`BITAuthenticatorValidationTypeOnFirstLaunch`)
* 4. every time the app becomes active (needs internet connection) (`BITAuthenticatorValidationTypeOnAppActive`)
*
*/
@@ -114,13 +114,19 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error);
/**
* Defines the authentication mechanism to be used
*
* _Default_: BITAuthenticatorAuthTypeUDIDProvider
*
* The values are listed here: `BITAuthenticatorAuthType`
*
* _Default_: `BITAuthenticatorAuthTypeUDIDProvider`
*/
@property (nonatomic, assign) BITAuthenticatorAuthType authenticationType;
/**
* _Default_: BITAuthenticatorValidationTypeNever
* Defines the validation mechanism to be used
*
* The values are listed here: `BITAuthenticatorValidationType`
*
* _Default_: `BITAuthenticatorValidationTypeNever`
*/
@property (nonatomic, assign) BITAuthenticatorValidationType validationType;