GoogleUserMessagingPlatform Framework Reference

  • UMPFormStatus indicates whether a user has a consent form available.

  • You can request an update on form status using requestConsentInfoUpdateWithParameters:completionHandler.

  • UMPFormStatus has three possible states: unknown, available, and unavailable.

  • When UMPFormStatus is available, load the form using [UMPConsentForm loadWithCompletionHandler:].

  • If UMPFormStatus is unavailable, displaying a consent form is not necessary.

UMPFormStatus

enum UMPFormStatus : NSInteger {}

State values for whether the user has a consent form available to them. To check whether form status has changed, an update can be requested through requestConsentInfoUpdateWithParameters:completionHandler.

  • Whether a consent form is available is unknown. An update should be requested using requestConsentInfoUpdateWithParameters:completionHandler.

    Declaration

    Swift

    case unknown = 0

    Objective-C

    UMPFormStatusUnknown = 0

  • Consent forms are available and can be loaded using [UMPConsentForm loadWithCompletionHandler:]

    Declaration

    Swift

    case available = 1

    Objective-C

    UMPFormStatusAvailable = 1

  • Consent forms are unavailable. Showing a consent form is not required.

    Declaration

    Swift

    case unavailable = 2

    Objective-C

    UMPFormStatusUnavailable = 2