Interface ConsentRequestParameters

Parameters sent on updating user consent info.
Properties
consentDebugSettings?
The ConsentDebugSettings configuration.
consentSyncId?
The consent sync ID to sync the user consent status collected with the same ID.
tagForUnderAgeOfConsent?
Sets whether the user is tagged for under the age of consent.

Properties

Optional consentDebugSettings

consentDebugSettings?: ConsentDebugSettings
The ConsentDebugSettings configuration.

If undefined, no debug setting is used.

Warning: Ensure this is completely omitted or conditionally removed in your production app builds.

Optional consentSyncId

consentSyncId?: string
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 and matches the regular expression (regex) ^[0-9a-zA-Z+.=/_\-$,{}]{22,150}$
  • A minimum of 22 characters.
  • A maximum of 150 characters.
If you don't meet these requirements, the SDK doesn't set the consent sync ID and the UMP SDK logs a warning to the console.

Optional tagForUnderAgeOfConsent

tagForUnderAgeOfConsent?: boolean
Sets whether the user is tagged for under the age of consent.

Default value is false.