diff --git a/Classes/BITAuthenticator.h b/Classes/BITAuthenticator.h index ab2f58cc36..e61a2ab0c9 100644 --- a/Classes/BITAuthenticator.h +++ b/Classes/BITAuthenticator.h @@ -115,7 +115,11 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error); /** * Defines the authentication mechanism to be used * - * The values are listed here: `BITAuthenticatorAuthType` + * The values are listed here: `BITAuthenticatorAuthType`: + * + * 1. `BITAuthenticatorAuthTypeEmail`: authenticate the user via email only + * 2. `BITAuthenticatorAuthTypeEmailAndPassword`: authenticate the user via email & password + * 3. `BITAuthenticatorAuthTypeUDIDProvider`: authenticate the device via its UDID (_Default_) * * _Default_: `BITAuthenticatorAuthTypeUDIDProvider` */ @@ -124,7 +128,12 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error); /** * Defines the validation mechanism to be used * - * The values are listed here: `BITAuthenticatorValidationType` + * The values are listed here: `BITAuthenticatorValidationType`: + * + * 1. `BITAuthenticatorValidationTypeNever`: never (_Default_) + * 2. `BITAuthenticatorValidationTypeOptional`: optional + * 3. `BITAuthenticatorValidationTypeOnFirstLaunch`: on first launch of a new app version + * 4. `BITAuthenticatorValidationTypeOnAppActive`: every time the app becomes active (needs internet connection) * * _Default_: `BITAuthenticatorValidationTypeNever` */ diff --git a/Classes/BITCrashManager.h b/Classes/BITCrashManager.h index dc49cff33d..e74a200b34 100644 --- a/Classes/BITCrashManager.h +++ b/Classes/BITCrashManager.h @@ -117,12 +117,12 @@ typedef NS_ENUM(NSUInteger, BITCrashManagerStatus) { to _YES_. The current value is always stored in User Defaults with the key - "BITCrashManagerStatus". + `BITCrashManagerStatus`. If you intend to implement a user setting to let them enable or disable crash reporting, this delegate should be used to return that value. You also have to make sure the new value is stored in the UserDefaults with the key - "BITCrashManagerStatus". + `BITCrashManagerStatus`. @see showAlwaysButton */ diff --git a/Classes/BITHockeyManager.h b/Classes/BITHockeyManager.h index 79e63652da..cdb023a0f6 100644 --- a/Classes/BITHockeyManager.h +++ b/Classes/BITHockeyManager.h @@ -56,17 +56,18 @@ `BITCrashManager`: Shows an alert on startup asking the user if he/she agrees on sending the crash report, if `[BITCrashManager crashManagerStatus]` is set to `BITCrashManagerStatusAlwaysAsk` (default) `BITUpdateManager`: Is automatically deactivated when the SDK detects it is running from a build distributed via the App Store. Otherwise if it is not deactivated manually, it will show an alert after startup informing the user about a pending update, if one is available. If the user then decides to view the update another screen is presented with further details and an option to install the update. `BITFeedbackManager`: If this module is deactivated or the user interface is nowhere added into the app, this module will not do anything. It will not fetch the server for data or show any user interface. If it is integrated, activated, and the user already used it to provide feedback, it will show an alert after startup if a new answer has been received from the server with the option to view it. - - @warning The SDK is **NOT** thread safe and has to be set up on the main thread! - - @warning You should **NOT** change any module configuration after calling `startManager`! Example: + [[BITHockeyManager sharedHockeyManager] configureWithIdentifier:@"" delegate:nil]; [[BITHockeyManager sharedHockeyManager] startManager]; - + + @warning The SDK is **NOT** thread safe and has to be set up on the main thread! + + @warning You should **NOT** change any module configuration after calling `startManager`! + */ @interface BITHockeyManager : NSObject diff --git a/Classes/BITStoreUpdateManager.h b/Classes/BITStoreUpdateManager.h index 134092d2f2..684a160bdd 100644 --- a/Classes/BITStoreUpdateManager.h +++ b/Classes/BITStoreUpdateManager.h @@ -86,7 +86,7 @@ typedef NS_ENUM(NSInteger, BITStoreUpdateSetting) { When to check for new updates. Defines when a the SDK should check if there is a new update available on the - server. This must be assigned one of the following: + server. This must be assigned one of the following, see `BITStoreUpdateSetting`: - `BITStoreUpdateCheckDaily`: Once a day - `BITStoreUpdateCheckWeekly`: Once a week diff --git a/Classes/BITUpdateManager.h b/Classes/BITUpdateManager.h index e39f7c0196..fbcf26265f 100644 --- a/Classes/BITUpdateManager.h +++ b/Classes/BITUpdateManager.h @@ -90,7 +90,7 @@ typedef NS_ENUM (NSUInteger, BITUpdateSetting) { When to check for new updates. Defines when a the SDK should check if there is a new update available on the - server. This must be assigned one of the following: + server. This must be assigned one of the following, see `BITUpdateSetting`: - `BITUpdateCheckStartup`: On every startup or or when the app comes to the foreground - `BITUpdateCheckDaily`: Once a day