Skip to content

Commit 3f1646b

Browse files
committed
headerdoc
1 parent 8552f5f commit 3f1646b

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

Sources/Sentry/Public/SentryOptions.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -798,6 +798,7 @@ typedef void (^SentryProfilingConfigurationBlock)(SentryProfileOptions *_Nonnull
798798
* either this block to configure a widget and UI form to gather feedback, or directly submits
799799
* feedback you've gathered using your own UI by calling the method @c SentrySDK.captureFeedback
800800
* (se https://docs.sentry.io/platforms/apple/user-feedback/configuration/).
801+
* @note User feedback widget is only available for iOS 13 or later.
801802
*/
802803
@property (nonatomic, copy, nullable)
803804
SentryUserFeedbackConfigurationBlock configureUserFeedback API_AVAILABLE(ios(13.0));

Sources/Sentry/Public/SentrySDK.h

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,16 +263,29 @@ SENTRY_NO_INIT
263263

264264
/**
265265
* Captures user feedback that was manually gathered and sends it to Sentry.
266+
* @warning This is an experimental feature and may still have bugs.
266267
* @param feedback The feedback to send to Sentry.
267268
* @note If you'd prefer not to have to build the UI required to gather the feedback from the user,
268269
* see @c SentryOptions.configureUserFeedback to customize a fully managed integration. See
269270
* https://docs.sentry.io/platforms/apple/user-feedback/ for more information.
270271
*/
271272
+ (void)captureFeedback:(SentryFeedback *)feedback NS_SWIFT_NAME(capture(feedback:));
272273

273-
+ (void)showFeedbackWidget;
274+
/**
275+
* Show the feedback widget button.
276+
* @warning This is an experimental feature and may still have bugs.
277+
* @seealso See @c SentryOptions.configureUserFeedback to configure the widget.
278+
* @note User feedback widget is only available for iOS 13 or later.
279+
*/
280+
+ (void)showFeedbackWidget API_AVAILABLE(ios(13.0));
274281

275-
+ (void)hideFeedbackWidget;
282+
/**
283+
* Hide the feedback widget button.
284+
* @warning This is an experimental feature and may still have bugs.
285+
* @seealso See @c SentryOptions.configureUserFeedback to configure the widget.
286+
* @note User feedback widget is only available for iOS 13 or later.
287+
*/
288+
+ (void)hideFeedbackWidget API_AVAILABLE(ios(13.0));
276289

277290
/**
278291
* Adds a Breadcrumb to the current Scope of the current Hub. If the total number of breadcrumbs

0 commit comments

Comments
 (0)