lpw
2022-02-15 df1e8e61ffd4f44c1225b3d3808fab6516ba6e93
commit | author | age
454098 1 #import <Foundation/Foundation.h>
L 2
3 #import "FIRAnalytics.h"
4
5 NS_ASSUME_NONNULL_BEGIN
6
7 /// The type of consent to set. Supported consent types are `ConsentType.adStorage` and
8 /// `ConsentType.analyticsStorage`. Omitting a type retains its previous status.
9 typedef NSString *FIRConsentType NS_TYPED_ENUM NS_SWIFT_NAME(ConsentType);
10 extern FIRConsentType const FIRConsentTypeAdStorage;
11 extern FIRConsentType const FIRConsentTypeAnalyticsStorage;
12
13 /// The status value of the consent type. Supported statuses are `ConsentStatus.granted` and
14 /// `ConsentStatus.denied`.
15 typedef NSString *FIRConsentStatus NS_TYPED_ENUM NS_SWIFT_NAME(ConsentStatus);
16 extern FIRConsentStatus const FIRConsentStatusDenied;
17 extern FIRConsentStatus const FIRConsentStatusGranted;
18
19 /// Sets the applicable end user consent state.
20 @interface FIRAnalytics (Consent)
21
22 /// Sets the applicable end user consent state (e.g. for device identifiers) for this app on this
23 /// device. Use the consent settings to specify individual consent type values. Settings are
24 /// persisted across app sessions. By default consent types are set to `ConsentStatus.granted`.
25 ///
26 /// @param consentSettings An NSDictionary of consent types. Supported consent type keys are
27 ///   `ConsentType.adStorage` and `ConsentType.analyticsStorage`. Valid values are
28 ///   `ConsentStatus.granted` and `ConsentStatus.denied`.
29 + (void)setConsent:(NSDictionary<FIRConsentType, FIRConsentStatus> *)consentSettings;
30
31 @end
32
33 NS_ASSUME_NONNULL_END