GoogleUserMessagingPlatform Framework Reference

  • The page defines global type definitions used in User Messaging Platform (UMP) for consent management.

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

  • UMPConsentFormPresentCompletionHandler is called after a consent form is presented, indicating completion status.

  • UMPConsentInformationUpdateCompletionHandler signals completion of a consent information update request, providing an error status if it 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)