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\u003e\u003ccode\u003eUMPFormStatus\u003c/code\u003e has three possible states: \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eavailable\u003c/code\u003e, and \u003ccode\u003eunavailable\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eWhen \u003ccode\u003eUMPFormStatus\u003c/code\u003e is \u003ccode\u003eavailable\u003c/code\u003e, load the form using \u003ccode\u003e[UMPConsentForm loadWithCompletionHandler:]\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIf \u003ccode\u003eUMPFormStatus\u003c/code\u003e is \u003ccode\u003eunavailable\u003c/code\u003e, displaying a consent form is not necessary.\u003c/p\u003e\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"]]
