Indicates whether the app has completed the necessary steps for gathering updated user consent.

Returns true ifRequestConsentInfoUpdate() has been called and GetConsentStatus returns either kConsentStatusNotRequired or kConsentStatusObtained.

Consent form status.

This value defaults to kConsentFormStatusUnknown and requires a call toRequestConsentInfoUpdate() to update.

The user’s consent status.

This value defaults to kConsentStatusUnknown untilRequestConsentInfoUpdate() is called, and defaults to the previous session’s value untilRequestConsentInfoUpdate() completes.

Check whether the privacy options form needs to be displayed.

This is updated byRequestConsentInfoUpdate().

Loads a consent form and immediately presents it using the given FormParent, if ConsentStatus is kConsentStatusRequired.

The FormParent is defined as an Activity on Android and a UIViewController on iOS. TheFuture will be completed successfully after the user selects an option (and the form is dismissed), or if the form is not required. TheFuture will be completed with an error if the form fails to load or show.

GetConsentStatus() andCanRequestAds() will be updated prior to theFuture being completed.

Get theFuture from the most recent call toLoadAndShowConsentFormIfRequired().

Loads a consent form.

Returns an error if the consent form is unavailable or cannot be loaded.

Get theFuture from the most recent call toLoadConsentForm().

Requests consent information update.

Must be called in every app session before checking the user’s consent status or loading a consent form. After calling this method,GetConsentStatus() andCanRequestAds() will be updated immediately to hold the consent state from the previous app session, if one exists.GetConsentStatus() andCanRequestAds() may be updated again immediately before the returned future is completed.

Get theFuture from the most recent call toRequestConsentInfoUpdate().

Clears all consent state from persistent storage.

This can be used in development to simulate a new installation.

Presents the full screen consent form using the given FormParent, which is defined as an Activity on Android and a UIViewController on iOS.

The form will be dismissed and theFuture will be completed after the user selects an option.

GetConsentStatus() andCanRequestAds() are updated when the returnedFuture is completed.

Note: You must callLoadConsentForm() and wait for it to complete before calling this method.

Get theFuture from the most recent call toShowConsentForm().

IfGetPrivacyOptionsRequirementStatus() is kPrivacyOptionsRequirementStatusRequired, presents a privacy options form from the provided FormParent, which is defined as an Activity on Android and a UIViewController on iOS.

This method should only be called in response to a user input to request a privacy options form to be shown.

The future completes when the user selects an option and dismisses the form or is completed immediately with an error code if no form is presented. The privacy options form is preloaded by the SDK automatically when a form becomes available. If no form has been preloaded, the SDK will try to load one asynchronously.

Get theFuture from the most recent call toShowPrivacyOptionsForm().

Shut down the User Messaging Platform Consent SDK.

Initializes the User Messaging Platform Consent SDK.

Initializes the User Messaging Platform Consent SDK without Firebase for Android.

The arguments toGetInstance() are platform-specific so the caller must do something like this:

#if defined(__ANDROID__)consent_info=firebase::ump::ConsentInfo::GetInstance(jni_env,activity);#elseconsent_info=firebase::ump::GetInstance();#endif

Initializes User Messaging Platform for iOS without Firebase.

Note: Once any overload ofConsentInfo::GetInstance has been called, you can use this method to obtain the same instance again.