GoogleUserMessagingPlatform Framework Reference

  • Several enumerations are available globally, including UMPConsentStatus , UMPFormStatus , UMPPrivacyOptionsRequirementStatus , UMPDebugGeography , UMPRequestErrorCode , and UMPFormErrorCode .

  • UMPConsentStatus represents consent status values.

  • UMPFormStatus indicates whether a consent form is available to the user and can be updated by requesting consent info.

  • UMPPrivacyOptionsRequirementStatus signifies whether the user needs to be offered a way to change their privacy options.

  • UMPDebugGeography provides values for testing geography in debug mode.

  • UMPRequestErrorCode and UMPFormErrorCode are error codes used for requests and form handling respectively.

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 {} 
    
Design a Mobile Site
View Site in Mobile | Classic
Share by: