GoogleUserMessagingPlatform Framework Reference

  • UMPConsentForm is a single use consent form object.

  • You can load a consent form using +loadWithCompletionHandler: which calls a completion handler on completion and must be called on the main queue.

  • The +loadAndPresentIfRequiredFromViewController:completionHandler: method loads a consent form and presents it if consent is required, calling a completion handler after user interaction or on the next run loop if no form is presented, and must also be called on the main queue.

  • You can present a privacy options form using +presentPrivacyOptionsFormFromViewController:completionHandler: in response to user input if privacy options are required, which calls a completion handler after dismissal or on the next run loop with an error if no form is presented.

  • The +presentFromViewController:completionHandler: method presents the full-screen consent form, updates the consent status, and calls the completion handler after user selection.

UMPConsentForm


@interface UMPConsentForm : NSObject

A single use consent form object.

  • 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;

  • 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;

  • 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;

  • Unavailable

    Unavailable. Use +loadWithCompletionHandler: instead.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • 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;