UMPConsentInformation
@interface UMPConsentInformation : NSObject
Consent information. All methods must be called on the main thread.
-
The shared consent information instance.
Declaration
Swift
class var sharedInstance: UMPConsentInformation { get }
Objective-C
@property (class, nonatomic, readonly, nonnull) UMPConsentInformation *sharedInstance;
-
The user’s consent status. This value defaults to UMPConsentStatusUnknown until requestConsentInfoUpdateWithParameters:completionHandler: is called, and defaults to the previous session’s value until |completionHandler| from requestConsentInfoUpdateWithParameters:completionHandler: is called.
Declaration
Swift
var consentStatus: UMPConsentStatus { get }
Objective-C
@property (nonatomic, readonly) UMPConsentStatus consentStatus;
-
Indicates whether the app has completed the necessary steps for gathering updated user consent. Returns NO until requestConsentInfoUpdateWithParameters:completionHandler: is called. Returns YES once requestConsentInfoUpdateWithParameters:completionHandler: is called and when consentStatus is UMPConsentStatusNotRequired or UMPConsentStatusObtained.
Declaration
Swift
var canRequestAds: Bool { get }
Objective-C
@property (nonatomic, readonly) BOOL canRequestAds;
-
Consent form status. This value defaults to UMPFormStatusUnknown and requires a call to requestConsentInfoUpdateWithParameters:completionHandler: to update.
Declaration
Swift
var formStatus: UMPFormStatus { get }
Objective-C
@property (nonatomic, readonly) UMPFormStatus formStatus;
-
Privacy options requirement status. This value defaults to UMPPrivacyOptionsRequirementStatusUnknown until requestConsentInfoUpdateWithParameters:completionHandler: is called, and defaults to the previous session’s value until |completionHandler| from requestConsentInfoUpdateWithParameters:completionHandler: is called.
Declaration
Swift
var privacyOptionsRequirementStatus: UMPPrivacyOptionsRequirementStatus { get }
Objective-C
@property (nonatomic, readonly) UMPPrivacyOptionsRequirementStatus privacyOptionsRequirementStatus;
-
Requests consent information update. Must be called in every app session before checking the user’s consentStatus or loading a consent form. After calling this method, consentStatus will be updated synchronously to hold the consent state from the previous app session, if one exists. consentStatus may be updated again immediately before the completion handler is called.
Declaration
Swift
func requestConsentInfoUpdate(with parameters: UMPRequestParameters?) async throws
Objective-C
- (void) requestConsentInfoUpdateWithParameters: (nullable UMPRequestParameters *)parameters completionHandler: (nonnull UMPConsentInformationUpdateCompletionHandler) handler;
-
Clears all consent state from persistent storage.
Declaration
Swift
func reset()
Objective-C
- (void)reset;