firebase::
API for User Messaging Platform.
Summary
The User Messaging Platform (UMP) SDK is Google’s option to handle user privacy and consent in mobile apps.
Enumerations
ConsentDebugGeography
{
kConsentDebugGeographyDisabled
= 0,
kConsentDebugGeographyEEA
,
kConsentDebugGeographyNonEEA
}
ConsentFormError
{
kConsentFormSuccess
= 0,
kConsentFormErrorTimeout
,
kConsentFormErrorInternal
,
kConsentFormErrorUnknown
,
kConsentFormErrorUnavailable
,
kConsentFormErrorAlreadyUsed
,
kConsentFormErrorInvalidOperation
,
kConsentFormErrorOperationInProgress
}
ConsentFormStatus
{
kConsentFormStatusUnknown
= 0,
kConsentFormStatusUnavailable
,
kConsentFormStatusAvailable
}
ConsentRequestError
{
kConsentRequestSuccess
= 0,
kConsentRequestErrorInvalidAppId
,
kConsentRequestErrorNetwork
,
kConsentRequestErrorInternal
,
kConsentRequestErrorMisconfiguration
,
kConsentRequestErrorUnknown
,
kConsentRequestErrorInvalidOperation
,
kConsentRequestErrorOperationInProgress
}
ConsentStatus
{
kConsentStatusUnknown
= 0,
kConsentStatusRequired
,
kConsentStatusNotRequired
,
kConsentStatusObtained
}
PrivacyOptionsRequirementStatus
{
kPrivacyOptionsRequirementStatusUnknown
= 0,
kPrivacyOptionsRequirementStatusNotRequired
,
kPrivacyOptionsRequirementStatusRequired
}
Typedefs
void *
Classes
Consent Information class for the User Messaging Platform SDK.
Structs
Debug settings for ConsentInfo::RequestConsentInfoUpdate()
.
Parameters for the ConsentInfo::RequestConsentInfoUpdate()
operation.
Enumerations
ConsentDebugGeography
ConsentDebugGeography
Debug values for testing geography.
Disable geography debugging.
Geography appears as in EEA (European Economic Area) for debug devices.
Geography appears as not in EEA for debug devices.
ConsentFormError
ConsentFormError
Errors when loading or showing the consent form.
This form was already used.
An internal error occurred.
An invalid operation occurred. Try again.
The operation is already in progress.
Call ConsentInfo::LoadConsentFormLastResult()
or ConsentInfo::ShowConsentFormLastResult()
to get the status.
The load request timed out. Try again.
The form is unavailable.
An unknown error occurred.
The operation succeeded.
ConsentFormStatus
ConsentFormStatus
Status of the consent form, whether it is available to show or not.
The consent form is available.
Call ConsentInfo::ShowConsentForm()
to display it.
The consent form is unavailable.
Call ConsentInfo::LoadConsentForm()
to load it.
Status is unknown.
Call ConsentInfo::RequestConsentInfoUpdate()
to update this.
ConsentRequestError
ConsentRequestError
Errors that can occur during a RequestConsentInfoUpdate operation.
An internal error occurred.
Invalid GMA App ID specified in AndroidManifest.xml or Info.plist.
An invalid operation occurred. Try again.
A misconfiguration exists in the UI.
A network error occurred.
The operation is already in progress.
Use ConsentInfo::RequestConsentInfoUpdateLastResult()
to get the status.
An unknown error occurred.
The operation succeeded.
ConsentStatus
ConsentStatus
Consent status values.
Consent is not required.
Consent was required, and has been obtained.
Consent is required, but not obtained.
Unknown status, e.g. prior to calling Request, or if the request fails.
PrivacyOptionsRequirementStatus
PrivacyOptionsRequirementStatus
Whether the privacy options need to be displayed.
Privacy options are not required to be shown.
Privacy options must be shown.
Call ConsentInfo::ShowPrivacyOptionsForm()
to fulfil this requirement.
Privacy options requirement status is unknown.
Call ConsentInfo::RequestConsentInfoUpdate()
to update.
Typedefs
FormParent
void * FormParent
This is a platform specific datatype that is required to show a consent form on screen.
The following defines the datatype on each platform:
- Android: A
jobjectwhich references an Android Activity. - iOS: An
idwhich references an iOS UIViewController.
