Skip to content

Expose user consent API #1139

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Expose user consent API #1139

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
615e889
Expose user consent API
nwhite-riot Nov 4, 2025
7247e91
Format code
getsentry-bot Nov 4, 2025
8466734
Add PR
nwhite-riot Nov 4, 2025
a4d69c7
Merge branch 'check-requires-user-consent' of https://github.com/gets…
nwhite-riot Nov 4, 2025
a3127da
Merge branch 'main' into check-requires-user-consent
tustanivsky Nov 17, 2025
0144aab
Fix method name
tustanivsky Nov 17, 2025
7347f0c
Add `IsUserConsentRequired` implementation stubs for Android and Apple
tustanivsky Nov 17, 2025
e08c5c6
Format code
getsentry-bot Nov 17, 2025
15261fd
Fix typo
tustanivsky Nov 17, 2025
09729b5
Log message
tustanivsky Nov 17, 2025
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Features

- Add runtime API to query user consent requirement ([#1139](https://github.com/getsentry/sentry-unreal/pull/1139))

### Fixes

- No more warnings in UE 5.7 caused by deprecated API usage ([#1152](https://github.com/getsentry/sentry-unreal/pull/1152))
Expand Down
6 changes: 6 additions & 0 deletions plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,12 @@ EUserConsent FAndroidSentrySubsystem::GetUserConsent() const
return EUserConsent::Unknown;
}

bool FAndroidSentrySubsystem::IsUserConsentRequired() const
{
UE_LOG(LogSentrySdk, Log, TEXT("IsUserConsentRequired is not supported on Android."));
return false;
}

TSharedPtr<ISentryTransaction> FAndroidSentrySubsystem::StartTransaction(const FString& name, const FString& operation, bool bindToScope)
{
TSharedPtr<FAndroidSentryTransactionOptions> transactionOptionsAndroid = MakeShareable(new FAndroidSentryTransactionOptions());
Expand Down
1 change: 1 addition & 0 deletions plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ class FAndroidSentrySubsystem : public ISentrySubsystem
virtual void GiveUserConsent() override;
virtual void RevokeUserConsent() override;
virtual EUserConsent GetUserConsent() const override;
virtual bool IsUserConsentRequired() const override;
virtual TSharedPtr<ISentryTransaction> StartTransaction(const FString& name, const FString& operation, bool bindToScope) override;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContext(TSharedPtr<ISentryTransactionContext> context, bool bindToScope) override;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContextAndTimestamp(TSharedPtr<ISentryTransactionContext> context, int64 timestamp, bool bindToScope) override;
Expand Down
6 changes: 6 additions & 0 deletions plugin-dev/Source/Sentry/Private/Apple/AppleSentrySubsystem.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,12 @@ EUserConsent FAppleSentrySubsystem::GetUserConsent() const
return EUserConsent::Unknown;
}

bool FAppleSentrySubsystem::IsUserConsentRequired() const
{
UE_LOG(LogSentrySdk, Log, TEXT("IsUserConsentRequired is not supported on Mac/iOS. Returning default `false` value."));
return false;
}

TSharedPtr<ISentryTransaction> FAppleSentrySubsystem::StartTransaction(const FString& name, const FString& operation, bool bindToScope)
{
id<SentrySpan> transaction = [SENTRY_APPLE_CLASS(SentrySDK) startTransactionWithName:name.GetNSString() operation:operation.GetNSString() bindToScope:bindToScope];
Expand Down
6 changes: 5 additions & 1 deletion plugin-dev/Source/Sentry/Private/Apple/AppleSentrySubsystem.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ class FAppleSentrySubsystem : public ISentrySubsystem
virtual void GiveUserConsent() override;
virtual void RevokeUserConsent() override;
virtual EUserConsent GetUserConsent() const override;
virtual bool IsUserConsentRequired() const override;
virtual TSharedPtr<ISentryTransaction> StartTransaction(const FString& name, const FString& operation, bool bindToScope) override;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContext(TSharedPtr<ISentryTransactionContext> context, bool bindToScope) override;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContextAndTimestamp(TSharedPtr<ISentryTransactionContext> context, int64 timestamp, bool bindToScope) override;
Expand All @@ -54,7 +55,10 @@ class FAppleSentrySubsystem : public ISentrySubsystem
virtual FString GetScreenshotPath() const;
virtual FString GetLatestScreenshot() const;
virtual FString GetGameLogPath() const { return FString(); };
virtual FString GetLatestGameLog() const { return FString(); };
virtual FString GetLatestGameLog() const { return FString(); }

protected:
;

protected:
bool isScreenshotAttachmentEnabled = false;
Expand Down
5 changes: 5 additions & 0 deletions plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,6 +749,11 @@ EUserConsent FGenericPlatformSentrySubsystem::GetUserConsent() const
}
}

bool FGenericPlatformSentrySubsystem::IsUserConsentRequired() const
{
return sentry_user_consent_is_required() == 1;
}

TSharedPtr<ISentryTransaction> FGenericPlatformSentrySubsystem::StartTransaction(const FString& name, const FString& operation, bool bindToScope)
{
TSharedPtr<ISentryTransactionContext> transactionContext = MakeShareable(new FGenericPlatformSentryTransactionContext(name, operation));
Expand Down
1 change: 1 addition & 0 deletions plugin-dev/Source/Sentry/Private/GenericPlatform/GenericPlatformSentrySubsystem.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ class FGenericPlatformSentrySubsystem : public ISentrySubsystem
virtual void GiveUserConsent() override;
virtual void RevokeUserConsent() override;
virtual EUserConsent GetUserConsent() const override;
virtual bool IsUserConsentRequired() const override;
virtual TSharedPtr<ISentryTransaction> StartTransaction(const FString& name, const FString& operation, bool bindToScope) override;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContext(TSharedPtr<ISentryTransactionContext> context, bool bindToScope) override;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContextAndTimestamp(TSharedPtr<ISentryTransactionContext> context, int64 timestamp, bool bindToScope) override;
Expand Down
1 change: 1 addition & 0 deletions plugin-dev/Source/Sentry/Private/Interface/SentrySubsystemInterface.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ class ISentrySubsystem
virtual void GiveUserConsent() = 0;
virtual void RevokeUserConsent() = 0;
virtual EUserConsent GetUserConsent() const = 0;
virtual bool IsUserConsentRequired() const = 0;
virtual TSharedPtr<ISentryTransaction> StartTransaction(const FString& name, const FString& operation, bool bindToScope) = 0;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContext(TSharedPtr<ISentryTransactionContext> context, bool bindToScope) = 0;
virtual TSharedPtr<ISentryTransaction> StartTransactionWithContextAndTimestamp(TSharedPtr<ISentryTransactionContext> context, int64 timestamp, bool bindToScope) = 0;
Expand Down
12 changes: 12 additions & 0 deletions plugin-dev/Source/Sentry/Private/SentrySubsystem.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,6 +624,18 @@ EUserConsent USentrySubsystem::GetUserConsent() const
return SubsystemNativeImpl->GetUserConsent();
}

bool USentrySubsystem::IsUserConsentRequired() const
{
check(SubsystemNativeImpl);

if (!SubsystemNativeImpl || !SubsystemNativeImpl->IsEnabled())
{
return false;
}

return SubsystemNativeImpl->IsUserConsentRequired();
}

USentryTransaction* USentrySubsystem::StartTransaction(const FString& Name, const FString& Operation, bool BindToScope)
{
check(SubsystemNativeImpl);
Expand Down
10 changes: 10 additions & 0 deletions plugin-dev/Source/Sentry/Public/SentrySubsystem.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,16 @@ class SENTRY_API USentrySubsystem : public UEngineSubsystem
UFUNCTION(BlueprintCallable, Category = "Sentry")
EUserConsent GetUserConsent() const;

/**
* Returns if user consent is required for crash upload.
*
* @return True if user consent is required; otherwise false.
*
* @note This method is currently only relevant on Windows and Linux; other platforms will default to `false`.
*/
UFUNCTION(BlueprintCallable, Category = "Sentry")
bool IsUserConsentRequired() const;

/**
* Starts a new transaction.
*
Expand Down