GoogleUserMessagingPlatform Framework Reference

  • This page defines three global type definitions: UMPConsentFormLoadCompletionHandler, UMPConsentFormPresentCompletionHandler, and UMPConsentInformationUpdateCompletionHandler.

  • UMPConsentFormLoadCompletionHandler is used to handle the result of loading a consent form, indicating success with a form or failure with an error.

  • UMPConsentFormPresentCompletionHandler is invoked after a consent form has finished presenting.

  • UMPConsentInformationUpdateCompletionHandler is called upon the completion of a consent information update request, with an error provided if the update failed.

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)