GoogleUserMessagingPlatform Framework Reference

  • UMPRequestParameters is an NSObject used to send parameters when updating user consent information.

  • The tagForUnderAgeOfConsent property is a Boolean indicating if the user is tagged as under the age of consent.

  • The debugSettings property allows for specifying debug settings for the request.

UMPRequestParameters


@interface UMPRequestParameters : NSObject <NSCopying>

Parameters sent on updates to user consent info.

  • Indicates whether the user is tagged for under age of consent.

    Declaration

    Swift

    var isTaggedForUnderAgeOfConsent: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL tagForUnderAgeOfConsent;

  • Debug settings for the request.

    Declaration

    Swift

    @NSCopying var debugSettings: DebugSettings? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) UMPDebugSettings *debugSettings;

  • The consent sync ID to sync the user consent status collected with the same ID.

    The consent sync ID must meet the following requirements:

    • Constructed as a UUID string, or matches the regular expression (regex) ^[0-9a-zA-Z+.=\/_-$,{}]{22,150}$ .
    • A minimum of 22 characters.
    • A maximum of 150 characters.

    Failure to meet the requirements results in the consent sync ID not being set and the UMP SDK logging a warning to the console.

    Declaration

    Swift

    var consentSyncID: String? { get set }

    Objective-C

    @property (nonatomic, copy, nullable) NSString *consentSyncID;