Recuperare i dettagli di un contatto

Questa lezione mostra come recuperare i dati di dettaglio di un contatto, come indirizzi email, numeri di telefono e così via. Sono i dettagli che gli utenti cercano quando recuperano un contatto. Puoi fornire tutti i dettagli di un contatto o visualizzare solo i dettagli di un tipo specifico, ad esempio gli indirizzi email.

I passaggi di questa lezione presuppongono che tu abbia già una ContactsContract.Contacts riga per un contatto scelto dall'utente. La lezione Recuperare i nomi dei contatti mostra come recuperare un elenco di contatti.

Recuperare tutti i dettagli di un contatto

Per recuperare tutti i dettagli di un contatto, cerca nella ContactsContract.Data tabella le righe che contengono la LOOKUP_KEY del contatto. Questa colonna è disponibile in la tabella ContactsContract.Data perché il provider di contatti esegue un join implicito tra la tabella ContactsContract.Contacts e la tabella ContactsContract.Data. La colonna LOOKUP_KEY è descritta in modo più dettagliato nella lezione Recuperare i nomi dei contatti.

Nota: il recupero di tutti i dettagli di un contatto riduce il rendimento di un dispositivo perché deve recuperare tutte le colonne della ContactsContract.Data tabella. Prima di utilizzare questa tecnica, valuta l'impatto sul rendimento.

Richiedere autorizzazioni

Per leggere dal provider di contatti, la tua app deve disporre dell'autorizzazione READ_CONTACTS. Per richiedere questa autorizzazione, aggiungi il seguente elemento secondario di <manifest> al file manifest:

    <uses-permission android:name="android.permission.READ_CONTACTS" />

Configurare una proiezione

A seconda del tipo di dati contenuti in una riga, questa potrebbe utilizzare solo alcune colonne o molte. Inoltre, i dati si trovano in colonne diverse a seconda del tipo di dati. Per assicurarti di ottenere tutte le colonne possibili per tutti i tipi di dati possibili, devi aggiungere tutti i nomi delle colonne alla proiezione. Recupera sempre Data._ID se stai associando il risultato Cursor a un ListView; in caso contrario, l'associazione non funzionerà. Recupera anche Data.MIMETYPE in modo da poter identificare il tipo di dati di ogni riga recuperata. Ad esempio:

Kotlin

private val PROJECTION: Array<out String> = arrayOf(
        ContactsContract.Data._ID,
        ContactsContract.Data.MIMETYPE,
        ContactsContract.Data.DATA1,
        ContactsContract.Data.DATA2,
        ContactsContract.Data.DATA3,
        ContactsContract.Data.DATA4,
        ContactsContract.Data.DATA5,
        ContactsContract.Data.DATA6,
        ContactsContract.Data.DATA7,
        ContactsContract.Data.DATA8,
        ContactsContract.Data.DATA9,
        ContactsContract.Data.DATA10,
        ContactsContract.Data.DATA11,
        ContactsContract.Data.DATA12,
        ContactsContract.Data.DATA13,
        ContactsContract.Data.DATA14,
        ContactsContract.Data.DATA15
)

Java

    private static final String[] PROJECTION =
            {
                ContactsContract.Data._ID,
                ContactsContract.Data.MIMETYPE,
                ContactsContract.Data.DATA1,
                ContactsContract.Data.DATA2,
                ContactsContract.Data.DATA3,
                ContactsContract.Data.DATA4,
                ContactsContract.Data.DATA5,
                ContactsContract.Data.DATA6,
                ContactsContract.Data.DATA7,
                ContactsContract.Data.DATA8,
                ContactsContract.Data.DATA9,
                ContactsContract.Data.DATA10,
                ContactsContract.Data.DATA11,
                ContactsContract.Data.DATA12,
                ContactsContract.Data.DATA13,
                ContactsContract.Data.DATA14,
                ContactsContract.Data.DATA15
            };

Questa proiezione recupera tutte le colonne di una riga nella ContactsContract.Data tabella, utilizzando i nomi delle colonne definiti nella classe ContactsContract.Data.

Facoltativamente, puoi anche utilizzare altre costanti di colonna definite o ereditate dalla ContactsContract.Data classe. Tieni presente, tuttavia, che le colonne SYNC1 attraverso SYNC4 sono destinate all'uso da parte degli adattatori di sincronizzazione, quindi i relativi dati non sono utili.

Definire i criteri di selezione

Definisci una costante per la clausola di selezione, un array per contenere gli argomenti di selezione e una variabile per contenere il valore di selezione. Utilizza la Contacts.LOOKUP_KEY colonna per trovare il contatto. Ad esempio:

Kotlin

// Defines the selection clause
private const val SELECTION: String = "${ContactsContract.Data.LOOKUP_KEY} = ?"
...
// Defines the array to hold the search criteria
private val selectionArgs: Array<String> = arrayOf("")
/*
 * Defines a variable to contain the selection value. Once you
 * have the Cursor from the Contacts table, and you've selected
 * the desired row, move the row's LOOKUP_KEY value into this
 * variable.
 */
private var lookupKey: String? = null

Java

    // Defines the selection clause
    private static final String SELECTION = Data.LOOKUP_KEY + " = ?";
    // Defines the array to hold the search criteria
    private String[] selectionArgs = { "" };
    /*
     * Defines a variable to contain the selection value. Once you
     * have the Cursor from the Contacts table, and you've selected
     * the desired row, move the row's LOOKUP_KEY value into this
     * variable.
     */
    private lateinit var lookupKey: String

L'utilizzo di "?" come segnaposto nell'espressione di testo di selezione garantisce che la ricerca risultante venga generata tramite l'associazione anziché la compilazione SQL. Questo approccio elimina la la possibilità di SQL injection dannose.

Definire l'ordinamento

Definisci l'ordinamento che vuoi nel Cursor risultante. Per mantenere tutte le righe per un determinato tipo di dati, ordina per Data.MIMETYPE. Questo argomento della query raggruppa tutte le righe di email, tutte le righe di telefono e così via. Ad esempio:

Kotlin

/*
 * Defines a string that specifies a sort order of MIME type
 */
private const val SORT_ORDER = ContactsContract.Data.MIMETYPE

Java

    /*
     * Defines a string that specifies a sort order of MIME type
     */
    private static final String SORT_ORDER = ContactsContract.Data.MIMETYPE;

Nota: alcuni tipi di dati non utilizzano un sottotipo, quindi non puoi ordinare in base al sottotipo. Dovrai invece scorrere il Cursor, determinare il tipo di dati della riga corrente e archiviare i dati per le righe che utilizzano un sottotipo. Al termine della lettura del cursore, puoi ordinare ogni tipo di dati per sottotipo e visualizzare i risultati.

Inizializzare il caricatore

Esegui sempre i recuperi dal provider di contatti (e da tutti gli altri provider di contenuti) in un thread in background. Utilizza il framework del caricatore definito dalla LoaderManager classe e dalla LoaderManager.LoaderCallbacks interfaccia per eseguire i recuperi in background.

Quando è tutto pronto per recuperare le righe, inizializza il framework del caricatore chiamando initLoader(). Passa un identificatore intero al metodo; questo identificatore viene passato ai LoaderManager.LoaderCallbacks metodi. L'identificatore ti aiuta a utilizzare più caricatori in un'app consentendoti di distinguerli.

Il seguente snippet mostra come inizializzare il framework del caricatore:

Kotlin

// Defines a constant that identifies the loader
private const val DETAILS_QUERY_ID: Int = 0

class DetailsFragment : Fragment(), LoaderManager.LoaderCallbacks<Cursor> {
    ...
    override fun onCreate(savedInstanceState: Bundle?) {
        ...
        // Initializes the loader framework
        loaderManager.initLoader(DETAILS_QUERY_ID, null, this)

Java

public class DetailsFragment extends Fragment implements
        LoaderManager.LoaderCallbacks<Cursor> {
    ...
    // Defines a constant that identifies the loader
    static int DETAILS_QUERY_ID = 0;
    ...
    @Override
    public void onCreate(Bundle savedInstanceState) {
        ...
        // Initializes the loader framework
        getLoaderManager().initLoader(DETAILS_QUERY_ID, null, this);

Implementare onCreateLoader()

Implementa il metodo onCreateLoader(), chiamato dal framework del caricatore immediatamente dopo aver chiamato initLoader(). Restituisci un CursorLoader da questo metodo. Poiché stai cercando la tabella ContactsContract.Data, utilizza la costante Data.CONTENT_URI come URI dei contenuti. Ad esempio:

Kotlin

override fun onCreateLoader(loaderId: Int, args: Bundle?): Loader<Cursor> {
    // Choose the proper action
    mLoader = when(loaderId) {
        DETAILS_QUERY_ID -> {
            // Assigns the selection parameter
            selectionArgs[0] = lookupKey
            // Starts the query
            activity?.let {
                CursorLoader(
                        it,
                        ContactsContract.Data.CONTENT_URI,
                        PROJECTION,
                        SELECTION,
                        selectionArgs,
                        SORT_ORDER
                )
            }
        }
        ...
    }
    return mLoader
}

Java

@Override
    public Loader<Cursor> onCreateLoader(int loaderId, Bundle args) {
        // Choose the proper action
        switch (loaderId) {
            case DETAILS_QUERY_ID:
            // Assigns the selection parameter
            selectionArgs[0] = lookupKey;
            // Starts the query
            CursorLoader mLoader =
                    new CursorLoader(
                            getActivity(),
                            ContactsContract.Data.CONTENT_URI,
                            PROJECTION,
                            SELECTION,
                            selectionArgs,
                            SORT_ORDER
                    );
    }

Implementare onLoadFinished() e onLoaderReset()

Implementa il onLoadFinished() metodo. Il framework del caricatore chiama onLoadFinished() quando il provider di contatti restituisce i risultati della query. Ad esempio:

Kotlin

    override fun onLoadFinished(loader: Loader<Cursor>, data: Cursor) {
        when(loader.id) {
            DETAILS_QUERY_ID -> {
                /*
                 * Process the resulting Cursor here.
                 */
            }
            ...
        }
    }

Java

    @Override
    public void onLoadFinished(Loader<Cursor> loader, Cursor cursor) {
        switch (loader.getId()) {
            case DETAILS_QUERY_ID:
                    /*
                     * Process the resulting Cursor here.
                     */
                }
                break;
            ...
        }
    }

Il metodo onLoaderReset() viene richiamato quando il framework del caricatore rileva che i dati di backup del risultato Cursor sono cambiati. A questo punto, rimuovi tutti i riferimenti esistenti al Cursor impostandoli su null. In caso contrario, il framework del caricatore non distruggerà il vecchio Cursor e si verificherà una perdita di memoria. Ad esempio:

Kotlin

    override fun onLoaderReset(loader: Loader<Cursor>) {
        when (loader.id) {
            DETAILS_QUERY_ID -> {
                /*
                 * If you have current references to the Cursor,
                 * remove them here.
                 */
            }
            ...
        }
    }

Java

    @Override
    public void onLoaderReset(Loader<Cursor> loader) {
        switch (loader.getId()) {
            case DETAILS_QUERY_ID:
                /*
                 * If you have current references to the Cursor,
                 * remove them here.
                 */
                }
                break;
    }

Recuperare dettagli specifici di un contatto

Il recupero di un tipo di dati specifico per un contatto, ad esempio tutte le email, segue lo stesso pattern del recupero di tutti i dettagli. Queste sono le uniche modifiche che devi apportare al codice elencato in Recuperare tutti i dettagli di un contatto:

Proiezione
Modifica la proiezione per recuperare le colonne specifiche del tipo di dati. Modifica anche la proiezione in modo da utilizzare le costanti dei nomi delle colonne definite nella ContactsContract.CommonDataKinds sottoclasse corrispondente al tipo di dati.
Selezione
Modifica il testo di selezione per cercare il MIMETYPE valore specifico del tipo di dati.
Ordinamento
Poiché stai selezionando un solo tipo di dettagli, non raggruppare il Cursor per Data.MIMETYPE.

Queste modifiche sono descritte nelle sezioni seguenti.

Definire una proiezione

Definisci le colonne che vuoi recuperare utilizzando le costanti dei nomi delle colonne nella sottoclasse di ContactsContract.CommonDataKinds per il tipo di dati. Se prevedi di associare il Cursor a un ListView, assicurati di recuperare la colonna _ID. Ad esempio, per recuperare i dati delle email, definisci la seguente proiezione:

Kotlin

private val PROJECTION: Array<String> = arrayOf(
        ContactsContract.CommonDataKinds.Email._ID,
        ContactsContract.CommonDataKinds.Email.ADDRESS,
        ContactsContract.CommonDataKinds.Email.TYPE,
        ContactsContract.CommonDataKinds.Email.LABEL
)

Java

    private static final String[] PROJECTION =
            {
                ContactsContract.CommonDataKinds.Email._ID,
                ContactsContract.CommonDataKinds.Email.ADDRESS,
                ContactsContract.CommonDataKinds.Email.TYPE,
                ContactsContract.CommonDataKinds.Email.LABEL
            };

Tieni presente che questa proiezione utilizza i nomi delle colonne definiti nella classe ContactsContract.CommonDataKinds.Email, anziché i nomi delle colonne definiti nella classe ContactsContract.Data. L'utilizzo dei nomi delle colonne specifici per le email rende il codice più leggibile.

Nella proiezione puoi anche utilizzare una qualsiasi delle altre colonne definite nella ContactsContract.CommonDataKinds sottoclasse.

Definire i criteri di selezione

Definisci un'espressione di testo di ricerca che recuperi le righe per la LOOKUP_KEY di un contatto specifico e il Data.MIMETYPE dei dettagli che ti interessano. Racchiudi il valore MIMETYPE tra virgolette singole concatenando un carattere "'" (virgoletta singola) all'inizio e alla fine della costante; in caso contrario, il provider interpreta la costante come un nome di variabile anziché come un valore stringa. Non devi utilizzare un segnaposto per questo valore perché stai utilizzando una costante anziché un valore fornito dall'utente. Ad esempio:

Kotlin

/*
 * Defines the selection clause. Search for a lookup key
 * and the Email MIME type
 */
private const val SELECTION =
        "${ContactsContract.Data.LOOKUP_KEY} = ? AND " +
        "${ContactsContract.Data.MIMETYPE} = '${Email.CONTENT_ITEM_TYPE}'"
...
// Defines the array to hold the search criteria
private val selectionArgs: Array<String> = arrayOf("")

Java

    /*
     * Defines the selection clause. Search for a lookup key
     * and the Email MIME type
     */
    private static final String SELECTION =
            Data.LOOKUP_KEY + " = ?" +
            " AND " +
            Data.MIMETYPE + " = " +
            "'" + Email.CONTENT_ITEM_TYPE + "'";
    // Defines the array to hold the search criteria
    private String[] selectionArgs = { "" };

Definire un ordinamento

Definisci un ordinamento per il Cursor restituito. Poiché stai recuperando un tipo di dati specifico, ometti l'ordinamento su MIMETYPE. Se invece il tipo di dati di dettaglio che stai cercando include un sottotipo, ordina in base a quest'ultimo. Ad esempio, per i dati delle email puoi ordinare in base a Email.TYPE:

Kotlin

private const val SORT_ORDER: String = "${Email.TYPE} ASC"

Java

    private static final String SORT_ORDER = Email.TYPE + " ASC ";