GoogleUserMessagingPlatform Framework Reference

AI-generated Key Takeaways

• UMPConsentInformation manages user consent status and provides methods to request and update consent information.

• You must call requestConsentInfoUpdateWithParameters:completionHandler: in every app session before accessing consent status or loading a consent form.

• consentStatus indicates the user's current consent status, while canRequestAds signals if the app can request ads based on that status.

• formStatus reflects the current status of the consent form, and privacyOptionsRequirementStatus indicates the requirement for displaying privacy options.

• reset clears all stored consent information, useful for testing and debugging purposes.

UMPConsentInformation

@interface UMPConsentInformation : NSObject

Consent information. All methods must be called on the main thread.

• sharedInstance

  The shared consent information instance.

  Declaration

  Swift

  class var shared: ConsentInformation { get }

  Objective-C

  @property (class, nonatomic, readonly, nonnull) UMPConsentInformation *sharedInstance;

• consentStatus

  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: ConsentStatus { get }

  Objective-C

  @property (nonatomic, readonly) UMPConsentStatus consentStatus;

• canRequestAds

  Indicates whether the SDK has gathered consent aligned with the app’s configured messages. Returns NO until requestConsentInfoUpdateWithParameters:completionHandler: is called.

  Declaration

  Swift

  var canRequestAds: Bool { get }

  Objective-C

  @property (nonatomic, readonly) BOOL canRequestAds;

• formStatus

  Consent form status. This value defaults to UMPFormStatusUnknown and requires a call to requestConsentInfoUpdateWithParameters:completionHandler: to update.

  Declaration

  Swift

  var formStatus: FormStatus { get }

  Objective-C

  @property (nonatomic, readonly) UMPFormStatus formStatus;

• privacyOptionsRequirementStatus

  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: PrivacyOptionsRequirementStatus { get }

  Objective-C

  @property (nonatomic, readonly) UMPPrivacyOptionsRequirementStatus privacyOptionsRequirementStatus;

• -requestConsentInfoUpdateWithParameters:completionHandler:

  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: RequestParameters?) async throws

  Objective-C

  - (void)
      requestConsentInfoUpdateWithParameters:
          (nullable UMPRequestParameters *)parameters
                           completionHandler:
                               (nonnull
                                    UMPConsentInformationUpdateCompletionHandler)
                                   handler;

• -reset

  Clears all consent state from persistent storage.

  Declaration

  Swift

  func reset()

  Objective-C

  - (void)reset;