GoogleUserMessagingPlatform Framework Reference

  • This page lists globally available enumerations used in the User Messaging Platform (UMP) SDK for iOS.

  • The enumerations cover areas such as consent status, form status, privacy options, debug geography, and error handling.

  • Each enumeration provides different status or error codes relevant to user privacy and consent management.

  • Developers can refer to this page to understand the different states and codes used within the UMP SDK.

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 {}