Modifier des contacts à l'aide d'intents

Cette leçon vous explique comment utiliser un Intent pour insérer un nouveau contact ou modifier les données d'un contact. Au lieu d'accéder directement au fournisseur de contacts, Intent lance l'application Contacts, qui exécute les applications Activity Pour les actions de modification décrites dans cette leçon, si vous envoyez des données étendues dans Intent, elles sont saisies dans l'UI de Activity qui est lancée.

Il est recommandé d'utiliser un Intent pour insérer ou mettre à jour un seul contact. de modifier le fournisseur de contacts pour les raisons suivantes:

• Elle vous épargne le temps et les efforts nécessaires au développement de votre propre interface utilisateur et de votre propre code.
• Cela évite d'introduire des erreurs causées par des modifications qui ne respectent pas les Règles du fournisseur de contacts.
• Elle réduit le nombre d'autorisations que vous devez demander. Votre application n'a pas besoin d'autorisation pour écrire au fournisseur de contacts, car elle délègue les modifications à l'application Contacts, qui dispose déjà de cette autorisation.

Insérer un nouveau contact à l'aide d'un intent

Vous souhaitez souvent autoriser l'utilisateur à insérer un nouveau contact lorsque votre application reçoit de nouvelles données. Pour exemple, une application d'avis sur les restaurants peut permettre aux utilisateurs d'ajouter le restaurant en tant que contact les examiner. Pour ce faire, utilisez un intent en utilisant autant de données que possible. puis envoyez l'intent à l'application Contacts.

Lorsque vous insérez un contact à l'aide de l'application Contacts, un nouveau contact brut est inséré dans Contacts. Table ContactsContract.RawContacts du fournisseur. Si nécessaire, l'application Contacts invite l'utilisateur à indiquer le type de compte et le compte à utiliser lors de la création du compte contact. L'application Contacts informe également les utilisateurs si le contact brut existe déjà. Les utilisateurs ont ensuite la possibilité d'annuler l'insertion, auquel cas aucun contact n'est créé. Pour apprendre en savoir plus sur les contacts bruts, consultez Fournisseur de contacts Guide de l'API.

Créer un intent

Pour commencer, créez un objet Intent avec l'action Intents.Insert.ACTION. Définissez le type MIME sur RawContacts.CONTENT_TYPE. Exemple :

...
// Creates a new Intent to insert a contact
val intent = Intent(ContactsContract.Intents.Insert.ACTION).apply {
    // Sets the MIME type to match the Contacts Provider
    type = ContactsContract.RawContacts.CONTENT_TYPE
}

...
// Creates a new Intent to insert a contact
Intent intent = new Intent(ContactsContract.Intents.Insert.ACTION);
// Sets the MIME type to match the Contacts Provider
intent.setType(ContactsContract.RawContacts.CONTENT_TYPE);

Si vous disposez déjà d'informations sur le contact, telles qu'un numéro de téléphone ou une adresse e-mail, vous pouvez les insérer dans l'intent en tant que données étendues. Pour une valeur de clé, utilisez la constante appropriée de Intents.Insert. L'application Contacts affiche les données dans son écran d'insertion, ce qui permet aux utilisateurs de continuer à les modifier et à les ajouter.

private var emailAddress: EditText? = null
private var phoneNumber: EditText? = null
...
/* Assumes EditText fields in your UI contain an email address
 * and a phone number.
 *
 */
emailAddress = findViewById(R.id.email)
phoneNumber = findViewById(R.id.phone)
...
/*
 * Inserts new data into the Intent. This data is passed to the
 * contacts app's Insert screen
 */
intent.apply {
    // Inserts an email address
    putExtra(ContactsContract.Intents.Insert.EMAIL, emailAddress?.text)
    /*
     * In this example, sets the email type to be a work email.
     * You can set other email types as necessary.
     */
    putExtra(
            ContactsContract.Intents.Insert.EMAIL_TYPE,
            ContactsContract.CommonDataKinds.Email.TYPE_WORK
    )
    // Inserts a phone number
    putExtra(ContactsContract.Intents.Insert.PHONE, phoneNumber?.text)
    /*
     * In this example, sets the phone type to be a work phone.
     * You can set other phone types as necessary.
     */
    putExtra(
            ContactsContract.Intents.Insert.PHONE_TYPE,
            ContactsContract.CommonDataKinds.Phone.TYPE_WORK
    )
}

private EditText emailAddress = null;
private EditText phoneNumber = null;
...
/* Assumes EditText fields in your UI contain an email address
 * and a phone number.
 *
 */
emailAddress = (EditText) findViewById(R.id.email);
phoneNumber = (EditText) findViewById(R.id.phone);
...
/*
 * Inserts new data into the Intent. This data is passed to the
 * contacts app's Insert screen
 */
// Inserts an email address
intent.putExtra(ContactsContract.Intents.Insert.EMAIL, emailAddress.getText())
/*
 * In this example, sets the email type to be a work email.
 * You can set other email types as necessary.
 */
      .putExtra(ContactsContract.Intents.Insert.EMAIL_TYPE,
            ContactsContract.CommonDataKinds.Email.TYPE_WORK)
// Inserts a phone number
      .putExtra(ContactsContract.Intents.Insert.PHONE, phoneNumber.getText())
/*
 * In this example, sets the phone type to be a work phone.
 * You can set other phone types as necessary.
 */
      .putExtra(ContactsContract.Intents.Insert.PHONE_TYPE,
            ContactsContract.CommonDataKinds.Phone.TYPE_WORK);

Une fois que vous avez créé le Intent, envoyez-le en appelant startActivity()

    /* Sends the Intent
     */
    startActivity(intent)

    /* Sends the Intent
     */
    startActivity(intent);

Cet appel ouvre un écran dans l'application Contacts qui permet aux utilisateurs de saisir un nouveau contact. Le type et le nom du compte du contact sont indiqués en haut de l'écran. Une fois que les utilisateurs ont saisi les données et cliqué sur OK, la liste de contacts de l'application Contacts s'affiche. Les utilisateurs reviennent sur votre application en cliquant sur Retour.

Modifier un contact existant à l'aide d'un intent

Modifier un contact existant à l'aide d'un Intent est utile si l'utilisateur a déjà choisi un contact qui l'intéresse. Par exemple, une application qui trouve des contacts ayant adresses postales mais sans code postal pourrait donner aux utilisateurs la possibilité de rechercher le code et puis en l'ajoutant au contact.

Pour modifier un contact existant à l'aide d'un intent, procédez comme pour insérer un contact. Créez un intent comme décrit dans la section Insérer un contact à l'aide d'un intent, mais ajoutez le Contacts.CONTENT_LOOKUP_URI du contact et le type MIME Contacts.CONTENT_ITEM_TYPE à l'intent. Si vous souhaitez modifier le contact avec des informations que vous possédez déjà, vous pouvez les placer dans les données étendues de l'intent. Notez que certaines colonnes de noms ne peuvent pas être modifiées à l'aide d'un intent. Ces colonnes sont listées dans la section récapitulative de la documentation de référence de l'API pour la classe ContactsContract.Contacts sous l'en-tête "Mise à jour".

Enfin, envoyez l'intent. En réponse, l'application Contacts affiche un écran de modification. Lorsque l'utilisateur a terminé de modifier et d'enregistrer les modifications, l'application Contacts affiche une liste de contacts. Lorsque l'utilisateur clique sur Retour, votre application s'affiche.

Créer l'intent

Pour modifier un contact, appelez Intent(action) pour Créez un intent avec l'action ACTION_EDIT. Appeler setDataAndType() pour définir la valeur des données l'intent vers le Contacts.CONTENT_LOOKUP_URI du contact et le type MIME pour Contacts.CONTENT_ITEM_TYPE type MIME ; parce qu'un appel à setType() écrase la valeur de données actuelle pour le paramètre Intent, vous devez définir les données et le type MIME en même temps.

Pour obtenir l'Contacts.CONTENT_LOOKUP_URI d'un contact, appelez Contacts.getLookupUri(id, lookupkey) avec les valeurs Contacts._ID et Contacts.LOOKUP_KEY du contact comme arguments.

Remarque:L'adresse e-mail d'un contact La valeur LOOKUP_KEY est l'identifiant que vous devez utiliser pour récupérer un contact. Elle reste constante, même si le fournisseur modifie l'ID de ligne du contact pour gérer les opérations internes.

L'extrait de code suivant montre comment créer un intent:

    // The Cursor that contains the Contact row
    var mCursor: Cursor? = null
    // The index of the lookup key column in the cursor
    var lookupKeyIndex: Int = 0
    // The index of the contact's _ID value
    var idIndex: Int = 0
    // The lookup key from the Cursor
    var currentLookupKey: String? = null
    // The _ID value from the Cursor
    var currentId: Long = 0
    // A content URI pointing to the contact
    var selectedContactUri: Uri? = null
    ...
    /*
     * Once the user has selected a contact to edit,
     * this gets the contact's lookup key and _ID values from the
     * cursor and creates the necessary URI.
     */
    mCursor?.apply {
        // Gets the lookup key column index
        lookupKeyIndex = getColumnIndex(ContactsContract.Contacts.LOOKUP_KEY)
        // Gets the lookup key value
        currentLookupKey = getString(lookupKeyIndex)
        // Gets the _ID column index
        idIndex = getColumnIndex(ContactsContract.Contacts._ID)
        currentId = getLong(idIndex)
        selectedContactUri = ContactsContract.Contacts.getLookupUri(currentId, mCurrentLookupKey)
    }

    // Creates a new Intent to edit a contact
    val editIntent = Intent(Intent.ACTION_EDIT).apply {
        /*
         * Sets the contact URI to edit, and the data type that the
         * Intent must match
         */
        setDataAndType(selectedContactUri, ContactsContract.Contacts.CONTENT_ITEM_TYPE)
    }

    // The Cursor that contains the Contact row
    public Cursor mCursor;
    // The index of the lookup key column in the cursor
    public int lookupKeyIndex;
    // The index of the contact's _ID value
    public int idIndex;
    // The lookup key from the Cursor
    public String currentLookupKey;
    // The _ID value from the Cursor
    public long currentId;
    // A content URI pointing to the contact
    Uri selectedContactUri;
    ...
    /*
     * Once the user has selected a contact to edit,
     * this gets the contact's lookup key and _ID values from the
     * cursor and creates the necessary URI.
     */
    // Gets the lookup key column index
    lookupKeyIndex = mCursor.getColumnIndex(ContactsContract.Contacts.LOOKUP_KEY);
    // Gets the lookup key value
    currentLookupKey = mCursor.getString(lookupKeyIndex);
    // Gets the _ID column index
    idIndex = mCursor.getColumnIndex(ContactsContract.Contacts._ID);
    currentId = mCursor.getLong(idIndex);
    selectedContactUri =
            Contacts.getLookupUri(currentId, mCurrentLookupKey);
    ...
    // Creates a new Intent to edit a contact
    Intent editIntent = new Intent(Intent.ACTION_EDIT);
    /*
     * Sets the contact URI to edit, and the data type that the
     * Intent must match
     */
    editIntent.setDataAndType(selectedContactUri, ContactsContract.Contacts.CONTENT_ITEM_TYPE);

Ajouter l'indicateur de navigation

Sur Android 4.0 (version 14 de l'API) ou version ultérieure, un problème dans l'application Contacts entraîne des erreurs la navigation. Lorsque votre application envoie un intent de modification à l'application Contacts, et que les utilisateurs modifient et enregistrent un contact, ils voient l'écran de la liste de contacts lorsqu'ils cliquent sur Retour. Pour revenir à votre application, ils doivent cliquer sur Récents et choisir votre application.

Pour contourner ce problème sous Android 4.0.3 (version 15 de l'API) ou version ultérieure, ajoutez l'extension clé de données finishActivityOnSaveCompleted à l'intent, avec la valeur true. Les versions d'Android antérieures à Android 4.0 acceptent cette clé, mais elle n'a aucun effet. Pour définir le paramètre données étendues, procédez comme suit:

    // Sets the special extended data for navigation
    editIntent.putExtra("finishActivityOnSaveCompleted", true)

    // Sets the special extended data for navigation
    editIntent.putExtra("finishActivityOnSaveCompleted", true);

Ajouter d'autres données étendues

Pour ajouter des données étendues supplémentaires au Intent, appelez putExtra() comme vous le souhaitez. Vous pouvez ajouter des données étendues pour les champs de contact courants à l'aide des valeurs de clé spécifiées dans Intents.Insert. N'oubliez pas que certaines colonnes du tableau ContactsContract.Contacts ne peuvent pas être modifiées. Ces colonnes sont listées dans la section récapitulative de la documentation de référence de l'API pour la classe ContactsContract.Contacts sous l'en-tête "Mise à jour".

Envoyer l'intent

Enfin, envoyez l'intent que vous avez créé. Exemple :

    // Sends the Intent
    startActivity(editIntent)

    // Sends the Intent
    startActivity(editIntent);

Laisser les utilisateurs choisir d'insérer ou de modifier un intent

Vous pouvez autoriser les utilisateurs à choisir d'insérer un contact ou de modifier un contact existant en envoyant un élément Intent avec l'action ACTION_INSERT_OR_EDIT Par exemple, une application de client de messagerie peut autoriser les utilisateurs à ajouter une adresse e-mail entrante à un nouveau contact ou à l'ajouter en tant qu'adresse supplémentaire pour un contact existant. Définissez le type MIME de cet intent sur Contacts.CONTENT_ITEM_TYPE, mais ne définissez pas d'URI de données.

Lorsque vous envoyez cet intent, l'application Contacts affiche une liste de contacts. Les utilisateurs peuvent insérer un nouveau contact ou en sélectionner un existant et le modifier. Tous les champs de données étendus que vous ajoutez à l'intent remplissent l'écran qui s'affiche. Vous pouvez utiliser l'une des valeurs de clé spécifiées dans Intents.Insert. L'extrait de code suivant montre comment créer et envoyer l'intent :

    // Creates a new Intent to insert or edit a contact
    val intentInsertEdit = Intent(Intent.ACTION_INSERT_OR_EDIT).apply {
        // Sets the MIME type
        type = ContactsContract.Contacts.CONTENT_ITEM_TYPE
    }
    // Add code here to insert extended data, if desired

    // Sends the Intent with an request ID
    startActivity(intentInsertEdit)

    // Creates a new Intent to insert or edit a contact
    Intent intentInsertEdit = new Intent(Intent.ACTION_INSERT_OR_EDIT);
    // Sets the MIME type
    intentInsertEdit.setType(ContactsContract.Contacts.CONTENT_ITEM_TYPE);
    // Add code here to insert extended data, if desired
    ...
    // Sends the Intent with an request ID
    startActivity(intentInsertEdit);