From 5ea62ff80616129fd4c8fac3d6396a356c42b22d Mon Sep 17 00:00:00 2001 From: Andreas Linde Date: Mon, 7 Oct 2013 19:12:36 +0200 Subject: [PATCH] More documentation updates --- Classes/BITFeedbackManager.h | 5 +++++ Classes/BITHockeyBaseManager.m | 2 ++ Classes/BITStoreUpdateManager.h | 2 ++ Classes/BITUpdateManager.h | 6 ++++++ 4 files changed, 15 insertions(+) diff --git a/Classes/BITFeedbackManager.h b/Classes/BITFeedbackManager.h index 6e144fb463..4c96ec1c4b 100644 --- a/Classes/BITFeedbackManager.h +++ b/Classes/BITFeedbackManager.h @@ -104,6 +104,11 @@ typedef NS_ENUM(NSInteger, BITFeedbackUserDataElement) { or when the notification `BITHockeyNetworkDidBecomeReachableNotification` is fired. This only happens if the user ever did initiate a conversation by writing the first feedback message. + + Implementing the `BITFeedbackManagerDelegate` protocol will notify your app when a new + message was received from the server. The `BITFeedbackComposeViewControllerDelegate` + protocol informs your app about events related to sending feedback messages. + */ @interface BITFeedbackManager : BITHockeyBaseManager diff --git a/Classes/BITHockeyBaseManager.m b/Classes/BITHockeyBaseManager.m index 1199241fa7..9614ecefa8 100644 --- a/Classes/BITHockeyBaseManager.m +++ b/Classes/BITHockeyBaseManager.m @@ -221,9 +221,11 @@ // as per documentation this only works if called from within viewWillAppear: or viewDidAppear: // in tests this also worked fine on iOS 6 and 7 but not on iOS 5 so we are still trying this if ([parentViewController isBeingPresented]) { + BITHockeyLog(@"WARNING: There is already a view controller being presented onto the parentViewController. Delaying presenting the new view controller by 0.5s."); [self performSelector:@selector(showView:) withObject:viewController afterDelay:0.5]; return; } + // special addition to get rootViewController from three20 which has it's own controller handling if (NSClassFromString(@"TTNavigator")) { #pragma clang diagnostic push diff --git a/Classes/BITStoreUpdateManager.h b/Classes/BITStoreUpdateManager.h index 629562f562..b415a13543 100644 --- a/Classes/BITStoreUpdateManager.h +++ b/Classes/BITStoreUpdateManager.h @@ -66,6 +66,8 @@ typedef NS_ENUM(NSInteger, BITStoreUpdateSetting) { When this module is enabled and **NOT** running in an App Store build/environment, it won't do any checks! + The `BITStoreUpdateManagerDelegate` protocol informs the app about new detected app versions. + @warning This module can **NOT** check if the current device and OS version match the minimum requirements of the new app version! diff --git a/Classes/BITUpdateManager.h b/Classes/BITUpdateManager.h index 70f44da1a2..6013fe1a4a 100644 --- a/Classes/BITUpdateManager.h +++ b/Classes/BITUpdateManager.h @@ -65,6 +65,12 @@ typedef NS_ENUM (NSUInteger, BITUpdateSetting) { This module automatically disables itself when running in an App Store build by default! If you integrate the Atlassian JMC client this module is used to automatically configure JMC, but will not do anything else. + The protocol `BITUpdateManagerDelegate` provides delegates to inform about events and adjust a few behaviors. + + To use the server side restriction feature, to provide updates only to specific users, you need to setup the + `BITAuthenticator` class. This allows the update request to tell the server which user is using the app on the + current device and then let the server decide which updates the device may see. + */ @interface BITUpdateManager : BITHockeyBaseManager