Skip to content

Commit cf97b73

Browse files
committed
chore: update doc comments
1 parent 7abec92 commit cf97b73

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ class FirebaseAnalytics extends FirebasePluginPlatform {
131131
/// - [adStorageConsentGranted] - Enables storage, such as cookies, related to advertising. (Platform: Android, iOS, Web)
132132
/// - [analyticsStorageConsentGranted] - Enables storage, such as cookies, related to analytics (for example, visit duration). (Platform: Android, iOS, Web)
133133
/// - [adPersonalizationSignalsConsentGranted] - Sets consent for personalized advertising. (Platform: Android, iOS, Web)
134-
/// - [adUserDataConsentGranted] - Sets consent for sending user data to Google for advertising purposes. (Platform: Android, iOS)
134+
/// - [adUserDataConsentGranted] - Sets consent for sending user data to Google for advertising purposes. (Platform: Android, iOS, Web)
135135
/// - [functionalityStorageConsentGranted] - Enables storage that supports the functionality of the website or app such as language settings. (Platform: Web)
136136
/// - [personalizationStorageConsentGranted] - Enables storage related to personalization such as video recommendations. (Platform: Web)
137137
/// - [securityStorageConsentGranted] - Enables storage related to security such as authentication functionality, fraud prevention, and other user protection. (Platform: Web)

packages/firebase_analytics/firebase_analytics_platform_interface/lib/src/platform_interface/platform_interface_firebase_analytics.dart

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,24 @@ abstract class FirebaseAnalyticsPlatform extends PlatformInterface {
167167
}
168168

169169
/// Sets the applicable end user consent state.
170+
/// By default, no consent mode values are set.
171+
///
172+
/// - [adStorageConsentGranted] - Enables storage, such as cookies, related to advertising. (Platform: Android, iOS, Web)
173+
/// - [analyticsStorageConsentGranted] - Enables storage, such as cookies, related to analytics (for example, visit duration). (Platform: Android, iOS, Web)
174+
/// - [adPersonalizationSignalsConsentGranted] - Sets consent for personalized advertising. (Platform: Android, iOS, Web)
175+
/// - [adUserDataConsentGranted] - Sets consent for sending user data to Google for advertising purposes. (Platform: Android, iOS, Web)
176+
/// - [functionalityStorageConsentGranted] - Enables storage that supports the functionality of the website or app such as language settings. (Platform: Web)
177+
/// - [personalizationStorageConsentGranted] - Enables storage related to personalization such as video recommendations. (Platform: Web)
178+
/// - [securityStorageConsentGranted] - Enables storage related to security such as authentication functionality, fraud prevention, and other user protection. (Platform: Web)
179+
///
180+
/// Default consents can be set according to the platform:
181+
/// - [iOS][1]
182+
/// - [Android][2]
183+
/// - [Web][3]
184+
///
185+
/// [1]: https://developers.google.com/tag-platform/security/guides/app-consent?platform=ios#default-consent
186+
/// [2]: https://developers.google.com/tag-platform/security/guides/app-consent?platform=android#default-consent
187+
/// [3]: https://firebase.google.com/docs/reference/js/analytics.md#setconsent_1697027
170188
Future<void> setConsent({
171189
bool? adStorageConsentGranted,
172190
bool? analyticsStorageConsentGranted,

0 commit comments

Comments
 (0)