Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 10 commits into from
Dec 14, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
97ab954
prefill user info
armcknight Dec 12, 2024
8a9fe49
fix build and add ui test
armcknight Dec 12, 2024
fc35119
dont assert nil value bc it uses the placeholder string when empty
armcknight Dec 13, 2024
a2764d8
default user.name in addition to user.username
armcknight Dec 13, 2024
237f9b4
these should not have been in the public SentrySDK header
armcknight Dec 13, 2024
9491a5c
Merge remote-tracking branch 'origin/main' into armcknight/feat(feedb…
armcknight Dec 13, 2024
1d10311
Apply suggestions from code review
armcknight Dec 13, 2024
00fd06d
Format code
getsentry-bot Dec 13, 2024
f4d440e
put back
armcknight Dec 13, 2024
b1dffae
fix build
armcknight Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions Sources/Sentry/Public/SentrySDK.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
28 changes: 27 additions & 1 deletion Sources/Sentry/include/SentrySDK+Private.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
Loading