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.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eUMPFormStatus\u003c/code\u003e indicates whether a user has a consent form available.\u003c/p\u003e\n"],["\u003cp\u003eYou can request an update on form status using \u003ccode\u003erequestConsentInfoUpdateWithParameters:completionHandler\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe possible states are \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eavailable\u003c/code\u003e, and \u003ccode\u003eunavailable\u003c/code\u003e, reflecting the availability of the consent form.\u003c/p\u003e\n"],["\u003cp\u003eWhen the status is \u003ccode\u003eavailable\u003c/code\u003e, you can load the consent form using \u003ccode\u003e[UMPConsentForm loadWithCompletionHandler:]\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIf the status is \u003ccode\u003eunavailable\u003c/code\u003e, displaying a consent form is not necessary.\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"]]
