GoogleUserMessagingPlatform Framework Reference

  • UMPFormStatus is an enum that indicates whether a user has a consent form available.

  • An update to the form status can be requested using requestConsentInfoUpdateWithParameters:completionHandler.

  • UMPFormStatusUnknown means whether a consent form is available is unknown and an update should be requested.

  • UMPFormStatusAvailable means consent forms are available and can be loaded.

  • UMPFormStatusUnavailable means consent forms are unavailable and showing one is not required.

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