fix(feedback): hide API from public until release (#4631)

getsentry · Dec 14, 2024 · e96c029 · e96c029
1 parent e8f2cfd
commit e96c029
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 19 deletions.
diff --git a/Sources/Sentry/Public/SentrySDK.h b/Sources/Sentry/Public/SentrySDK.h
@@ -246,28 +246,10 @@ SENTRY_NO_INIT
 /**
  * Captures user feedback that was manually gathered and sends it to Sentry.
  * @param userFeedback The user feedback to send to Sentry.
- * @note If you'd prefer not to have to build the UI required to gather the feedback from the user,
- * consider using `showUserFeedbackForm`, which delivers a prepackaged user feedback experience. See
- * @c SentryOptions.configureUserFeedback to customize a fully managed integration. See
- * https://docs.sentry.io/platforms/apple/user-feedback/#user-feedback-api and (TODO: add link to
- * new docs) for more information on each approach.
  */
 + (void)captureUserFeedback:(SentryUserFeedback *)userFeedback
     NS_SWIFT_NAME(capture(userFeedback:));
 
-/**
- * Display a form to gather information from an end user in the app to send to Sentry as a user
- * feedback event.
- * @see @c SentryOptions.enableUserFeedbackIntegration and @c SentryOptions.configureUserFeedback to
- * enable the functionality and customize the experience.
- * @note If @c SentryOptions.enableUserFeedbackIntegration is @c NO, this method is a no-op.
- * @note This is a fully managed user feedback flow; there will be no need to call
- * @c SentrySDK.captureUserFeedback . See
- * https://docs.sentry.io/platforms/apple/user-feedback/#user-feedback-api and (TODO: add link to
- * new docs) for more information on each approach.
- */
-+ (void)showUserFeedbackForm;
-
 /**
  * Adds a Breadcrumb to the current Scope of the current Hub. If the total number of breadcrumbs
  * exceeds the @c SentryOptions.maxBreadcrumbs  the SDK removes the oldest breadcrumb.

diff --git a/Sources/Sentry/include/SentrySDK+Private.h b/Sources/Sentry/include/SentrySDK+Private.h
@@ -10,7 +10,11 @@
 #    import "SentrySDK.h"
 #endif
 
-@class SentryHub, SentryId, SentryAppStartMeasurement, SentryEnvelope;
+@class SentryAppStartMeasurement;
+@class SentryEnvelope;
+@class SentryFeedback;
+@class SentryHub;
+@class SentryId;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -50,6 +54,28 @@ NS_ASSUME_NONNULL_BEGIN
  * Needed by hybrid SDKs as react-native to synchronously capture an envelope.
  */
 + (void)captureEnvelope:(SentryEnvelope *)envelope;
+/**
+ * Captures user feedback that was manually gathered and sends it to Sentry.
+ * @param feedback The feedback to send to Sentry.
+ * @note If you'd prefer not to have to build the UI required to gather the feedback from the user,
+ * consider using `showUserFeedbackForm`, which delivers a prepackaged user feedback experience. See
+ * @c SentryOptions.configureUserFeedback to customize a fully managed integration. See
+ * https://docs.sentry.io/platforms/apple/user-feedback/ for more information.
+ */
++ (void)captureFeedback:(SentryFeedback *)feedback NS_SWIFT_NAME(capture(feedback:));
+
+#if TARGET_OS_IOS && SENTRY_HAS_UIKIT
+/**
+ * Display a form to gather information from an end user in the app to send to Sentry as a user
+ * feedback event.
+ * @see @c SentryOptions.configureUserFeedback to customize the experience, currently only on iOS.
+ * @warning This is an experimental feature and may still have bugs.
+ * @note This is a fully managed user feedback flow; there will be no need to call
+ * @c SentrySDK.captureUserFeedback . See
+ * https://docs.sentry.io/platforms/apple/user-feedback/ for more information.
+ */
++ (void)showUserFeedbackForm;
+#endif // TARGET_OS_IOS && SENTRY_HAS_UIKIT
 
 @end