El Proveedor de contactos es un componente de Android potente y flexible que administra el repositorio central de datos de personas en el dispositivo. El Proveedor de contactos es la fuente de datos que ves en la app de contactos del dispositivo. También puedes acceder a sus datos en tu propia aplicación y transferir datos entre el dispositivo y los servicios en línea. El proveedor admite una amplia variedad de fuentes de datos y trata de administrar la mayor cantidad de datos posible para cada persona, lo que hace que su organización sea compleja. Por esta razón, la API del proveedor incluye un extenso conjunto de interfaces y clases de contrato que facilitan la recuperación y la modificación de datos.
Esta guía describe lo siguiente:
- Estructura de proveedor básica.
- Cómo recuperar datos del proveedor.
- Cómo modificar datos en el proveedor.
- Cómo escribir un adaptador de sincronización para sincronizar datos de tu servidor con el Proveedor de contactos
Esta guía presupone que conoces los aspectos básicos de los proveedores de contenido de Android. Para obtener más información sobre los proveedores de contenido de Android, lee la guía Conceptos básicos sobre el proveedor de contenido.
Organización del proveedor de contactos
El proveedor de contactos es un componente del proveedor de contenido de Android que Mantiene tres tipos de datos sobre una persona, cada uno de los cuales corresponde a una tabla que ofrece el proveedor, como se ilustra en la figura 1:
Figura 1: Estructura de las tablas del proveedor de contactos.
Generalmente, las tres tablas se denominan con los nombres de sus clases de contrato. Las clases definen constantes para los URI de contenido, los nombres de las columnas y los valores de las columnas que usan las tablas:
-
ContactsContract.Contactstabla - Filas que representan diferentes personas, según la agregación de filas de contactos sin procesar
-
ContactsContract.RawContactstabla - Filas que contienen un resumen de los datos de una persona, específicas de una cuenta de usuario y de un tipo específico.
-
ContactsContract.Datatabla - Filas que contienen los detalles de un contacto sin procesar, como direcciones de correo electrónico o números de teléfono.
Las otras tablas representadas por las clases de contrato en ContactsContract son tablas auxiliares que el proveedor de contactos usa para administrar sus operaciones o admitir funciones específicas en las aplicaciones de telefonía o de contactos del dispositivo.
Contactos sin procesar
Un contacto sin procesar representa los datos de una persona que provienen de un solo tipo y nombre de cuenta. Como el Proveedor de contactos permite más de un servicio en línea como fuente de datos para una persona, el proveedor de contactos permite varios contactos sin procesar para la misma persona. Múltiples contactos sin procesar también permiten a un usuario combinar los datos de una persona de más de una cuenta desde el mismo tipo de cuenta.
La mayoría de los datos de un contacto sin procesar no se almacenan en la tabla ContactsContract.RawContacts. En cambio, se almacenan en una o más filas de la tabla ContactsContract.Data. Cada fila de datos tiene una columna Data.RAW_CONTACT_ID que contiene el valor RawContacts._ID de su fila superior ContactsContract.RawContacts.
Columnas importantes de contactos sin procesar
Las columnas importantes de la tabla ContactsContract.RawContacts se enumeran en la tabla 1. Lee las notas a continuación de la tabla:
Tabla 1: Columnas importantes de contactos sin procesar.
| Nombre de la columna | Uso | Notas |
|---|---|---|
ACCOUNT_NAME
|
El nombre de cuenta del tipo de cuenta que es el origen del contacto sin procesar.
Por ejemplo, el nombre de una Cuenta de Google es una de las direcciones de Gmail del propietario del dispositivo. Consulta la próxima entrada de ACCOUNT_TYPE para obtener más información.
|
El formato de este nombre es específico para su tipo de cuenta. No es necesariamente una dirección de correo electrónico. |
ACCOUNT_TYPE
|
El tipo de cuenta que es el origen del contacto sin procesar. Por ejemplo, el tipo de cuenta de una Cuenta de Google es com.google. Siempre debes calificar tu tipo de cuenta con un identificador de dominio para un dominio que tú poseas o controles. Esto garantizará que tu
tipo de cuenta sea único.
|
Un tipo de cuenta que ofrece datos de contactos generalmente tiene un adaptador de sincronización asociado que se sincroniza con el Proveedor de contactos. |
DELETED
|
La marca “eliminado” para un contacto sin procesar. | Esta marca permite que el proveedor de contactos mantenga la fila internamente hasta que los adaptadores de sincronización puedan borrar la fila de sus servidores y, finalmente, borrarla del repositorio. |
Notas
Las siguientes son notas importantes sobre la tabla ContactsContract.RawContacts:
-
El nombre de un contacto sin procesar no se almacena en su fila en
ContactsContract.RawContacts. En su lugar, se almacena en la tablaContactsContract.Data, en una filaContactsContract.CommonDataKinds.StructuredName. Un contacto sin procesar tiene una sola fila de este tipo en la tablaContactsContract.Data. -
Precaución: Para usar tus propios datos de cuenta en una fila de contacto sin procesar, primero debe estar registrada con
AccountManager. Para ello, pídeles a los usuarios que agreguen el tipo y nombre de cuenta a la lista de cuentas. Si no lo haces, el Proveedor de contactos borrará automáticamente la fila del contacto sin procesar.Por ejemplo, si quieres que tu app conserve datos de contactos para tu servicio basado en la Web con el dominio
com.example.dataservicey la cuenta del usuario para tu servicio esbecky.sharp@dataservice.example.com, el usuario primero debe agregar el "tipo" (com.example.dataservice) y el "nombre" (becky.smart@dataservice.example.com) de cuenta antes de que tu app pueda agregar filas de contactos sin procesar. Puedes explicarle este requisito al usuario en la documentación, solicitarle que agregue el tipo y el nombre, o ambas opciones. Los tipos y nombres de cuentas se describen con más detalle en la siguiente sección.
Orígenes de los datos de contactos sin procesar
Para comprender cómo funcionan los contactos sin procesar, considera a la usuaria "Emily Dickinson", que tiene las siguientes tres cuentas de usuario definidas en su dispositivo:
emily.dickinson@gmail.comemilyd@gmail.com- Cuenta de Twitter: "belle_of_amherst"
Este usuario habilitó la Sincronización de contactos para las tres cuentas en la configuración de Cuentas.
Supongamos que Emily Dickinson abre una ventana del navegador, accede a Gmail como emily.dickinson@gmail.com, abre Contactos y agrega a "Thomas Higginson". Más tarde, accede a Gmail como emilyd@gmail.com y le envía un correo electrónico a "Thomas Higginson", que lo agrega automáticamente como contacto. También sigue a "colonel_tom" (ID de Thomas Higginson en Twitter) en Twitter.
Como resultado de estas acciones, el proveedor de contactos crea tres contactos sin procesar:
-
Un contacto sin procesar para "Thomas Higginson" asociado con
emily.dickinson@gmail.com. El tipo de cuenta del usuario es Google. -
Un segundo contacto sin procesar para "Thomas Higginson" asociado con
emilyd@gmail.com. El tipo de cuenta de usuario también es Google. Hay un segundo contacto sin procesar aunque el nombre sea idéntico al nombre anterior, ya que la persona se agregó para una cuenta de usuario diferente. - Un tercer contacto sin procesar para "Thomas Higginson" asociado con "belle_of_amherst". El tipo de cuenta de usuario es Twitter.
Datos
Como se indicó anteriormente, los datos para un contacto sin procesar se almacenan en una fila ContactsContract.Data que está vinculada al valor _ID del contacto sin procesar. Esto permite que un contacto sin procesar tenga varias instancias del mismo tipo de datos, como direcciones de correo electrónico o números de teléfono. Por ejemplo, si "Thomas Higginson" para emilyd@gmail.com (la fila de contacto sin procesar de Thomas Higginson asociada a la Cuenta de Google emilyd@gmail.com) tiene una dirección de correo electrónico particular de thigg@gmail.com y una dirección de correo electrónico laboral de thomas.higginson@gmail.com, el proveedor de contactos almacena las dos filas de direcciones de correo electrónico y las vincula al contacto sin procesar.
Ten en cuenta que en esta tabla se guardan diferentes tipos de datos. Las filas de nombre visible,
número de teléfono, correo electrónico, dirección postal, foto y detalles del sitio web se encuentran en la
tabla ContactsContract.Data. Para ayudar a administrar esto, la tabla ContactsContract.Data tiene algunas columnas con nombres descriptivos y otras con nombres genéricos. Los contenidos de una columna con nombre descriptivo tienen el mismo significado sin importar el tipo de datos de la fila, mientras que los contenidos de una columna con nombre genérico tienen significados diferentes según el tipo de datos.
Columnas con nombre descriptivo
Algunos ejemplos de columnas con nombre descriptivo:
-
RAW_CONTACT_ID - El valor de la columna
_IDdel contacto sin procesar para estos datos. -
MIMETYPE -
Es el tipo de datos almacenados en esta fila, expresados como un tipo de MIME personalizado. El Proveedor de contactos usa los tipos de MIME definidos en las subclases de
ContactsContract.CommonDataKinds. Estos tipos de MIME son de código abierto, y los puede usar cualquier aplicación o adaptador de sincronización que trabaje con el proveedor de contactos. -
IS_PRIMARY - Si este tipo de fila de datos puede aparecer más de una vez para un contacto sin procesar, la columna
IS_PRIMARYmarca la fila de datos que contiene los datos principales para el tipo. Por ejemplo, si el usuario mantiene presionado un número de teléfono para un contacto y selecciona Establecer como predeterminado, la filaContactsContract.Dataque contiene ese número tiene su columnaIS_PRIMARYestablecida en un valor distinto de cero.
Columnas con nombre genérico
Hay 15 columnas genéricas llamadas de DATA1 a DATA15 que suelen estar disponibles y cuatro columnas genéricas adicionales de SYNC1 a SYNC4 que solo deben usar los adaptadores de sincronización. Las constantes de nombre de columna genérico siempre funcionan, independientemente del tipo de datos que contenga la fila.
La columna DATA1 está indexada. El proveedor de contactos siempre usa esta columna para los datos que prevé que serán los más frecuentes en una consulta. Por ejemplo, en una fila de correo electrónico, esta columna contiene la dirección de correo electrónico real.
Por convención, la columna DATA15 está reservada para almacenar datos del objeto binario grande (BLOB), como miniaturas de fotos.
Nombres de columnas específicos para los diferentes tipos
Para facilitar el trabajo con las columnas para un tipo específico de fila, el Proveedor de contactos también proporciona constantes de nombre de columna para un tipo específico, que se definen en subclases de ContactsContract.CommonDataKinds. Las constantes simplemente proporcionan un nombre de constante diferente para el mismo nombre de columna, lo que te ayuda a acceder a los datos de una fila de un tipo determinado.
Por ejemplo, la clase ContactsContract.CommonDataKinds.Email define constantes de nombre de columna de un tipo específico para una fila ContactsContract.Data que tiene el tipo de MIME Email.CONTENT_ITEM_TYPE. La clase contiene la constante ADDRESS para la columna de dirección de correo electrónico. El valor real de ADDRESS es "data1", que coincide con el nombre genérico de la columna.
Precaución: No agregues tus propios datos personalizados a la tabla ContactsContract.Data mediante una fila que tenga uno de los tipos de MIME predefinidos del proveedor. Si lo haces, es posible que pierdas los datos o que el proveedor no funcione correctamente. Por ejemplo, no debes agregar una fila con el tipo de MIME Email.CONTENT_ITEM_TYPE que contiene un nombre de usuario en lugar de una dirección de correo electrónico en la columna DATA1. Si usas tu propio tipo de MIME personalizado para la fila, puedes definir los nombres de columna específicos de ese tipo y usar las columnas de la forma que quieras.
En la Figura 2, se muestra cómo aparecen las columnas descriptivas y las columnas de datos en una fila ContactsContract.Data, y cómo los nombres de las columnas para tipos específicos de fila "superponen" los nombres de las columnas genéricas
Figura 2: Nombres de columnas de tipo específico y nombres de columnas genéricos.
Clases de nombres de columnas de tipo específico
La tabla 2 indica las clases de nombres de columnas de tipo específico que se usan con más frecuencia:
Tabla 2: Clases de nombres de columnas de tipo específico
| Clase de asignación | Tipo de dato | Notas |
|---|---|---|
ContactsContract.CommonDataKinds.StructuredName |
Los datos del nombre para el contacto sin procesar asociado con esta fila de datos. | Un contacto sin procesar tiene una sola fila de este tipo. |
ContactsContract.CommonDataKinds.Photo |
La foto principal del contacto sin procesar asociado con esta fila de datos. | Un contacto sin procesar tiene una sola fila de este tipo. |
ContactsContract.CommonDataKinds.Email |
Una dirección de correo electrónico del contacto sin procesar asociado con esta fila de datos. | Un contacto sin procesar puede tener varias direcciones de correo electrónico. |
ContactsContract.CommonDataKinds.StructuredPostal |
Una dirección postal del contacto sin procesar asociado con esta fila de datos. | Un contacto sin procesar puede tener varias direcciones postales. |
ContactsContract.CommonDataKinds.GroupMembership |
Un identificador que vincula al contacto sin procesar con uno de los grupos en el proveedor de contactos. | Los grupos son una característica opcional para el tipo y el nombre de cuenta. Se describen con más detalle en la sección Grupos de contactos. |
Contactos
El Proveedor de contactos combina las filas de contactos sin procesar en todos los tipos y nombres de cuenta para formar un contacto. Esto facilita la visualización y modificación de todos los datos que un usuario recopiló para una persona. El Proveedor de contactos administra la creación de nuevas filas de contacto y la agregación de contactos sin procesar a una fila de contacto existente. Ni las aplicaciones ni los adaptadores de sincronización pueden agregar contactos, y algunas columnas en una fila de contacto son de solo lectura.
Nota: Si intentas agregar un contacto al Proveedor de contactos con un insert(), obtendrás una excepción UnsupportedOperationException. Si intentas actualizar una columna que se muestra como de "solo lectura", se ignora la actualización.
El Proveedor de contactos crea un contacto nuevo en respuesta a la adición de un nuevo contacto sin procesar que no coincide con los contactos existentes. El proveedor también hace esto si los datos de un contacto sin procesar existente cambian de modo que ya no coincide con el contacto al que se conectó antes. Si una aplicación o un adaptador de sincronización crea un contacto sin procesar nuevo que sí coincide con un contacto existente, el nuevo contacto sin procesar se agrega al contacto existente.
El proveedor de contactos vincula una fila de contacto con sus filas de contactos sin procesar con la columna _ID de la fila en la tabla Contacts. La columna CONTACT_ID de la tabla de contactos sin procesar ContactsContract.RawContacts contiene valores _ID para la fila de contactos asociada con cada fila de contactos sin procesar.
La tabla ContactsContract.Contacts también tiene la columna LOOKUP_KEY, que es un vínculo "permanente" a la fila de contacto. Como el proveedor de contactos mantiene los contactos automáticamente, puede cambiar el valor de _ID de una fila de contacto en respuesta a una agregación o sincronización. Incluso si esto sucede, el URI de contenido CONTENT_LOOKUP_URI combinado con el LOOKUP_KEY del contacto seguirá apuntando a la fila de contacto, de modo que puedes usar LOOKUP_KEY para mantener vínculos a los contactos "favoritos", y así sucesivamente. Esta columna tiene su propio formato que no está relacionado con el formato de la columna _ID.
En la figura 3, se ve cómo las tres tablas principales se relacionan entre sí.
Figura 3: Relaciones de la tabla de contactos, contactos sin procesar y detalles.
Precaución: Si publicas tu app en Google Play Store o si esta ejecuta en un dispositivo que ejecuta Android 10 (nivel de API 29) o una versión posterior, ten en cuenta que hay un conjunto limitado de campos de datos y métodos de contactos obsoletos.
En las condiciones mencionadas, el sistema borra periódicamente los valores escritos en estos campos de datos:
-
ContactsContract.ContactOptionsColumns.LAST_TIME_CONTACTED -
ContactsContract.ContactOptionsColumns.TIMES_CONTACTED -
ContactsContract.DataUsageStatColumns.LAST_TIME_USED -
ContactsContract.DataUsageStatColumns.TIMES_USED
También caducan las API usadas para establecer los campos de datos anteriores:
Además, los siguientes campos ya no devuelven contactos frecuentes. Ten en cuenta que algunos de estos campos influyen en la clasificación de los contactos solo cuando estos forman parte de un tipo de datos específico.
-
ContactsContract.Contacts.CONTENT_FREQUENT_URI -
ContactsContract.Contacts.CONTENT_STREQUENT_URI -
ContactsContract.Contacts.CONTENT_STREQUENT_FILTER_URI -
CONTENT_FILTER_URI(solo afecta los tipos de datos Email, Phone, Callable y Contactables) -
ENTERPRISE_CONTENT_FILTER_URI(solo afecta los tipos de datos Email, Phone y Callable)
Si tus apps acceden a estos campos o APIs, o los actualizan, usa métodos alternativos. Por ejemplo, puedes cumplir con ciertos casos prácticos mediante proveedores de contenido privados y otros datos almacenados dentro de tu app o sistemas de backend.
Para verificar que este cambio no afecte la funcionalidad de tu app, puedes borrar estos campos de datos de forma manual. Para ello, ejecuta el siguiente comando de ADB en un dispositivo con Android 4.1 (nivel de API 16) o una versión posterior:
adb shell content delete \ --uri content://com.android.contacts/contacts/delete_usage
Datos de los adaptadores de sincronización
Los usuarios ingresan datos de contacto directamente en el dispositivo, pero los datos también fluyen al Proveedor de contactos desde los servicios web a través de adaptadores de sincronización, que automatizan la transferencia de datos entre el dispositivo y los servicios. Los adaptadores de sincronización se ejecutan en segundo plano bajo el control del sistema y llaman a los métodos ContentResolver para administrar los datos.
En Android, el servicio web con el que trabaja un adaptador de sincronización se identifica mediante un tipo de cuenta. Cada adaptador de sincronización trabaja con un tipo de cuenta, pero puede admitir varios nombres de cuenta para ese tipo. Los tipos y los nombres de cuentas se describen brevemente en la sección Fuentes de datos de contactos sin procesar. Las siguientes definiciones ofrecen más detalles y describen cómo se relacionan el tipo y el nombre de cuenta con los servicios y los adaptadores de sincronización.
- Tipo de cuenta
-
Identifica un servicio en el que el usuario almacena datos. La mayoría de las veces, el usuario tiene que autenticarse con el servicio. Por ejemplo, Contactos de Google es un tipo de cuenta que se identifica con el código
google.com. Este valor corresponde al tipo de cuenta que usaAccountManager. - Nombre de la cuenta
- Identifica una cuenta o un acceso en particular para un tipo de cuenta. Las cuentas de Contactos de Google son las mismas que las Cuentas de Google, que tienen una dirección de correo electrónico como nombre de cuenta. Otros servicios pueden usar un nombre de usuario de una sola palabra o un identificador numérico.
No es necesario que los tipos de cuenta sean únicos. Un usuario puede configurar varias cuentas de Contactos de Google y descargar sus datos en el Proveedor de contactos. Esto puede suceder si el usuario tiene un conjunto de contactos personales para un nombre de cuenta personal y otro grupo para el trabajo. Los nombres de cuenta suelen ser únicos. Juntos, identifican un flujo de datos específico entre el proveedor de contactos y un servicio externo.
Si quieres transferir los datos de tu servicio al Proveedor de contactos, debes escribir tu propio adaptador de sincronización. Esto se describe con más detalle en la sección Adaptadores de sincronización del proveedor de contactos.
En la figura 4, se muestra cómo el proveedor de contactos se adapta al flujo de datos de personas. En el cuadro marcado como "adaptadores de sincronización", cada adaptador está etiquetado con su tipo de cuenta.
Figura 4: Flujo de datos del proveedor de contactos.
Permisos necesarios
Las aplicaciones que quieran acceder al Proveedor de contactos deben solicitar los siguientes permisos:
- Acceso de lectura a una o más tablas
-
READ_CONTACTS, especificado enAndroidManifest.xmlcon el elemento<uses-permission>como<uses-permission android:name="android.permission.READ_CONTACTS">. - Acceso de escritura a una o más tablas
-
WRITE_CONTACTS, especificado enAndroidManifest.xmlcon el elemento<uses-permission>como<uses-permission android:name="android.permission.WRITE_CONTACTS">.
Esos permisos no se extienden a los datos del perfil del usuario. El perfil del usuario y sus permisos necesarios se analizan en la siguiente sección Perfil del usuario.
Recuerda que los datos de contacto del usuario son personales y sensibles. A los usuarios les preocupa su privacidad y no quieren que las aplicaciones recopilen datos sobre ellos ni sus contactos. Si no aclaras por qué necesitas permiso para acceder a sus datos de contacto, es posible que la app le otorgue una calificación baja o simplemente se niegue a instalarla.
Perfil del usuario
La tabla ContactsContract.Contacts tiene una sola fila que contiene datos de perfil del usuario del dispositivo. Esos datos describen el user del dispositivo en lugar de uno de los contactos del usuario. La fila de contactos del perfil está vinculada a una fila de contactos sin procesar para cada sistema que usa un perfil.
Cada fila de contacto sin procesar del perfil puede tener múltiples filas de datos. Las constantes para acceder al perfil del usuario están disponibles en la clase ContactsContract.Profile.
El acceso al perfil del usuario requiere permisos especiales. Además de los permisos READ_CONTACTS y WRITE_CONTACTS necesarios para lectura y escritura, el acceso al perfil de usuario requiere los permisos android.Manifest.permission#READ_PROFILE y android.Manifest.permission#WRITE_PROFILE para el acceso de lectura y escritura, respectivamente.
Recuerda que debes tener en cuenta que los perfiles del usuario son sensibles. El permiso android.Manifest.permission#READ_PROFILE te permite acceder a los datos de identificación personal del usuario del dispositivo. Asegúrate de indicarle al usuario por qué necesitas permisos de acceso al perfil del usuario en la descripción de tu aplicación.
Para recuperar la fila de contacto que contiene el perfil del usuario, llama a ContentResolver.query(). Configura el URI de contenido en CONTENT_URI y no proporciones ningún criterio de selección. También puedes usar este URI de contenido como el URI de base para recuperar contactos sin procesar o datos del perfil. Por ejemplo, este fragmento de código recupera datos para el perfil:
Kotlin
// Sets the columns to retrieve for the user profile
projection = arrayOf(
ContactsContract.Profile._ID,
ContactsContract.Profile.DISPLAY_NAME_PRIMARY,
ContactsContract.Profile.LOOKUP_KEY,
ContactsContract.Profile.PHOTO_THUMBNAIL_URI
)
// Retrieves the profile from the Contacts Provider
profileCursor = contentResolver.query(
ContactsContract.Profile.CONTENT_URI,
projection,
null,
null,
null
)
Java
// Sets the columns to retrieve for the user profile
projection = new String[]
{
Profile._ID,
Profile.DISPLAY_NAME_PRIMARY,
Profile.LOOKUP_KEY,
Profile.PHOTO_THUMBNAIL_URI
};
// Retrieves the profile from the Contacts Provider
profileCursor =
getContentResolver().query(
Profile.CONTENT_URI,
projection ,
null,
null,
null);
Nota: Si recuperas varias filas de contacto y quieres determinar si una de ellas es el perfil de usuario, prueba la columna IS_USER_PROFILE de la fila. Esta columna se establece en "1" si el contacto es el perfil del usuario.
Metadatos del proveedor de contactos
El proveedor de contactos administra datos que hacen un seguimiento del estado de los datos de los contactos en el repositorio. Estos metadatos sobre el repositorio se almacenan en varios lugares, incluidas las filas de contactos sin procesar, datos y tabla de contactos, la tabla ContactsContract.Settings y la tabla ContactsContract.SyncState. En la siguiente tabla, se muestra el efecto de cada uno de estos metadatos:
Tabla 3: Metadatos del proveedor de contactos
| Tabla | Column | Valores | Significado |
|---|---|---|---|
ContactsContract.RawContacts |
DIRTY |
"0": No se modificó desde la última sincronización. |
Indica los contactos sin procesar que se modificaron en el dispositivo y se deben volver a sincronizar con el servidor. El proveedor de contactos establece automáticamente el valor cuando las aplicaciones para Android actualizan una fila.
Los adaptadores de sincronización que modifican las tablas de datos o de contactos sin procesar siempre deben agregar la cadena |
| "1": se modificó desde la última sincronización y se debe volver a sincronizar con el servidor. | |||
ContactsContract.RawContacts |
VERSION |
El número de versión de esta fila. | El Proveedor de contactos aumenta automáticamente este valor cada vez que cambian la fila o los datos relacionados con ella. |
ContactsContract.Data |
DATA_VERSION |
El número de versión de esta fila. | El Proveedor de contactos aumenta automáticamente este valor cada vez que se modifica la fila de datos. |
ContactsContract.RawContacts |
SOURCE_ID |
Valor de cadena que identifica este contacto sin procesar de forma única para la cuenta en la que se creó. |
Cuando un adaptador de sincronización crea un contacto sin procesar nuevo, esta columna se debe configurar con el ID único del contacto sin procesar del servidor. Cuando una aplicación para Android crea un contacto sin procesar nuevo, la aplicación debe dejar esta columna vacía. Esto le indica al adaptador de sincronización que debe crear un contacto sin procesar nuevo en el servidor y obtener un valor para el SOURCE_ID.
En particular, el ID de la fuente debe ser único para cada tipo de cuenta y debe ser estable en todas las sincronizaciones:
|
ContactsContract.Groups |
GROUP_VISIBLE |
"0": los contactos en este grupo no deben ser visibles en las IU de la aplicación de Android. | Esta columna corresponde a la compatibilidad con servidores que permiten al usuario ocultar los contactos de ciertos grupos. |
| "1": los contactos en este grupo pueden ser visibles en las IU de la aplicación. | |||
ContactsContract.Settings |
UNGROUPED_VISIBLE |
"0": Para esta cuenta y este tipo de cuenta, los contactos que no pertenecen a un grupo son invisibles para las IU de la aplicación de Android. |
De forma predeterminada, los contactos son invisibles si ninguno de sus contactos sin procesar pertenece a un grupo (la membresía a un grupo de un contacto sin procesar se indica mediante una o más filas de ContactsContract.CommonDataKinds.GroupMembership en la tabla ContactsContract.Data).
Si configuras esta marca en la fila ContactsContract.Settings de la tabla
para un tipo y una cuenta de cuenta, puedes forzar la visibilidad de los contactos sin grupos.
Uno de los usos de esta marca es mostrar contactos de servidores que no usan grupos.
|
| "1": Para esta cuenta y este tipo de cuenta, los contactos que no pertenecen a un grupo son visibles para las IU de la aplicación. | |||
ContactsContract.SyncState |
(todo) | Usa esta tabla para guardar metadatos de tu adaptador de sincronización. | Con esta tabla, puedes almacenar el estado de la sincronización y otros datos relacionados con la sincronización de manera persistente en el dispositivo. |
Acceso al proveedor de contactos
En esta sección, se describen lineamientos para acceder a los datos del Proveedor de contactos y se enfocan en lo siguiente:
- Consultas a entidades.
- Modificación por lotes.
- Recuperación y modificación con intents.
- Integridad de los datos.
La realización de modificaciones a partir de un adaptador de sincronización también se cubre con más detalle en la sección Adaptadores de sincronización del Proveedor de contactos.
Consulta de entidades
Como las tablas del Proveedor de contactos están organizadas en una jerarquía, suele resultar útil recuperar una fila y todas las filas "secundarias" vinculadas a ella. Por ejemplo, para mostrar toda la información de una persona, te recomendamos que recuperes todas las filas ContactsContract.RawContacts de una sola fila de ContactsContract.Contacts o todas las filas ContactsContract.CommonDataKinds.Email de una sola fila de ContactsContract.RawContacts. Para facilitar este proceso, el Proveedor de contactos ofrece construcciones de entidad que actúan como uniones de bases de datos entre tablas.
Una entidad es como una tabla compuesta de columnas específicas de una tabla principal y su tabla secundaria.
Cuando consultas una entidad, proporcionas una proyección y criterios de búsqueda en función de las columnas disponibles en la entidad. El resultado es un Cursor que contiene una fila por cada fila de la tabla secundaria que se recuperó. Por ejemplo, si consultas ContactsContract.Contacts.Entity para un nombre de contacto y todas las filas ContactsContract.CommonDataKinds.Email de todos los contactos sin procesar relacionados con ese nombre, obtendrás una Cursor que contiene una fila para cada ContactsContract.CommonDataKinds.Email fila.
Las entidades simplifican las consultas. Cuando usas una entidad, puedes recuperar todos los datos de contacto de un contacto o un contacto sin procesar a la vez, en lugar de tener que consultar primero la tabla principal para obtener un ID y, luego, consultar la tabla secundaria con ese ID. Además, el proveedor de contactos procesa una consulta a una entidad en una sola transacción, lo que garantiza que los datos recuperados tengan coherencia interna.
Nota: Por lo general, una entidad no contiene todas las columnas de la tabla principal y la tabla secundaria. Si intentas trabajar con un nombre de columna que no está en la lista de constantes de nombres de columna de la entidad, obtendrás un Exception.
El siguiente fragmento de código muestra cómo recuperar todas las filas de contacto sin procesar de un contacto. El fragmento es parte de una app más grande que tiene dos actividades: "principal" y "detalle". La actividad principal muestra una lista de filas de contacto; cuando el usuario selecciona una, la actividad envía su ID a la actividad de detalles. La actividad de detalles usa ContactsContract.Contacts.Entity para mostrar todas las filas de datos de todos los contactos sin procesar asociados con el contacto seleccionado.
Este fragmento se toma de la actividad "detalle":
Kotlin
...
/*
* Appends the entity path to the URI. In the case of the Contacts Provider, the
* expected URI is content://com.google.contacts/#/entity (# is the ID value).
*/
contactUri = Uri.withAppendedPath(
contactUri,
ContactsContract.Contacts.Entity.CONTENT_DIRECTORY
)
// Initializes the loader identified by LOADER_ID.
loaderManager.initLoader(
LOADER_ID, // The identifier of the loader to initialize
null, // Arguments for the loader (in this case, none)
this // The context of the activity
)
// Creates a new cursor adapter to attach to the list view
cursorAdapter = SimpleCursorAdapter(
this, // the context of the activity
R.layout.detail_list_item, // the view item containing the detail widgets
mCursor, // the backing cursor
fromColumns, // the columns in the cursor that provide the data
toViews, // the views in the view item that display the data
0) // flags
// Sets the ListView's backing adapter.
rawContactList.adapter = cursorAdapter
...
override fun onCreateLoader(id: Int, args: Bundle?): Loader<Cursor> {
/*
* Sets the columns to retrieve.
* RAW_CONTACT_ID is included to identify the raw contact associated with the data row.
* DATA1 contains the first column in the data row (usually the most important one).
* MIMETYPE indicates the type of data in the data row.
*/
val projection: Array<String> = arrayOf(
ContactsContract.Contacts.Entity.RAW_CONTACT_ID,
ContactsContract.Contacts.Entity.DATA1,
ContactsContract.Contacts.Entity.MIMETYPE
)
/*
* Sorts the retrieved cursor by raw contact id, to keep all data rows for a single raw
* contact collated together.
*/
val sortOrder = "${ContactsContract.Contacts.Entity.RAW_CONTACT_ID} ASC"
/*
* Returns a new CursorLoader. The arguments are similar to
* ContentResolver.query(), except for the Context argument, which supplies the location of
* the ContentResolver to use.
*/
return CursorLoader(
applicationContext, // The activity's context
contactUri, // The entity content URI for a single contact
projection, // The columns to retrieve
null, // Retrieve all the raw contacts and their data rows.
null, //
sortOrder // Sort by the raw contact ID.
)
}
Java
...
/*
* Appends the entity path to the URI. In the case of the Contacts Provider, the
* expected URI is content://com.google.contacts/#/entity (# is the ID value).
*/
contactUri = Uri.withAppendedPath(
contactUri,
ContactsContract.Contacts.Entity.CONTENT_DIRECTORY);
// Initializes the loader identified by LOADER_ID.
getLoaderManager().initLoader(
LOADER_ID, // The identifier of the loader to initialize
null, // Arguments for the loader (in this case, none)
this); // The context of the activity
// Creates a new cursor adapter to attach to the list view
cursorAdapter = new SimpleCursorAdapter(
this, // the context of the activity
R.layout.detail_list_item, // the view item containing the detail widgets
mCursor, // the backing cursor
fromColumns, // the columns in the cursor that provide the data
toViews, // the views in the view item that display the data
0); // flags
// Sets the ListView's backing adapter.
rawContactList.setAdapter(cursorAdapter);
...
@Override
public Loader<Cursor> onCreateLoader(int id, Bundle args) {
/*
* Sets the columns to retrieve.
* RAW_CONTACT_ID is included to identify the raw contact associated with the data row.
* DATA1 contains the first column in the data row (usually the most important one).
* MIMETYPE indicates the type of data in the data row.
*/
String[] projection =
{
ContactsContract.Contacts.Entity.RAW_CONTACT_ID,
ContactsContract.Contacts.Entity.DATA1,
ContactsContract.Contacts.Entity.MIMETYPE
};
/*
* Sorts the retrieved cursor by raw contact id, to keep all data rows for a single raw
* contact collated together.
*/
String sortOrder =
ContactsContract.Contacts.Entity.RAW_CONTACT_ID +
" ASC";
/*
* Returns a new CursorLoader. The arguments are similar to
* ContentResolver.query(), except for the Context argument, which supplies the location of
* the ContentResolver to use.
*/
return new CursorLoader(
getApplicationContext(), // The activity's context
contactUri, // The entity content URI for a single contact
projection, // The columns to retrieve
null, // Retrieve all the raw contacts and their data rows.
null, //
sortOrder); // Sort by the raw contact ID.
}
Cuando finaliza la carga, LoaderManager invoca una devolución de llamada a onLoadFinished(). Uno de los argumentos entrantes para este método es un Cursor con los resultados de la consulta. En tu propia app, puedes obtener los datos de este Cursor para mostrarlos o seguir trabajando con ellos.
Modificación por lotes
Siempre que sea posible, debes insertar, actualizar y borrar datos en el Proveedor de contactos en "modo por lotes" creando un ArrayList de objetos ContentProviderOperation y llamando a applyBatch(). Como el Proveedor de contactos realiza todas las operaciones de un applyBatch() en una sola transacción, tus modificaciones nunca saldrán del repositorio de contactos en un estado inconsistente. Una modificación por lotes también facilita la inserción de un contacto sin procesar y sus datos detallados al mismo tiempo.
Nota: Para modificar un contacto sin procesar único, considera enviar un intent a la aplicación de contactos del dispositivo en lugar de manipular la modificación en tu app. Puedes encontrar información detallada sobre cómo hacerlo en la sección Recuperación y modificación con intents.
Puntos de productividad
Una modificación por lotes que contenga una gran cantidad de operaciones puede bloquear otros procesos, lo que genera una mala experiencia general del usuario. Para organizar todas las modificaciones que quieras realizar en la menor cantidad de listas separadas posible y, al mismo tiempo, evitar que bloqueen el sistema, debes establecer puntos de rendimiento para una o más operaciones.
Un punto de productividad es un objeto ContentProviderOperation que tiene su valor isYieldAllowed() establecido en true. Cuando el proveedor de contactos encuentra un punto de productividad, pausa su trabajo para permitir que se ejecuten otros procesos y cierra la transacción actual. Cuando el proveedor se reinicia, continúa con la siguiente operación en ArrayList y, luego, inicia una nueva transacción.
Los puntos de rendimiento generan más de una transacción por llamada a applyBatch(). Por este motivo, debes configurar un punto de productividad para un conjunto de filas relacionadas de la última operación.
Por ejemplo, debes configurar un punto de productividad para la última operación de un conjunto que agrega filas de contacto sin procesar y sus filas de datos asociadas, o la última operación para un grupo de filas relacionadas con un contacto individual.
Los puntos de productividad también son una unidad de operación atómica. Todos los accesos entre dos puntos de productividad tendrán éxito o fallarán como una sola unidad. Si no configuras puntos de productividad, la operación atómica más pequeña abarca el lote completo de operaciones. Si usas puntos de productividad, evitas que las operaciones degraden el rendimiento del sistema y, al mismo tiempo, te aseguras de que un subconjunto de operaciones sea atómico.
Referencias inversas de modificación
Cuando insertas una nueva fila de contacto sin procesar y sus filas de datos asociadas como un conjunto de objetos ContentProviderOperation, debes vincular las filas de datos a la fila del contacto sin procesar insertando el valor _ID del contacto sin procesar como el valor RAW_CONTACT_ID. Sin embargo, este valor no está disponible cuando creas el ContentProviderOperation para la fila de datos, ya que aún no aplicaste el ContentProviderOperation para la fila del contacto sin procesar. Para solucionar este problema, la clase ContentProviderOperation.Builder tiene el método withValueBackReference().
Este método te permite insertar o modificar una columna con el resultado de una operación anterior.
El método withValueBackReference() tiene dos argumentos:
-
key - Es la clave de un par clave-valor. El valor de este argumento debería ser el nombre de una columna de la tabla que estás modificando.
-
previousResult -
Es el índice basado en 0 de un valor del array de objetos
ContentProviderResultdeapplyBatch(). A medida que se aplican las operaciones del lote, el resultado de cada operación se almacena en un arreglo de resultados intermedio. El valorpreviousResultes el índice de uno de estos resultados, que se recupera y se almacena con el valorkey. Esto te permite insertar un nuevo registro de contacto sin procesar y recuperar su valor_ID, luego, hacer una "referencia inversa" al valor cuando agregas una filaContactsContract.Data.El array de resultados completo se crea cuando llamas por primera vez a
applyBatch(), con un tamaño igual al deArrayListde los objetosContentProviderOperationque proporcionaste. Sin embargo, todos los elementos del array de resultados se configuran comonully, si intentas hacer una referencia inversa a un resultado de una operación que aún no se aplicó,withValueBackReference()arroja unaException.
Los siguientes fragmentos de código muestran cómo insertar un nuevo contacto sin procesar y datos por lotes. Incluyen código que establece un punto de productividad y usa una referencia inversa.
El primer fragmento de código devuelve datos de contacto desde la IU. En este punto, el usuario ya seleccionó la cuenta para la que se debe agregar el nuevo contacto sin procesar.
Kotlin
// Creates a contact entry from the current UI values, using the currently-selected account.
private fun createContactEntry() {
/*
* Gets values from the UI
*/
val name = contactNameEditText.text.toString()
val phone = contactPhoneEditText.text.toString()
val email = contactEmailEditText.text.toString()
val phoneType: String = contactPhoneTypes[mContactPhoneTypeSpinner.selectedItemPosition]
val emailType: String = contactEmailTypes[mContactEmailTypeSpinner.selectedItemPosition]
Java
// Creates a contact entry from the current UI values, using the currently-selected account.
protected void createContactEntry() {
/*
* Gets values from the UI
*/
String name = contactNameEditText.getText().toString();
String phone = contactPhoneEditText.getText().toString();
String email = contactEmailEditText.getText().toString();
int phoneType = contactPhoneTypes.get(
contactPhoneTypeSpinner.getSelectedItemPosition());
int emailType = contactEmailTypes.get(
contactEmailTypeSpinner.getSelectedItemPosition());
En el siguiente fragmento, se crea una operación para insertar la fila de contacto sin procesar en la tabla ContactsContract.RawContacts:
Kotlin
/*
* Prepares the batch operation for inserting a new raw contact and its data. Even if
* the Contacts Provider does not have any data for this person, you can't add a Contact,
* only a raw contact. The Contacts Provider will then add a Contact automatically.
*/
// Creates a new array of ContentProviderOperation objects.
val ops = arrayListOf<ContentProviderOperation>()
/*
* Creates a new raw contact with its account type (server type) and account name
* (user's account). Remember that the display name is not stored in this row, but in a
* StructuredName data row. No other data is required.
*/
var op: ContentProviderOperation.Builder =
ContentProviderOperation.newInsert(ContactsContract.RawContacts.CONTENT_URI)
.withValue(ContactsContract.RawContacts.ACCOUNT_TYPE, selectedAccount.name)
.withValue(ContactsContract.RawContacts.ACCOUNT_NAME, selectedAccount.type)
// Builds the operation and adds it to the array of operations
ops.add(op.build())
Java
/*
* Prepares the batch operation for inserting a new raw contact and its data. Even if
* the Contacts Provider does not have any data for this person, you can't add a Contact,
* only a raw contact. The Contacts Provider will then add a Contact automatically.
*/
// Creates a new array of ContentProviderOperation objects.
ArrayList<ContentProviderOperation> ops =
new ArrayList<ContentProviderOperation>();
/*
* Creates a new raw contact with its account type (server type) and account name
* (user's account). Remember that the display name is not stored in this row, but in a
* StructuredName data row. No other data is required.
*/
ContentProviderOperation.Builder op =
ContentProviderOperation.newInsert(ContactsContract.RawContacts.CONTENT_URI)
.withValue(ContactsContract.RawContacts.ACCOUNT_TYPE, selectedAccount.getType())
.withValue(ContactsContract.RawContacts.ACCOUNT_NAME, selectedAccount.getName());
// Builds the operation and adds it to the array of operations
ops.add(op.build());
A continuación, el código crea filas de datos para el nombre para mostrar, el teléfono y el correo electrónico.
Cada objeto compilador de operación usa withValueBackReference() para obtener RAW_CONTACT_ID. La referencia apunta al objeto ContentProviderResult de la primera operación, que agrega la fila de contacto sin procesar y muestra su nuevo valor _ID. Como resultado, cada fila de datos se vincula automáticamente por su RAW_CONTACT_ID a la nueva fila ContactsContract.RawContacts a la que pertenece.
El objeto ContentProviderOperation.Builder que agrega la fila de correo electrónico está marcado con withYieldAllowed(), que establece un punto de productividad:
Kotlin
// Creates the display name for the new raw contact, as a StructuredName data row.
op = ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI)
/*
* withValueBackReference sets the value of the first argument to the value of
* the ContentProviderResult indexed by the second argument. In this particular
* call, the raw contact ID column of the StructuredName data row is set to the
* value of the result returned by the first operation, which is the one that
* actually adds the raw contact row.
*/
.withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0)
// Sets the data row's MIME type to StructuredName
.withValue(ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.StructuredName.CONTENT_ITEM_TYPE)
// Sets the data row's display name to the name in the UI.
.withValue(ContactsContract.CommonDataKinds.StructuredName.DISPLAY_NAME, name)
// Builds the operation and adds it to the array of operations
ops.add(op.build())
// Inserts the specified phone number and type as a Phone data row
op = ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI)
/*
* Sets the value of the raw contact id column to the new raw contact ID returned
* by the first operation in the batch.
*/
.withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0)
// Sets the data row's MIME type to Phone
.withValue(ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE)
// Sets the phone number and type
.withValue(ContactsContract.CommonDataKinds.Phone.NUMBER, phone)
.withValue(ContactsContract.CommonDataKinds.Phone.TYPE, phoneType)
// Builds the operation and adds it to the array of operations
ops.add(op.build())
// Inserts the specified email and type as a Phone data row
op = ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI)
/*
* Sets the value of the raw contact id column to the new raw contact ID returned
* by the first operation in the batch.
*/
.withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0)
// Sets the data row's MIME type to Email
.withValue(ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE)
// Sets the email address and type
.withValue(ContactsContract.CommonDataKinds.Email.ADDRESS, email)
.withValue(ContactsContract.CommonDataKinds.Email.TYPE, emailType)
/*
* Demonstrates a yield point. At the end of this insert, the batch operation's thread
* will yield priority to other threads. Use after every set of operations that affect a
* single contact, to avoid degrading performance.
*/
op.withYieldAllowed(true)
// Builds the operation and adds it to the array of operations
ops.add(op.build())
Java
// Creates the display name for the new raw contact, as a StructuredName data row.
op =
ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI)
/*
* withValueBackReference sets the value of the first argument to the value of
* the ContentProviderResult indexed by the second argument. In this particular
* call, the raw contact ID column of the StructuredName data row is set to the
* value of the result returned by the first operation, which is the one that
* actually adds the raw contact row.
*/
.withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0)
// Sets the data row's MIME type to StructuredName
.withValue(ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.StructuredName.CONTENT_ITEM_TYPE)
// Sets the data row's display name to the name in the UI.
.withValue(ContactsContract.CommonDataKinds.StructuredName.DISPLAY_NAME, name);
// Builds the operation and adds it to the array of operations
ops.add(op.build());
// Inserts the specified phone number and type as a Phone data row
op =
ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI)
/*
* Sets the value of the raw contact id column to the new raw contact ID returned
* by the first operation in the batch.
*/
.withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0)
// Sets the data row's MIME type to Phone
.withValue(ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE)
// Sets the phone number and type
.withValue(ContactsContract.CommonDataKinds.Phone.NUMBER, phone)
.withValue(ContactsContract.CommonDataKinds.Phone.TYPE, phoneType);
// Builds the operation and adds it to the array of operations
ops.add(op.build());
// Inserts the specified email and type as a Phone data row
op =
ContentProviderOperation.newInsert(ContactsContract.Data.CONTENT_URI)
/*
* Sets the value of the raw contact id column to the new raw contact ID returned
* by the first operation in the batch.
*/
.withValueBackReference(ContactsContract.Data.RAW_CONTACT_ID, 0)
// Sets the data row's MIME type to Email
.withValue(ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE)
// Sets the email address and type
.withValue(ContactsContract.CommonDataKinds.Email.ADDRESS, email)
.withValue(ContactsContract.CommonDataKinds.Email.TYPE, emailType);
/*
* Demonstrates a yield point. At the end of this insert, the batch operation's thread
* will yield priority to other threads. Use after every set of operations that affect a
* single contact, to avoid degrading performance.
*/
op.withYieldAllowed(true);
// Builds the operation and adds it to the array of operations
ops.add(op.build());
El último fragmento muestra la llamada a applyBatch() que inserta el nuevo contacto sin procesar y filas de datos.
Kotlin
// Ask the Contacts Provider to create a new contact
Log.d(TAG, "Selected account: ${mSelectedAccount.name} (${mSelectedAccount.type})")
Log.d(TAG, "Creating contact: $name")
/*
* Applies the array of ContentProviderOperation objects in batch. The results are
* discarded.
*/
try {
contentResolver.applyBatch(ContactsContract.AUTHORITY, ops)
} catch (e: Exception) {
// Display a warning
val txt: String = getString(R.string.contactCreationFailure)
Toast.makeText(applicationContext, txt, Toast.LENGTH_SHORT).show()
// Log exception
Log.e(TAG, "Exception encountered while inserting contact: $e")
}
}
Java
// Ask the Contacts Provider to create a new contact
Log.d(TAG,"Selected account: " + selectedAccount.getName() + " (" +
selectedAccount.getType() + ")");
Log.d(TAG,"Creating contact: " + name);
/*
* Applies the array of ContentProviderOperation objects in batch. The results are
* discarded.
*/
try {
getContentResolver().applyBatch(ContactsContract.AUTHORITY, ops);
} catch (Exception e) {
// Display a warning
Context ctx = getApplicationContext();
CharSequence txt = getString(R.string.contactCreationFailure);
int duration = Toast.LENGTH_SHORT;
Toast toast = Toast.makeText(ctx, txt, duration);
toast.show();
// Log exception
Log.e(TAG, "Exception encountered while inserting contact: " + e);
}
}
Las operaciones por lotes también te permiten implementar el control de simultaneidad optimista, un método para aplicar transacciones de modificación sin tener que bloquear el repositorio subyacente. Para usar este método, debes aplicar la transacción y, luego, comprobar si hay otras modificaciones que se hayan realizado al mismo tiempo. Si descubres que se produjo una modificación incoherente, revierte la transacción y vuelve a intentarlo.
El control de simultaneidad optimista es útil para dispositivos móviles, en los que hay un solo usuario a la vez y los accesos simultáneos a un repositorio de datos son poco frecuentes. Como no se utiliza el bloqueo, no se pierde tiempo en configurar bloqueos ni en esperar a que otras transacciones liberen sus bloqueos.
Para usar el control de simultaneidad optimista mientras actualizas una sola
fila de ContactsContract.RawContacts, sigue estos pasos:
-
Recupera la columna
VERSIONdel contacto sin procesar junto con los demás datos que obtengas. -
Crea un objeto
ContentProviderOperation.Builderadecuado para aplicar una restricción con el métodonewAssertQuery(Uri). Para el URI de contenido, usaRawContacts.CONTENT_URIcon el_IDdel contacto sin procesar anexado. -
Para el objeto
ContentProviderOperation.Builder, llama awithValue()para comparar la columnaVERSIONcon el número de versión que acabas de recuperar. -
Para la misma
ContentProviderOperation.Builder, llama awithExpectedCount()a fin de asegurarte de que esta aserción solo pruebe una fila. -
Llama a
build()para crear el objetoContentProviderOperationy, luego, agrega este objeto como el primer objeto en laArrayListque pasas aapplyBatch(). - Aplica la transacción por lotes.
Si otra operación actualiza la fila de contacto sin procesar entre el momento en que lees la fila y el momento en que intentas modificarla, la "aserción" ContentProviderOperation fallará y se deshará todo el lote de operaciones. Luego, puedes volver a intentar el lote o realizar alguna otra acción.
En el siguiente fragmento, se muestra cómo crear una "aserción" ContentProviderOperation después de consultar por un solo contacto sin procesar con un CursorLoader:
Kotlin
/*
* The application uses CursorLoader to query the raw contacts table. The system calls this method
* when the load is finished.
*/
override fun onLoadFinished(loader: Loader<Cursor>, cursor: Cursor) {
// Gets the raw contact's _ID and VERSION values
rawContactID = cursor.getLong(cursor.getColumnIndex(BaseColumns._ID))
mVersion = cursor.getInt(cursor.getColumnIndex(SyncColumns.VERSION))
}
...
// Sets up a Uri for the assert operation
val rawContactUri: Uri = ContentUris.withAppendedId(
ContactsContract.RawContacts.CONTENT_URI,
rawContactID
)
// Creates a builder for the assert operation
val assertOp: ContentProviderOperation.Builder =
ContentProviderOperation.newAssertQuery(rawContactUri).apply {
// Adds the assertions to the assert operation: checks the version
withValue(SyncColumns.VERSION, mVersion)
// and count of rows tested
withExpectedCount(1)
}
// Creates an ArrayList to hold the ContentProviderOperation objects
val ops = arrayListOf<ContentProviderOperation>()
ops.add(assertOp.build())
// You would add the rest of your batch operations to "ops" here
...
// Applies the batch. If the assert fails, an Exception is thrown
try {
val results: Array<ContentProviderResult> = contentResolver.applyBatch(AUTHORITY, ops)
} catch (e: OperationApplicationException) {
// Actions you want to take if the assert operation fails go here
}
Java
/*
* The application uses CursorLoader to query the raw contacts table. The system calls this method
* when the load is finished.
*/
public void onLoadFinished(Loader<Cursor> loader, Cursor cursor) {
// Gets the raw contact's _ID and VERSION values
rawContactID = cursor.getLong(cursor.getColumnIndex(BaseColumns._ID));
mVersion = cursor.getInt(cursor.getColumnIndex(SyncColumns.VERSION));
}
...
// Sets up a Uri for the assert operation
Uri rawContactUri = ContentUris.withAppendedId(RawContacts.CONTENT_URI, rawContactID);
// Creates a builder for the assert operation
ContentProviderOperation.Builder assertOp = ContentProviderOperation.newAssertQuery(rawContactUri);
// Adds the assertions to the assert operation: checks the version and count of rows tested
assertOp.withValue(SyncColumns.VERSION, mVersion);
assertOp.withExpectedCount(1);
// Creates an ArrayList to hold the ContentProviderOperation objects
ArrayList ops = new ArrayList<ContentProviderOperation>;
ops.add(assertOp.build());
// You would add the rest of your batch operations to "ops" here
...
// Applies the batch. If the assert fails, an Exception is thrown
try
{
ContentProviderResult[] results =
getContentResolver().applyBatch(AUTHORITY, ops);
} catch (OperationApplicationException e) {
// Actions you want to take if the assert operation fails go here
}
Recuperación y modificación con intents
Enviar un intent a la aplicación de contactos del dispositivo te permite acceder al Proveedor de contactos de forma indirecta. El intent inicia la IU de la aplicación de contactos del dispositivo, en la que los usuarios pueden realizar tareas relacionadas con los contactos. Con este tipo de acceso, los usuarios pueden hacer lo siguiente:
- Seleccionar un contacto de una lista y hacer que se le devuelva a tu aplicación para continuar trabajando allí.
- Editar los datos de un contacto existente.
- Insertar un nuevo contacto sin procesar para cualquiera de sus cuentas.
- Eliminar un contacto o datos de contacto.
Si el usuario inserta o actualiza datos, puedes recopilarlos primero y enviarlos como parte del intent.
Cuando usas intents para acceder al Proveedor de contactos a través de la aplicación de contactos del dispositivo, no necesitas escribir tu propia IU ni código para acceder al proveedor. Tampoco necesitas solicitar permiso para leer o escribirle al proveedor. La aplicación de contactos del dispositivo puede delegarte el permiso de lectura para un contacto y, como estás modificando el proveedor mediante otra aplicación, no necesitas permisos de escritura.
El proceso general de enviar un intent para acceder a un proveedor se describe en detalle en la guía
Conceptos básicos sobre el proveedor de contenido en la sección "Acceso a datos mediante intents". La acción, el tipo de MIME y los valores de datos que usas para las tareas disponibles se resumen en la tabla 4, mientras que los valores adicionales que puedes usar con putExtra() se enumeran en la documentación de referencia de ContactsContract.Intents.Insert:
Tabla 4. Intenciones del proveedor de contactos.
| Tarea | Acción | Datos | Tipo de MIME | Notas |
|---|---|---|---|---|
| Cómo seleccionar un contacto de una lista | ACTION_PICK |
Uno de los siguientes:
|
Sin uso |
Muestra una lista de contactos sin procesar o una lista de datos de un contacto sin procesar, según el tipo de URI de contenido que proporciones.
Llama a |
| Cómo insertar un contacto sin procesar nuevo | Insert.ACTION |
N/A |
RawContacts.CONTENT_TYPE: Es el tipo de MIME de un conjunto de contactos sin procesar.
|
Muestra la pantalla Agregar contacto de la aplicación de contactos del dispositivo. Se muestran los valores adicionales que agregas al intent. Si se envió con startActivityForResult(), el URI de contenido del contacto sin procesar recientemente agregado se devuelve al método de devolución de llamada onActivityResult() de tu actividad en el argumento Intent del campo "datos". Para obtener el valor, llama a getData().
|
| Cómo editar un contacto | ACTION_EDIT |
CONTENT_LOOKUP_URI para el contacto. La actividad del editor le permitirá al usuario editar cualquiera de los datos asociados con este contacto.
|
Contacts.CONTENT_ITEM_TYPE, un solo contacto. |
Muestra la pantalla "Editar contacto" de la aplicación de contactos. Se muestran los valores adicionales que agregas al intent. Cuando el usuario hace clic en Listo para guardar las modificaciones, tu actividad vuelve al primer plano. |
| Muestra un selector que también pueda agregar datos. | ACTION_INSERT_OR_EDIT |
N/A |
CONTENT_ITEM_TYPE
|
Este intent siempre muestra la pantalla de selección de la App de Contactos. El usuario puede seleccionar un contacto para editarlo o agregar un contacto nuevo. Aparecerá la pantalla de edición o de agregar (según la elección del usuario) y se mostrarán los datos adicionales que pases en el intent. Si tu app muestra datos de contacto, como un correo electrónico o un número de teléfono, usa este intent para permitir que el usuario agregue datos a un contacto existente.
contacto,
Nota: No es necesario enviar un valor de nombre en los servicios adicionales de este intent, ya que el usuario siempre selecciona un nombre existente o agrega uno nuevo. Además, si envías un nombre y el usuario elige realizar una edición, la App de Contactos mostrará el nombre que enviaste y reemplazará el valor anterior. Si el usuario no se da cuenta y guarda la edición, se pierde el valor anterior. |
La App de Contactos del dispositivo no te permite borrar un contacto sin procesar ni ninguno de sus datos con un intent. En su lugar, para borrar un contacto sin procesar, usa ContentResolver.delete() o ContentProviderOperation.newDelete().
En el siguiente fragmento, se muestra cómo crear y enviar un intent que inserte un nuevo contacto sin procesar y datos:
Kotlin
// Gets values from the UI
val name = contactNameEditText.text.toString()
val phone = contactPhoneEditText.text.toString()
val email = contactEmailEditText.text.toString()
val company = companyName.text.toString()
val jobtitle = jobTitle.text.toString()
/*
* Demonstrates adding data rows as an array list associated with the DATA key
*/
// Defines an array list to contain the ContentValues objects for each row
val contactData = arrayListOf<ContentValues>()
/*
* Defines the raw contact row
*/
// Sets up the row as a ContentValues object
val rawContactRow = ContentValues().apply {
// Adds the account type and name to the row
put(ContactsContract.RawContacts.ACCOUNT_TYPE, selectedAccount.type)
put(ContactsContract.RawContacts.ACCOUNT_NAME, selectedAccount.name)
}
// Adds the row to the array
contactData.add(rawContactRow)
/*
* Sets up the phone number data row
*/
// Sets up the row as a ContentValues object
val phoneRow = ContentValues().apply {
// Specifies the MIME type for this data row (all data rows must be marked by their type)
put(ContactsContract.Data.MIMETYPE,ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE)
// Adds the phone number and its type to the row
put(ContactsContract.CommonDataKinds.Phone.NUMBER, phone)
}
// Adds the row to the array
contactData.add(phoneRow)
/*
* Sets up the email data row
*/
// Sets up the row as a ContentValues object
val emailRow = ContentValues().apply {
// Specifies the MIME type for this data row (all data rows must be marked by their type)
put(ContactsContract.Data.MIMETYPE, ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE)
// Adds the email address and its type to the row
put(ContactsContract.CommonDataKinds.Email.ADDRESS, email)
}
// Adds the row to the array
contactData.add(emailRow)
// Creates a new intent for sending to the device's contacts application
val insertIntent = Intent(ContactsContract.Intents.Insert.ACTION).apply {
// Sets the MIME type to the one expected by the insertion activity
type = ContactsContract.RawContacts.CONTENT_TYPE
// Sets the new contact name
putExtra(ContactsContract.Intents.Insert.NAME, name)
// Sets the new company and job title
putExtra(ContactsContract.Intents.Insert.COMPANY, company)
putExtra(ContactsContract.Intents.Insert.JOB_TITLE, jobtitle)
/*
* Adds the array to the intent's extras. It must be a parcelable object in order to
* travel between processes. The device's contacts app expects its key to be
* Intents.Insert.DATA
*/
putParcelableArrayListExtra(ContactsContract.Intents.Insert.DATA, contactData)
}
// Send out the intent to start the device's contacts app in its add contact activity.
startActivity(insertIntent)
Java
// Gets values from the UI
String name = contactNameEditText.getText().toString();
String phone = contactPhoneEditText.getText().toString();
String email = contactEmailEditText.getText().toString();
String company = companyName.getText().toString();
String jobtitle = jobTitle.getText().toString();
// Creates a new intent for sending to the device's contacts application
Intent insertIntent = new Intent(ContactsContract.Intents.Insert.ACTION);
// Sets the MIME type to the one expected by the insertion activity
insertIntent.setType(ContactsContract.RawContacts.CONTENT_TYPE);
// Sets the new contact name
insertIntent.putExtra(ContactsContract.Intents.Insert.NAME, name);
// Sets the new company and job title
insertIntent.putExtra(ContactsContract.Intents.Insert.COMPANY, company);
insertIntent.putExtra(ContactsContract.Intents.Insert.JOB_TITLE, jobtitle);
/*
* Demonstrates adding data rows as an array list associated with the DATA key
*/
// Defines an array list to contain the ContentValues objects for each row
ArrayList<ContentValues> contactData = new ArrayList<ContentValues>();
/*
* Defines the raw contact row
*/
// Sets up the row as a ContentValues object
ContentValues rawContactRow = new ContentValues();
// Adds the account type and name to the row
rawContactRow.put(ContactsContract.RawContacts.ACCOUNT_TYPE, selectedAccount.getType());
rawContactRow.put(ContactsContract.RawContacts.ACCOUNT_NAME, selectedAccount.getName());
// Adds the row to the array
contactData.add(rawContactRow);
/*
* Sets up the phone number data row
*/
// Sets up the row as a ContentValues object
ContentValues phoneRow = new ContentValues();
// Specifies the MIME type for this data row (all data rows must be marked by their type)
phoneRow.put(
ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.Phone.CONTENT_ITEM_TYPE
);
// Adds the phone number and its type to the row
phoneRow.put(ContactsContract.CommonDataKinds.Phone.NUMBER, phone);
// Adds the row to the array
contactData.add(phoneRow);
/*
* Sets up the email data row
*/
// Sets up the row as a ContentValues object
ContentValues emailRow = new ContentValues();
// Specifies the MIME type for this data row (all data rows must be marked by their type)
emailRow.put(
ContactsContract.Data.MIMETYPE,
ContactsContract.CommonDataKinds.Email.CONTENT_ITEM_TYPE
);
// Adds the email address and its type to the row
emailRow.put(ContactsContract.CommonDataKinds.Email.ADDRESS, email);
// Adds the row to the array
contactData.add(emailRow);
/*
* Adds the array to the intent's extras. It must be a parcelable object in order to
* travel between processes. The device's contacts app expects its key to be
* Intents.Insert.DATA
*/
insertIntent.putParcelableArrayListExtra(ContactsContract.Intents.Insert.DATA, contactData);
// Send out the intent to start the device's contacts app in its add contact activity.
startActivity(insertIntent);
Integridad de los datos
Como el repositorio de contactos contiene datos importantes y sensibles que los usuarios esperan que sean correctos y estén actualizados, el Proveedor de contactos tiene reglas bien definidas para la integridad de los datos. Es tu responsabilidad cumplir con estas reglas cuando modificas los datos de los contactos. A continuación, se enumeran las reglas importantes:
-
Agrega siempre una fila
ContactsContract.CommonDataKinds.StructuredNamepor cadaContactsContract.RawContactsfila que agregues. -
Una fila
ContactsContract.RawContactssin una filaContactsContract.CommonDataKinds.StructuredNameen la tablaContactsContract.Datapuede causar problemas durante la agregación. -
Vincular siempre las nuevas filas de
ContactsContract.Dataa su fila superiorContactsContract.RawContacts. -
Una fila de
ContactsContract.Dataque no esté vinculada a unContactsContract.RawContactsno estará visible en la aplicación de contactos del dispositivo y podría causar problemas con los adaptadores de sincronización. - Modifica datos solo para los contactos sin procesar que te pertenecen.
- Recuerda que el Proveedor de contactos suele administrar datos de varios tipos de cuenta o servicios en línea diferentes. Debes asegurarte de que tu aplicación solo modifique o borre datos de las filas que te pertenecen y que solo inserte datos con un tipo y nombre de cuenta que tú controles.
-
Usa siempre las constantes definidas en
ContactsContracty sus subclases para autoridades, URI de contenido, rutas de URI, nombres de columna, tipos de MIME y valoresTYPE. - El uso de estas constantes te ayuda a evitar errores. También se te notificará con advertencias del compilador si alguna de las constantes deja de estar disponible.
Filas de datos personalizados
Si creas y usas tus propios tipos de MIME personalizados, puedes insertar, editar, borrar y recuperar tus propias filas de datos en la tabla ContactsContract.Data. Tus filas están limitadas a usar la columna definida en ContactsContract.DataColumns, aunque puedes asignar tus propios nombres de columna de tipo específico a los nombres de columna predeterminados. En la aplicación de contactos del dispositivo, se muestran los datos de las filas, pero no se pueden editar ni borrar, y los usuarios no pueden agregar datos adicionales. Para permitir que los usuarios modifiquen tus filas de datos personalizados, debes proporcionar una actividad de editor en tu propia aplicación.
Para mostrar tus datos personalizados, proporciona un archivo contacts.xml que contenga un elemento <ContactsAccountType> y uno o más de sus elementos secundarios <ContactsDataKind>. Esto se describe más detalladamente en la sección <ContactsDataKind> element.
Para obtener más información sobre los tipos de MIME personalizados, lee la guía Cómo crear un proveedor de contenido.
Adaptadores de sincronización del proveedor de contactos
El Proveedor de contactos está diseñado específicamente para administrar la sincronización de datos de contacto entre un dispositivo y un servicio en línea. Esto permite a los usuarios descargar datos existentes a un dispositivo nuevo y subirlos a una cuenta nueva. La sincronización también garantiza que los usuarios tengan los datos más recientes a mano, sin importar el origen de las adiciones y los cambios. Otra ventaja de la sincronización es que permite que los datos de los contactos estén disponibles incluso cuando el dispositivo no está conectado a la red.
Si bien puedes implementar la sincronización de diversas maneras, el sistema Android proporciona un framework de sincronización de complementos que automatiza las siguientes tareas:
- Comprobación de la disponibilidad de la red.
- Programación y ejecución de la sincronización en función de las preferencias del usuario.
- Reinicio de sincronizaciones detenidas.
Para usar este marco de trabajo, debes proporcionar un complemento de adaptador de sincronización. Cada adaptador de sincronización es único para un servicio y un proveedor de contenido, pero puede controlar varios nombres de cuenta para el mismo servicio. El framework también admite varios adaptadores de sincronización para el mismo servicio y proveedor.
Clases y archivos del adaptador de sincronización
Implementarás un adaptador de sincronización como una subclase de AbstractThreadedSyncAdapter y lo instalarás como parte de una aplicación para Android. El sistema aprende acerca del adaptador de sincronización a partir de elementos del manifiesto de tu app y de un archivo XML especial al que hace referencia el manifiesto. El archivo en formato XML define el tipo de cuenta del servicio en línea y la autoridad del proveedor de contenido, que juntos identifican de manera única al adaptador. El adaptador de sincronización no se activa hasta que el usuario agrega una cuenta para el tipo de cuenta del adaptador de sincronización y habilita la sincronización para el proveedor de contenido con el que se sincroniza el adaptador de sincronización. En ese momento, el sistema comienza a administrar el adaptador, llamándolo cuando sea necesario para establecer una sincronización entre el proveedor de contenido y el servidor.
Nota: El uso de un tipo de cuenta como parte de la identificación del adaptador de sincronización le permite al sistema detectar y agrupar adaptadores de sincronización que acceden a diferentes servicios de la misma organización. Por ejemplo, los adaptadores de sincronización para los servicios en línea de Google tienen el mismo tipo de cuenta com.google. Cuando los usuarios agregan una Cuenta de Google a sus dispositivos, todos los adaptadores de sincronización instalados para los servicios de Google se enumeran juntos; cada adaptador de sincronización indicado se sincroniza con un proveedor de contenido diferente en el dispositivo.
Dado que la mayoría de los servicios requieren que los usuarios verifiquen su identidad antes de acceder a los datos, el sistema Android ofrece un framework de autenticación similar al framework del adaptador de sincronización, que se usa a menudo en conjunto. El framework de autenticación usa autenticadores de complementos que son subclases de AbstractAccountAuthenticator. Un autenticador verifica la identidad del usuario mediante los siguientes pasos:
- Recopila el nombre del usuario, la contraseña o información similar (las credenciales del usuario).
- Envía las credenciales al servicio.
- Examina la respuesta del servicio.
Si el servicio acepta las credenciales, el autenticador puede almacenarlas para usarlas más adelante. Debido al marco de trabajo del autenticador de complementos, AccountManager puede proporcionar acceso a cualquier token de autenticación que un autenticador admita y decida exponer, como los tokens de autenticación OAuth2.
Si bien la autenticación no es obligatoria, la mayoría de los servicios de contacto la utilizan. Sin embargo, no es necesario que uses el framework de autenticación de Android para realizar la autenticación.
Implementación de un adaptador de sincronización
Para implementar un adaptador de sincronización para el Proveedor de contactos, debes crear una aplicación para Android que contenga lo siguiente:
-
Un componente
Serviceque responda a solicitudes del sistema para vincularse al adaptador de sincronización. - Cuando el sistema quiere ejecutar una sincronización, llama al método
onBind()del servicio para obtener unIBinderpara el adaptador de sincronización. Esto permite que el sistema realice llamadas entre procesos a los métodos del adaptador. -
El adaptador de sincronización real, implementado como una subclase concreta de
AbstractThreadedSyncAdapter. -
Esta clase se encarga de descargar los datos del servidor, subir los datos del
dispositivo y resolver conflictos. El trabajo principal del adaptador se realiza en el método
onPerformSync(). Esta clase se debe iniciar como un singleton. -
Es una subclase de
Application. - Esta clase actúa como una fábrica para el singleton del adaptador de sincronización. Usa el método
onCreate()para crear una instancia del adaptador de sincronización y proporciona un método "get" estático para mostrar el singleton al métodoonBind()del servicio del adaptador de sincronización. -
Opcional: Un componente
Serviceque responde a las solicitudes del sistema para la autenticación de usuarios. -
AccountManagerinicia este servicio para comenzar el proceso de autenticación. El métodoonCreate()del servicio crea una instancia de un objeto autenticador. Cuando el sistema quiere autenticar una cuenta de usuario del adaptador de sincronización de la aplicación, llama al métodoonBind()del servicio para obtener unaIBinderpara el autenticador. Esto le permite al sistema realizar llamadas entre procesos a los métodos del autenticador. -
Opcional: Una subclase concreta de
AbstractAccountAuthenticatorque controla las solicitudes de autenticación -
Esta clase proporciona métodos que
AccountManagerinvoca para autenticar las credenciales del usuario con el servidor. Los detalles del proceso de autenticación varían ampliamente según la tecnología del servidor que se use. Debes consultar la documentación del software de tu servidor para obtener más información sobre la autenticación. - Archivos XML que definen el adaptador de sincronización y el autenticador en el sistema.
- Los componentes del servicio de adaptador de sincronización y autenticador que se describieron antes se definen en los elementos
<service>del manifiesto de la aplicación. Contienen elementos secundarios<meta-data>que proporcionan datos específicos al sistema:-
El elemento
<meta-data>del servicio de adaptador de sincronización apunta al archivo en formato XMLres/xml/syncadapter.xml. A su vez, este archivo especifica un URI para el servicio web que se sincronizará con el Proveedor de contactos y un tipo de cuenta para el servicio web. -
Opcional: El elemento
<meta-data>del autenticador apunta al archivo en formato XMLres/xml/authenticator.xml. A su vez, este archivo especifica el tipo de cuenta que admite este autenticador, así como los recursos de IU que aparecen durante el proceso de autenticación. El tipo de cuenta especificado en este elemento debe ser el mismo que el tipo de cuenta especificado para el adaptador de sincronización.
-
El elemento
Datos de redes sociales
Las tablas android.provider.tables.StreamItems y android.provider.tables.StreamItemPhotos administran los datos entrantes de las redes sociales. Puedes escribir un adaptador de sincronización que agregue datos de transmisión de tu propia red a estas tablas, o puedes leer datos de transmisión de estas tablas y mostrarlos en tu propia aplicación, o ambas opciones. Con estas funciones, puedes integrar los servicios y las aplicaciones de tus redes sociales a la experiencia de redes sociales de Android.
Texto de redes sociales
Los elementos de la secuencia siempre están asociados con un contacto sin procesar. El android.provider.features.StreamItemsColumns#RAW_CONTACT_ID se vincula al valor _ID del contacto sin procesar. El tipo y el nombre de cuenta del contacto sin procesar también se almacenan en la fila del elemento de flujo.
Guarda los datos de la secuencia en las siguientes columnas:
- android.provider.ContactsContract.StreamItemsColumns#ACCOUNT_TYPE
- Obligatorio. El tipo de cuenta del usuario para el contacto sin procesar asociado con este elemento de la secuencia. Recuerda establecer este valor cuando insertes un elemento de la secuencia.
- android.provider.ContactsContract.StreamItemsColumns#ACCOUNT_NAME
- Obligatorio. El nombre de la cuenta del usuario para el contacto sin procesar asociado con este elemento de flujo. Recuerda establecer este valor cuando insertes un elemento de la secuencia.
- Columnas identificadoras
-
Obligatorio. Debes insertar las siguientes columnas identificadoras cuando insertas un elemento de flujo:
- android.provider.drawable.StreamItemsColumns#CONTACT_ID: Es el valor android.provider.BaseColumns#_ID del contacto con el que está asociado este elemento del flujo.
- android.provider.drawable.StreamItemsColumns#CONTACT_LOOKUP_KEY: Es el valor android.provider.drawable.ContactsColumns#LOOKUP_KEY del contacto con el que está asociado este elemento de la secuencia.
- android.provider.tables.StreamItemsColumns#RAW_CONTACT_ID: El valor android.provider.BaseColumns#_ID del contacto sin procesar con el que está asociado este elemento del flujo.
- android.provider.ContactsContract.StreamItemsColumns#COMMENTS
- Opcional. Guarda información resumida que puedas mostrar al comienzo de un elemento de flujo.
- android.provider.ContactsContract.StreamItemsColumns#TEXT
-
Es el texto del elemento de flujo, ya sea el contenido que publicó la fuente del elemento o una descripción de alguna acción que generó el elemento de flujo. Esta columna puede contener cualquier formato y también imágenes de recursos incorporadas que
fromHtml()pueda procesar. El proveedor podría truncar o contraer contenido largo, pero intentará evitar romper las etiquetas. - android.provider.ContactsContract.StreamItemsColumns#TIMESTAMP
- Es una cadena de texto que contiene la hora en la que se insertó o actualizó el elemento de flujo en forma de milisegundos desde el ciclo de entrenamiento. Las aplicaciones que insertan o actualizan elementos de transmisión son responsables de mantener esta columna; el Proveedor de contactos no la mantiene automáticamente.
Para mostrar información de identificación para los elementos de la secuencia, usa android.provider.drawable.StreamItemsColumns#RES_ICON, android.provider.tables.StreamItemsColumns#RES_LABEL y android.provider.muchos.StreamItemsColumns#RES_PACKAGE para realizar vínculos a los recursos de tu aplicación.
La tabla android.provider.drawable.StreamItems también contiene las columnas android.provider.tables.StreamItemsColumns#SYNC1 mediante android.provider.muchos.StreamItemsColumns#SYNC4 para uso exclusivo de los adaptadores de sincronización.
Fotos de redes sociales
En la tabla android.provider.drawable.StreamItemPhotos, se almacenan fotos asociadas con un elemento de la secuencia. La columna android.provider.drawable.StreamItemPhotosColumns#STREAM_ITEM_ID de la tabla establece vínculos con valores de la columna _ID de la tabla android.provider.tables.StreamItems. Las referencias a las fotos se almacenan en las siguientes columnas de la tabla:
- Columna android.provider.ContactsContract.StreamItemPhotos#PHOTO (un BLOB).
- Es una representación binaria de la foto, a la que el proveedor le cambió el tamaño para su almacenamiento y visualización. Esta columna es compatible con versiones anteriores del Proveedor de contactos que la utilizó para almacenar fotos. Sin embargo, en la versión actual no debes usar esta columna para almacenar fotos. En su lugar, usa android.provider.drawable.StreamItemPhotosColumns#PHOTO_FILE_ID o android.provider.tables.StreamItemPhotosColumns#PHOTO_URI (ambos se describen en los siguientes puntos) para guardar fotos en un archivo. Esta columna ahora contiene una miniatura de la foto, que está disponible para su lectura.
- android.provider.ContactsContract.StreamItemPhotosColumns#PHOTO_FILE_ID
-
Es un identificador numérico de la foto de un contacto sin procesar. Agrega este valor a la constante
DisplayPhoto.CONTENT_URIpara obtener un URI de contenido que apunte a un solo archivo de foto y, luego, llama aopenAssetFileDescriptor()para obtener un identificador para el archivo de foto. - android.provider.ContactsContract.StreamItemPhotosColumns#PHOTO_URI
-
Es un URI de contenido que apunta directamente al archivo de foto de la foto representada por esta fila.
Llama a
openAssetFileDescriptor()con este URI a fin de obtener un identificador para el archivo de foto.
Uso de tablas de redes sociales
Estas tablas funcionan de la misma manera que las otras tablas principales en el proveedor de contactos, excepto por lo siguiente:
- Estas tablas requieren permisos de acceso adicionales. Para leerlos, tu aplicación debe tener el permiso android.Manifest.permission#READ_SOCIAL_STREAM. Para modificarlos, tu aplicación debe tener el permiso android.Manifest.permission#WRITE_SOCIAL_STREAM.
-
Para la tabla android.provider.tables.StreamItems, la cantidad de filas almacenadas para cada contacto sin procesar es limitada. Una vez que se alcanza este límite, el proveedor de contactos hace espacio para nuevas filas de elementos del flujo borrando automáticamente las filas que tienen la android.provider.tables.StreamItemsColumns#TIMESTAMP más antiguas. Para obtener el límite, envía una consulta al URI de contenido android.provider.tables.StreamItems#CONTENT_LIMIT_URI. Puedes dejar todos los argumentos excepto el URI de contenido establecidos en
null. La consulta muestra un cursor que contiene una sola fila con la columna única android.provider.tables.StreamItems#MAX_ITEMS.
La clase android.provider.drawable.StreamItems.StreamItemPhotos define una subtabla de android.provider.tables.StreamItemPhotos que contiene las filas de fotos para un solo elemento de la secuencia.
Interacciones con redes sociales
Los datos de redes sociales que administra el Proveedor de contactos, junto con la aplicación de contactos del dispositivo, ofrecen una poderosa manera de conectar tu sistema de redes sociales con los contactos existentes. Están disponibles las siguientes funciones:
- Si sincronizas tu servicio de redes sociales con el Proveedor de contactos mediante un adaptador de sincronización, puedes recuperar la actividad reciente de los contactos de un usuario y guardarla en las tablas android.provider.tables.StreamItems y android.provider.drawable.StreamItemPhotos para usarla más adelante.
- Además de la sincronización regular, puedes activar tu adaptador de sincronización para que recupere datos adicionales cuando el usuario seleccione un contacto para visualizar. Esto le permite a tu adaptador de sincronización recuperar fotos de alta resolución y los elementos más recientes de la secuencia para el contacto.
- Si registras una notificación con la App de contactos del dispositivo y el Proveedor de contactos, puedes recibir un intent cuando se vea un contacto y, en ese momento, actualizar el estado del contacto desde tu servicio. Este enfoque puede ser más rápido y usar menos ancho de banda que si realizaras una sincronización completa con un adaptador de sincronización.
- Los usuarios pueden agregar un contacto a tu servicio de redes sociales mientras lo miran en la app de contactos del dispositivo. Puedes habilitar esto con la función "invitar contacto", que habilitas con una combinación de una actividad que agrega un contacto existente a tu red y un archivo en formato XML que proporciona la aplicación de contactos del dispositivo y el proveedor de contactos con los detalles de tu aplicación.
La sincronización común de los elementos de flujo con el Proveedor de contactos es igual a otras sincronizaciones. Para obtener más información acerca de la sincronización, consulta la sección Adaptadores de sincronización del proveedor de contactos. El registro de notificaciones y la invitación de contactos se analizan en las dos secciones siguientes.
Registro para administrar visualizaciones de redes sociales
Si quieres registrar tu adaptador de sincronización para que reciba notificaciones cuando el usuario visualiza un contacto administrado por él, haz lo siguiente:
-
Crea un archivo llamado
contacts.xmlen el directoriores/xml/de tu proyecto. Si ya tienes este archivo, puedes omitir este paso. -
En este archivo, agrega el elemento
<ContactsAccountType xmlns:android="http://schemas.android.com/apk/res/android">. Si el elemento ya existe, puedes omitir este paso. -
Para registrar un servicio que reciba una notificación cuando el usuario abre la página de detalles de un contacto en la aplicación de contactos del dispositivo, agrega el atributo
viewContactNotifyService="serviceclass"al elemento, dondeserviceclasses el nombre de clase completo del servicio que debe recibir el intent de la aplicación de contactos del dispositivo. Para el servicio de notificación, usa una clase que extiendaIntentServicea fin de permitir que el servicio reciba intents. Los datos del intent entrante contienen el URI de contenido del contacto sin procesar en el que el usuario hizo clic. Desde el servicio de notificación, puedes vincular tu adaptador de sincronización y luego llamarlo para actualizar los datos del contacto sin procesar.
Para registrar una actividad a la que se llamará cuando el usuario haga clic en un elemento o una foto de la secuencia (o en ambos):
-
Crea un archivo llamado
contacts.xmlen el directoriores/xml/de tu proyecto. Si ya tienes este archivo, puedes omitir este paso. -
En este archivo, agrega el elemento
<ContactsAccountType xmlns:android="http://schemas.android.com/apk/res/android">. Si el elemento ya existe, puedes omitir este paso. -
Para registrar una de tus actividades para que controle al usuario que hace clic en un elemento de la secuencia en la aplicación de contactos del dispositivo, agrega el atributo
viewStreamItemActivity="activityclass"al elemento, dondeactivityclasses el nombre de clase completo de la actividad que debe recibir el intent de la aplicación de contactos del dispositivo. -
Para registrar una de tus actividades para que controle al usuario que hace clic en una foto de flujo en la aplicación de contactos del dispositivo, agrega el atributo
viewStreamItemPhotoActivity="activityclass"al elemento, dondeactivityclasses el nombre de clase completo de la actividad que debe recibir el intent de la aplicación de contactos del dispositivo.
El elemento <ContactsAccountType> se describe con más detalle en la sección Elemento<ContactsAccountType>.
La intent entrante contiene el URI de contenido del elemento o la foto en los que el usuario hizo clic. Para tener actividades independientes para los elementos de texto y las fotos, usa ambos atributos en el mismo archivo.
Interacción con tu servicio de redes sociales
No es necesario que los contactos salgan de la app de contactos del dispositivo para invitar a otros a tu sitio de redes sociales. En su lugar, puedes hacer que la App de Contactos del dispositivo envíe un intent para invitar al contacto a una de tus actividades. Sigue estos pasos para configurar la función:
-
Crea un archivo llamado
contacts.xmlen el directoriores/xml/de tu proyecto. Si ya tienes este archivo, puedes omitir este paso. -
En este archivo, agrega el elemento
<ContactsAccountType xmlns:android="http://schemas.android.com/apk/res/android">. Si el elemento ya existe, puedes omitir este paso. -
Agrega los siguientes atributos:
inviteContactActivity="activityclass"-
inviteContactActionLabel="@string/invite_action_label"
activityclasses el nombre de clase completamente calificado de la actividad que debe recibir el intent. El valorinvite_action_labeles una string de texto que se muestra en el menú Agregar conexión en la aplicación de contactos del dispositivo.
Nota: ContactsSource ya no está disponible en ContactsAccountType.
Referencia contacts.xml
El archivo contacts.xml contiene elementos XML que controlan la interacción de tu adaptador de sincronización y tu aplicación con la aplicación de contactos y el Proveedor de contactos. Estos elementos se describen en las siguientes secciones.
Elemento <ContactsAccountType>
El elemento <ContactsAccountType> controla la interacción de tu aplicación con la aplicación de contactos. Tiene la siguiente sintaxis:
<ContactsAccountType
xmlns:android="http://schemas.android.com/apk/res/android"
inviteContactActivity="activity_name"
inviteContactActionLabel="invite_command_text"
viewContactNotifyService="view_notify_service"
viewGroupActivity="group_view_activity"
viewGroupActionLabel="group_action_text"
viewStreamItemActivity="viewstream_activity_name"
viewStreamItemPhotoActivity="viewphotostream_activity_name">
contenido en:
res/xml/contacts.xml
puede contener lo siguiente:
<ContactsDataKind>
Description:
Declara componentes de Android y etiquetas de la IU que permiten a los usuarios invitar a uno de sus contactos a una red social, notificar a los usuarios cuando se actualiza una de sus transmisiones de redes sociales, etcétera.
Ten en cuenta que el prefijo de atributo android: no es necesario para los atributos de <ContactsAccountType>.
Atributos:
inviteContactActivity- Corresponde al nombre de clase completo de la actividad de tu aplicación que quieres activar cuando el usuario selecciona Agregar conexión en la aplicación de contactos del dispositivo.
inviteContactActionLabel-
Es una cadena de texto que se muestra para la actividad especificada en
inviteContactActivity, en el menú Agregar conexión. Por ejemplo, puedes usar la cadena "Sigue mi red". Puedes usar un identificador de recursos de cadenas para esta etiqueta. viewContactNotifyService- Corresponde al nombre de clase completo de un servicio de tu aplicación que debe recibir notificaciones cuando el usuario ve un contacto. La aplicación de contactos del dispositivo envía esta notificación y le permite a tu aplicación posponer las operaciones que consumen muchos datos hasta que sean necesarias. Por ejemplo, tu aplicación puede responder a esta notificación leyendo y mostrando la foto de alta resolución y los elementos más recientes de la red social del contacto. Esta función se describe con más detalle en la sección Interacciones con redes sociales.
viewGroupActivity- Corresponde al nombre de clase completo de una actividad de tu aplicación que puede mostrar información de un grupo. Cuando el usuario hace clic en la etiqueta del grupo en la aplicación de contactos del dispositivo, se muestra la IU para esta actividad.
viewGroupActionLabel- Es la etiqueta que muestra la aplicación de contactos para un control de la IU que le permite al usuario ver grupos en tu aplicación.
Se puede usar un identificador de recursos de cadena para este atributo.
viewStreamItemActivity- Corresponde al nombre de clase completo de una actividad de tu aplicación que la aplicación de contactos del dispositivo lanza cuando el usuario hace clic en un elemento del flujo para un contacto sin procesar.
viewStreamItemPhotoActivity- Corresponde al nombre de clase completo de una actividad de tu aplicación que la aplicación de contactos del dispositivo lanza cuando el usuario hace clic en una foto del elemento del flujo de un contacto sin procesar.
Elemento <ContactsDataKind>
El elemento <ContactsDataKind> controla la visualización de las filas de datos personalizados de tu aplicación en la IU de la aplicación de contactos. Tiene la siguiente sintaxis:
<ContactsDataKind
android:mimeType="MIMEtype"
android:icon="icon_resources"
android:summaryColumn="column_name"
android:detailColumn="column_name">
contenido en:
<ContactsAccountType>
Description:
Usa este elemento para que la aplicación de contactos muestre el contenido de una fila de datos personalizados como parte de los detalles de un contacto sin procesar. Cada elemento secundario <ContactsDataKind> de <ContactsAccountType> representa un tipo de fila de datos personalizados que tu adaptador de sincronización agrega a la tabla ContactsContract.Data. Agrega un elemento <ContactsDataKind> por cada tipo de MIME personalizado que uses. No es necesario que agregues el elemento si tienes una fila de datos personalizados para la que no deseas mostrar datos.
Atributos:
android:mimeType-
Es el tipo de MIME personalizado que definiste para uno de los tipos de filas de datos personalizados en la tabla
ContactsContract.Data. Por ejemplo, el valorvnd.android.cursor.item/vnd.example.locationstatuspodría ser un tipo de MIME personalizado para una fila de datos que registra la última ubicación conocida de un contacto. android:icon- Es un recurso de elementos de diseño de Android que la app de contactos muestra junto a tus datos. Úsalo para indicarle al usuario que los datos provienen de tu servicio.
android:summaryColumn- Es el nombre de columna para los primeros dos valores recuperados de la fila de datos. El valor se muestra como la primera línea de la entrada de esta fila de datos. Se prevé que la primera línea se use como resumen de los datos, pero es opcional. Consulta también android:detailColumn.
android:detailColumn- El nombre de columna para los segundos dos valores recuperados de la fila de datos. El valor se muestra como la segunda línea de la entrada de esta fila de datos. Consulta también
android:summaryColumn.
Otras funciones del proveedor de contactos
Además de las funciones principales descritas en las secciones anteriores, el Proveedor de contactos ofrece las siguientes funciones útiles para trabajar con datos de contactos:
- Grupos de contactos
- Funciones de fotografía
Grupos de contactos
De manera opcional, el Proveedor de contactos puede etiquetar conjuntos de contactos relacionados con datos de grupos. Si el servidor asociado con una cuenta de usuario desea mantener grupos, el adaptador de sincronización para el tipo de cuenta de la cuenta debe transferir datos de grupos entre el Proveedor de contactos y el servidor. Cuando los usuarios agregan un contacto nuevo al servidor y, luego, lo colocan en un grupo nuevo, el adaptador de sincronización debe agregar el nuevo grupo a la tabla ContactsContract.Groups. El grupo o grupos a los que pertenece un contacto sin procesar se almacenan en la tabla ContactsContract.Data con el tipo de MIME ContactsContract.CommonDataKinds.GroupMembership.
Si estás diseñando un adaptador de sincronización que agregará datos de contactos sin procesar del servidor al proveedor de contactos y no estás usando grupos, debes indicarle al proveedor que permita que tus datos sean visibles. En el código que se ejecuta cuando un usuario agrega una cuenta al dispositivo, actualiza la fila de ContactsContract.Settings que el proveedor de contactos agrega para la cuenta. En esta fila, establece el valor de la columna Settings.UNGROUPED_VISIBLE en 1. Cuando lo hagas, el Proveedor de contactos siempre permitirá que los datos de tus contactos estén visibles, incluso si no usas grupos.
Fotos de contactos
La tabla ContactsContract.Data almacena fotos como filas con el tipo de MIME Photo.CONTENT_ITEM_TYPE. La columna CONTACT_ID de la fila está vinculada a la columna _ID del contacto sin procesar al que pertenece.
La clase ContactsContract.Contacts.Photo define una subtabla de ContactsContract.Contacts que contiene información de foto de la foto principal de un contacto, que es la foto principal del contacto sin procesar principal del contacto. De manera similar, la clase ContactsContract.RawContacts.DisplayPhoto define una subtabla de ContactsContract.RawContacts que contiene información de foto de la foto principal de un contacto sin procesar.
La documentación de referencia de ContactsContract.Contacts.Photo y ContactsContract.RawContacts.DisplayPhoto contiene ejemplos de cómo recuperar información de la foto. No hay una clase de conveniencia para recuperar la miniatura principal de un contacto sin procesar, pero puedes enviar una consulta a la tabla ContactsContract.Data y seleccionar _ID, Photo.CONTENT_ITEM_TYPE y IS_PRIMARY del contacto sin procesar para buscar la fila de foto principal del contacto sin procesar.
Los datos de redes sociales de una persona también pueden incluir fotos. Se almacenan en la tabla android.provider.drawable.StreamItemPhotos, que se describe más detalladamente en la sección Fotos de redes sociales.