GoogleUserMessagingPlatform Framework Reference

  • UMPConsentFormLoadCompletionHandler provides a consent form and error status upon loading a form.

  • UMPConsentFormPresentCompletionHandler is called when a consent form is finished presenting, indicating success or failure.

  • UMPConsentInformationUpdateCompletionHandler is called when a consent information request is complete, signaling success or failure with an error.

Type-Definitions

The following type definitions are available globally.

  • Provides a nonnull consentForm and a nil error if the load succeeded. Provides a nil consentForm and a nonnull error if the load failed.

    Declaration

    Swift

    typealias UMPConsentFormLoadCompletionHandler = (ConsentForm?, (any Error)?) -> Void

    Objective-C

    typedef void (^UMPConsentFormLoadCompletionHandler)(UMPConsentForm *_Nullable,
                                                        NSError *_Nullable)
  • Called after presentation of a UMPConsentForm finishes.

    Declaration

    Swift

    typealias UMPConsentFormPresentCompletionHandler = ((any Error)?) -> Void

    Objective-C

    typedef void (^UMPConsentFormPresentCompletionHandler)(NSError *_Nullable)
  • Called when the consent info request completes. Error is nil on success, and non-nil if the update failed.

    Declaration

    Swift

    typealias UMPConsentInformationUpdateCompletionHandler = ((any Error)?) -> Void

    Objective-C

    typedef void (^UMPConsentInformationUpdateCompletionHandler)(NSError *_Nullable)