GoogleUserMessagingPlatform Framework Reference

AI-generated Key Takeaways

• UMPConsentForm is a single-use object used to manage and display consent forms within an application.

• It provides methods to load and present consent forms, including handling privacy options, with completion handlers for asynchronous operations.

• The class offers functionality to present forms based on the current consent status and privacy options requirement status.

• Developers can use it to load and present the form from a specific view controller or let it automatically use the top view controller.

• Direct initialization of UMPConsentForm is unavailable; it must be loaded using the designated class methods like loadWithCompletionHandler: or loadAndPresentIfRequiredFromViewController:completionHandler:.

UMPConsentForm

@interface UMPConsentForm : NSObject

A single use consent form object.

• +loadWithCompletionHandler:

  Loads a consent form and calls completionHandler on completion. Must be called on the main queue.

  Declaration

  Swift

  class func load() async throws -> ConsentForm

  Objective-C

  + (void)loadWithCompletionHandler:
      (nonnull UMPConsentFormLoadCompletionHandler)completionHandler;

• +loadAndPresentIfRequiredFromViewController:completionHandler:

  Loads a consent form and immediately presents it from the provided viewController if UMPConsentInformation.sharedInstance.consentStatus is UMPConsentStatusRequired. Calls completionHandler after the user selects an option and the form is dismissed, or on the next run loop if no form is presented. Must be called on the main queue. If viewController is nil, uses the top view controller of the application’s main window.

  Declaration

  Swift

  class func loadAndPresentIfRequired(from viewController: UIViewController?) async throws

  Objective-C

  + (void)
      loadAndPresentIfRequiredFromViewController:
          (nullable UIViewController *)viewController
                               completionHandler:
                                   (nullable
                                        UMPConsentFormPresentCompletionHandler)
                                       completionHandler;

• +presentPrivacyOptionsFormFromViewController:completionHandler:

  Presents a privacy options form from the provided viewController if UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus is UMPPrivacyOptionsRequirementStatusRequired. Calls completionHandler with nil error after the user selects an option and the form is dismissed, or on the next run loop with a non-nil error if no form is presented. Must be called on the main queue.

  This method should only be called in response to a user input to request a privacy options form to be shown. The privacy options form is preloaded by the SDK automatically when a form becomes available. If no form is preloaded, the SDK will invoke the completionHandler on the next run loop, but will asynchronously retry to load one. If viewController is nil, uses the top view controller of the application’s main window.

  Declaration

  Swift

  class func presentPrivacyOptionsForm(from viewController: UIViewController?) async throws

  Objective-C

  + (void)
      presentPrivacyOptionsFormFromViewController:
          (nullable UIViewController *)viewController
                                completionHandler:
                                    (nullable
                                         UMPConsentFormPresentCompletionHandler)
                                        completionHandler;

• -init

  Unavailable

  Unavailable. Use +loadWithCompletionHandler: instead.

  Declaration

  Objective-C

  - (nonnull instancetype)init;

• -presentFromViewController:completionHandler:

  Presents the full screen consent form over viewController. The form is dismissed and completionHandler is called after the user selects an option. UMPConsentInformation.sharedInstance.consentStatus is updated prior to completionHandler being called. completionHandler is called on the main queue. If viewController is nil, uses the top view controller of the application’s main window.

  Declaration

  Swift

  func present(from viewController: UIViewController?) async throws

  Objective-C

  - (void)presentFromViewController:(nullable UIViewController *)viewController
                  completionHandler:
                      (nullable UMPConsentFormPresentCompletionHandler)
                          completionHandler;