[Android] 2. Documentación de la API
API
Constructor
Constructor para crear un objeto CmpManager
parámetros
| Nombre | Tipo |
Descripción |
| contexto | Contexto |
El contexto de la aplicación. |
| config | CMPConfig |
El objeto de configuración para el consent manager |
| cerrarOyente | OnCloseCallback |
La devolución de llamada que se invocará cuando se cierre la capa de consentimiento |
| Oyente abierto | OnOpenCallback |
La devolución de llamada que se invocará cuando se abra la capa de consentimiento |
| cmpNotOpenedCallback | OnCMPNotOpenedCallback |
La devolución de llamada que se invocará cuando no se pueda abrir la capa de consentimiento |
| onErrorCallback | OnErrorCallback |
La devolución de llamada que se invocará cuando se produzca un error. |
inicializar
Inicializar
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | |
| interfaz de la aplicación | CmpLayerAppEventListenerInterface? = nulo |
Ida y vuelta
Ejemplo
initialize(context = ...,appInterface = ...)
establecer devoluciones de llamada
Establecer devoluciones de llamada
parámetros
| Nombre | Tipo | Descripción |
| Oyente abierto | OnOpenCallback? | |
| cerrarOyente | OnCloseCallback? | |
| cmpNotOpenedCallback | OnCMPNotOpenedCallback? | |
| onErrorCallback | OnErrorCallback? | |
| onCmpButtonClickedCallback | OnCmpButtonClickedCallback? |
Ida y vuelta
Sin valor de retorno
Ejemplo
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)
comprobar y abrir la capa de consentimiento
Comprobar y abrir la capa de consentimiento
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| interfaz de la aplicación | CmpLayerAppEventListenerInterface? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
checkAndOpenConsentLayer(context = ...,appInterface = ...)
openCustomLayer
abre la capa de consentimiento personalizada
parámetros
| Nombre | Tipo | Descripción |
| actividad | FragmentoActividad | ejemplo |
| containerViewId | Int. |
Ida y vuelta
Sin valor de retorno
Ejemplo
openCustomLayer(activity = ...,containerViewId = ...)
comprobar
Revise
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | |
| onCmpLayerOpenCallback | OnCmpLayerOpenCallback | |
| está en caché | Booleano = falso |
Ida y vuelta
Sin valor de retorno
Ejemplo
check(context = ...,onCmpLayerOpenCallback = ...,isCached = ...)
openCustomLayer
abre la capa de consentimiento personalizada
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| interfaz de la aplicación | CmpLayerAppEventListenerInterfaz |
Ida y vuelta
Sin valor de retorno
Ejemplo
openCustomLayer(context = ...,appInterface = ...)
openConsentLayer
abre la capa de consentimiento
Ida y vuelta
Sin valor de retorno
Ejemplo
openConsentLayer()
createCustomLayerFragment
Crear fragmento de capa personalizado
Ida y vuelta
CmpLayerFragment
Ejemplo
createCustomLayerFragment()
tiene consentimiento
verificar si el usuario dio su consentimiento
Ida y vuelta
la aplicación tiene consentimiento o no
Ejemplo
hasConsent()
getAllPurposes
devuelve todos los propósitos como una cadena
Ida y vuelta
Propósito Cadena
Ejemplo
getAllPurposes()
getAllPurposeList
devuelve todos los propósitos como una lista de cadenas
Ida y vuelta
Lista de propósitos
Ejemplo
getAllPurposeList()
getEnabledPurposes
Obtener propósitos acordados
Ida y vuelta
Ejemplo
getEnabledPurposes()
getEnabledPurposeList
Obtener lista de propósitos acordados
Ida y vuelta
Ejemplo
getEnabledPurposeList()
getDisabledPurposes
Obtener propósitos deshabilitados
Ida y vuelta
Ejemplo
getDisabledPurposes()
getAllVendors
Obtener todos los proveedores
Ida y vuelta
Ejemplo
getAllVendors()
getAllVendorsList
Obtener la lista de todos los proveedores
Ida y vuelta
Ejemplo
getAllVendorsList()
getEnabledVendors
Obtener proveedores acordados
Ida y vuelta
Ejemplo
getEnabledVendors()
getEnabledVendorList
Obtener la lista de proveedores acordados
Ida y vuelta
Ejemplo
getEnabledVendorList()
getDisabledVendors
Obtener proveedores deshabilitados
Ida y vuelta
Ejemplo
getDisabledVendors()
enableVendorList
Habilitar lista de proveedores
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| vendedores | Lista | |
| onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
enableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
desactivar la lista de proveedores
Deshabilitar lista de proveedores
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| vendedores | Lista | Lista de ID de proveedores para habilitar. |
| onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
disableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
enablePurposeList
Habilitar lista de propósitos
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| fines | Lista | Lista de ID de propósito para habilitar. |
| actualizarVendor | Booleano = verdadero | marcar si es verdadero también habilitar los proveedores correspondientes |
| onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
enablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
deshabilitarPurposeList
Deshabilitar una lista de propósitos
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| fines | Lista | Lista de identificadores de propósitos para deshabilitar |
| actualizarVendor | Booleano = verdadero | marcar si es verdadero también deshabilitar los proveedores correspondientes |
| onConsentReceivedCallback | OnConsentReceivedCallback? = nulo |
Ida y vuelta
Sin valor de retorno
Ejemplo
disablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
rechazar todo
Rejects
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
Ida y vuelta
Sin valor de retorno
Ejemplo
rejectAll(context = ...)
aceptar todo
Aceptar todo
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
Ida y vuelta
Sin valor de retorno
Ejemplo
acceptAll(context = ...)
getUSPrivacyString
Consíguenos una cadena de privacidad
Ida y vuelta
Cadena de privacidad de EE. UU.
Ejemplo
getUSPrivacyString()
tiene el consentimiento del proveedor
Tiene el consentimiento del proveedor
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| id | Cordón | identificación del proveedor |
Ida y vuelta
Booleano si el proveedor ha dado consentimiento
Ejemplo
hasVendorConsent(context = ...,id = ...)
tiene PropósitoConsentimiento
Tiene consentimiento de propósito
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| id | Cordón | identificación de propósito |
| esIABPropósito | Boolean | (en desuso) si el propósito es un propósito de IAB |
| comprobar el consentimiento | Booleano = verdadero |
Ida y vuelta
Ejemplo
hasPurposeConsent(context = ...,id = ...,isIABPurpose = ...,checkConsent = ...)
getGoogleACString
Obtener cadena de CA de Google
Ida y vuelta
Cadena AC de Google
Ejemplo
getGoogleACString()
getConsentstring
Obtener última cadena de consentimiento
Ida y vuelta
Cadena de consentimiento guardada
Ejemplo
getConsentstring()
exportCmpString
Exportar cadena de consentimiento
Ida y vuelta
Cadena Cmp guardada
Ejemplo
exportCmpString()
recibir la última llamada
Recibe la última llamada
Ida y vuelta
Última llamada Fecha de la capa Cmp
Ejemplo
getCalledLast()
llamado este día
Llamado este día
Ida y vuelta
si la capa se llamara hoy
Ejemplo
calledThisDay()
necesidadesAceptación
Necesita aceptación
Ida y vuelta
si el usuario necesita aceptación
Ejemplo
needsAcceptance()
setOpenCmpConsentToolViewListener
abre la capa de consentimiento
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| botón gdpr | Botón | botón de acción |
| llamar de vuelta | OnCloseCallback? |
Ida y vuelta
Sin valor de retorno
Ejemplo
setOpenCmpConsentToolViewListener(context = ...,gdprButton = ...,callback = ...)
setOpenPlaceHolderViewListener
Establecer escucha de vista de marcador de lugar abierto
parámetros
| Nombre | Tipo | Descripción |
| contexto | Contexto | Contexto de la aplicación |
| botón de acción | Botón |
Ida y vuelta
Sin valor de retorno
Ejemplo
setOpenPlaceHolderViewListener(context = ...,actionButton = ...)
