GoogleUserMessagingPlatform Framework Reference

AI-generated Key Takeaways

• UMPFormStatus is an enum representing the availability of a user's consent form.

• The status can be unknown, available, or unavailable, indicating whether a form needs to be requested, can be loaded, or is not required, respectively.

• Developers can request an update to the form status using the requestConsentInfoUpdateWithParameters:completionHandler method.

• UMPFormStatus helps determine when and how to present a consent form to the user within an app.

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.

• UMPFormStatusUnknown

  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

• UMPFormStatusAvailable

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

  Declaration

  Swift

  case available = 1

  Objective-C

  UMPFormStatusAvailable = 1

• UMPFormStatusUnavailable

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

  Declaration

  Swift

  case unavailable = 2

  Objective-C

  UMPFormStatusUnavailable = 2