GoogleUserMessagingPlatform Framework Reference

  • This page lists globally available enumerations for managing user consent and privacy in iOS applications.

  • These enumerations define values for consent status, form status, privacy options, debug geography, and request/form error codes.

  • The enumerations are available in both Swift and Objective-C for easy integration into your iOS projects.

  • They provide a standardized way to interact with the User Messaging Platform (UMP) for handling user privacy preferences.

Enumerations

The following enumerations are available globally.

  • Consent status values.

    Declaration

    Swift

    enum ConsentStatus : Int, @unchecked Sendable

    Objective-C

    enum UMPConsentStatus : 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.

    Declaration

    Swift

    enum FormStatus : Int, @unchecked Sendable

    Objective-C

    enum UMPFormStatus : NSInteger {}

  • State values for whether the user needs to be provided a way to modify their privacy options.

    Declaration

    Swift

    enum PrivacyOptionsRequirementStatus : Int, @unchecked Sendable

    Objective-C

    enum UMPPrivacyOptionsRequirementStatus : NSInteger {}

  • Debug values for testing geography.

    Declaration

    Swift

    enum DebugGeography : Int, @unchecked Sendable

    Objective-C

    enum UMPDebugGeography : NSInteger {}

  • Error codes used when making requests to update consent info.

    Declaration

    Swift

    typealias RequestError.Code._ErrorType = RequestError

    Objective-C

    enum UMPRequestErrorCode : NSInteger {}

  • Error codes used when loading and showing forms.

    Declaration

    Swift

    typealias FormError.Code._ErrorType = FormError

    Objective-C

    enum UMPFormErrorCode : NSInteger {}