GoogleUserMessagingPlatform Framework Reference

  • Globally available type definitions provide ways to handle consent form loading, presentation, and information updates.

  • UMPConsentFormLoadCompletionHandler delivers a consent form and error status upon loading, enabling developers to proceed based on success or failure.

  • UMPConsentFormPresentCompletionHandler is triggered after a consent form is presented, notifying developers about the presentation completion and any potential errors.

  • UMPConsentInformationUpdateCompletionHandler signals the completion of a consent information request, providing an error status to indicate success or failure of the update.

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)