GoogleUserMessagingPlatform Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
UMPConsentStatus
enum UMPConsentStatus : NSInteger {}
Consent status values.
-
< Unknown consent status.
Declaration
Objective-C
UMPConsentStatusUnknown = 0
-
< User consent required but not yet obtained.
Declaration
Objective-C
UMPConsentStatusRequired = 1
-
Declaration
Swift
case notRequired = 2
Objective-C
UMPConsentStatusNotRequired = 2
-
Declaration
Objective-C
UMPConsentStatusObtained =
3
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\u003eUMPConsentStatus\u003c/code\u003e is an enum defining the User Messaging Platform (UMP) consent status with values indicating whether consent is unknown, required, not required, or obtained.\u003c/p\u003e\n"],["\u003cp\u003eThe possible values for \u003ccode\u003eUMPConsentStatus\u003c/code\u003e are \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003erequired\u003c/code\u003e, \u003ccode\u003enotRequired\u003c/code\u003e, and \u003ccode\u003eobtained\u003c/code\u003e, represented by integer values 0, 1, 2, and 3 respectively.\u003c/p\u003e\n"],["\u003cp\u003eWhile most consent statuses are documented, the \u003ccode\u003eobtained\u003c/code\u003e status currently lacks documentation detailing its specific meaning and implications.\u003c/p\u003e\n"]]],["`UMPConsentStatus` is an enumeration with four possible values indicating user consent status: `unknown` (0), where the status is undetermined; `required` (1), meaning consent is needed but not yet given; `notRequired` (2), indicating consent is not necessary; and `obtained` (3), the status when the user has given the consent. These values can be accessed via both Swift and Objective-C using these integer values.\n"],null,["# GoogleUserMessagingPlatform Framework Reference\n\nUMPConsentStatus\n================\n\n enum UMPConsentStatus : NSInteger {}\n\nConsent status values.\n- `\n ``\n ``\n `\n\n ### [UMPConsentStatusUnknown](#/c:@E@UMPConsentStatus@UMPConsentStatusUnknown)\n\n `\n ` \n \\\u003c Unknown consent status. \n\n #### Declaration\n\n Swift \n\n case unknown = 0\n\n Objective-C \n\n UMPConsentStatusUnknown = 0\n\n- `\n ``\n ``\n `\n\n ### [UMPConsentStatusRequired](#/c:@E@UMPConsentStatus@UMPConsentStatusRequired)\n\n `\n ` \n \\\u003c User consent required but not yet obtained. \n\n #### Declaration\n\n Swift \n\n case required = 1\n\n Objective-C \n\n UMPConsentStatusRequired = 1\n\n- `\n ``\n ``\n `\n\n ### [UMPConsentStatusNotRequired](#/c:@E@UMPConsentStatus@UMPConsentStatusNotRequired)\n\n `\n ` \n \\\u003c Consent not required. \n\n #### Declaration\n\n Swift \n\n case notRequired = 2\n\n Objective-C \n\n UMPConsentStatusNotRequired = 2\n\n- `\n ``\n ``\n `\n\n ### [UMPConsentStatusObtained](#/c:@E@UMPConsentStatus@UMPConsentStatusObtained)\n\n `\n ` \n Undocumented \n\n #### Declaration\n\n Swift \n\n case obtained = 3\n\n Objective-C \n\n UMPConsentStatusObtained =\n 3"]]
