Guide
Comment utiliser les Contacts dans Capacitor
Utilisation de @capgo/capacitor-contacts
Interface du plugin Capacitor pour gérer les contacts du dispositif.
Installer
bun add @capgo/capacitor-contacts
bunx cap sync
bunx cap sync copie le plugin natif code dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.
Importer
import { CapacitorContacts } from '@capgo/capacitor-contacts';
API en un coup d'œil
| Méthode | Description |
|---|---|
countContacts |
Comptez le nombre total de contacts sur le dispositif. |
createContact |
Créez un nouveau contact de manière programmée. |
createGroup |
Créez un nouveau groupe de contacts. |
deleteContactById |
Supprimer un contact par son ID. |
deleteGroupById |
Supprimer un groupe par son ID. |
displayContactById |
Afficher un contact à l'aide du visionneur de contacts natif. |
displayCreateContact |
Afficher l'interface de création de contact natif. |
displayUpdateContactById |
Afficher l'interface de mise à jour de contact natif pour un contact spécifique. |
getAccounts |
Obtenir tous les comptes disponibles sur le dispositif. |
getContactById |
Obtenir un contact spécifique par son ID. |
getContacts |
Obtenir tous les contacts du dispositif. |
getGroupById |
Obtenir un groupe spécifique par son ID. |
getGroups |
Obtenir tous les groupes de contacts. |
isAvailable |
Vérifier si les contacts sont disponibles sur le dispositif. |
isSupported |
Vérifier si le plugin est pris en charge sur la plateforme actuelle. |
openSettings |
Ouvrez les paramètres de contacts du dispositif. |
pickContact |
Choisissez un contact unique à l'aide du sélecteur de contacts natif. |
pickContacts |
Choisissez un ou plusieurs contacts à l'aide du sélecteur de contacts natif. |
updateContactById |
Mettez à jour un contact existant par son ID. |
checkPermissions |
Vérifiez l'état actuel des autorisations pour les contacts. |
requestPermissions |
Demandez les autorisations pour accéder aux contacts. |
Exemples
countContacts()
Comptez le nombre total de contacts sur le dispositif.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.countContacts();
console.log(result);
createContact()
Créez un nouveau contact de manière programmée.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.createContact({ contact: {} });
console.log(result);
createGroup()
Créez un nouveau groupe de contacts.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.createGroup({ group: { name: 'example' } });
console.log(result);
deleteContactById()
Supprimez un contact par son ID.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.deleteContactById({ id: 'id-123' });
deleteGroupById()
Supprimez un groupe par son ID.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.deleteGroupById({ id: 'id-123' });
displayContactById()
Affichez un contact à l'aide du visionneur de contacts natif.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.displayContactById({ id: 'id-123' });
La table ci-dessus liste les 21 méthodes de base. Les écouteurs et les aides de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le répertoire GitHub.
Référence complète
Continuez à partir de l'utilisation de @capgo/capacitor-contacts
Si vous utilisez Utilisation de @capgo/capacitor-contacts planifier le tableau de bord et les opérations API, connectez-l’avec @capgo/capacitor-contacts pour le détail de mise en œuvre dans @capgo/capacitor-contacts, Démarrage rapide pour le détail de mise en œuvre dans Démarrage rapide, API Vue d'ensemble Pour les détails d'implémentation dans API Vue d'ensemble. Introduction pour le détail de mise en œuvre dans l'Introduction, et API Clés pour le détail de mise en œuvre dans API Clés.