GoogleUserMessagingPlatform Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
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
Objective-C
UMPFormStatusUnknown = 0
-
Consent forms are available and can be loaded using [UMPConsentForm
loadWithCompletionHandler:]
Declaration
Objective-C
UMPFormStatusAvailable = 1
-
Consent forms are unavailable. Showing a consent form is not required.
Declaration
Swift
case unavailable = 2
Objective-C
UMPFormStatusUnavailable = 2
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eUMPFormStatus\u003c/code\u003e is an enum representing the availability of a user's consent form.\u003c/p\u003e\n"],["\u003cp\u003eThe status can be \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eavailable\u003c/code\u003e, or \u003ccode\u003eunavailable\u003c/code\u003e, indicating whether a form needs to be requested, can be loaded, or is not required, respectively.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can request an update to the form status using the \u003ccode\u003erequestConsentInfoUpdateWithParameters:completionHandler\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eUMPFormStatus\u003c/code\u003e helps determine when and how to present a consent form to the user within an app.\u003c/p\u003e\n"]]],["The `UMPFormStatus` enum indicates the availability of user consent forms. `UMPFormStatusUnknown` means availability is unknown and requires an update request. `UMPFormStatusAvailable` signifies that forms can be loaded. `UMPFormStatusUnavailable` denotes that consent forms are not needed. To check for status changes, use `requestConsentInfoUpdateWithParameters:completionHandler`. The status is represented numerically in Swift and Objective-C, with unknown as 0, available as 1 and unavailable as 2.\n"],null,["# GoogleUserMessagingPlatform Framework Reference\n\nUMPFormStatus\n=============\n\n enum UMPFormStatus : NSInteger {}\n\nState values for whether the user has a consent form available to them. To check whether form\nstatus has changed, an update can be requested through\nrequestConsentInfoUpdateWithParameters:completionHandler.\n- `\n ``\n ``\n `\n\n ### [UMPFormStatusUnknown](#/c:@E@UMPFormStatus@UMPFormStatusUnknown)\n\n `\n ` \n Whether a consent form is available is unknown. An update should be requested using\n requestConsentInfoUpdateWithParameters:completionHandler. \n\n #### Declaration\n\n Swift \n\n case unknown = 0\n\n Objective-C \n\n UMPFormStatusUnknown = 0\n\n- `\n ``\n ``\n `\n\n ### [UMPFormStatusAvailable](#/c:@E@UMPFormStatus@UMPFormStatusAvailable)\n\n `\n ` \n Consent forms are available and can be loaded using \\[UMPConsentForm\n loadWithCompletionHandler:\\] \n\n #### Declaration\n\n Swift \n\n case available = 1\n\n Objective-C \n\n UMPFormStatusAvailable = 1\n\n- `\n ``\n ``\n `\n\n ### [UMPFormStatusUnavailable](#/c:@E@UMPFormStatus@UMPFormStatusUnavailable)\n\n `\n ` \n Consent forms are unavailable. Showing a consent form is not required. \n\n #### Declaration\n\n Swift \n\n case unavailable = 2\n\n Objective-C \n\n UMPFormStatusUnavailable = 2"]]
