Guide
Comment utiliser Contacts dans Capacitor
Utiliser @capgo/capacitor-contacts
Interface du plugin Capacitor Contacts pour gérer les contacts de l’appareil.
Installer
bun add @capgo/capacitor-contacts
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { CapacitorContacts } from '@capgo/capacitor-contacts';
Aperçu de API
| Méthode | Description |
|---|---|
countContacts |
Compter le nombre total de contacts sur l'appareil. |
createContact |
Créer un nouveau contact par programmation. |
createGroup |
Créer un nouveau groupe de contacts. |
deleteContactById |
Supprimer un contact par son ID. |
deleteGroupById |
Supprimer un groupe par son ID. |
displayContactById |
Afficher un contact via le visualiseur de contacts natif. |
displayCreateContact |
Afficher l'interface native de création de contact. |
displayUpdateContactById |
Affiche l'interface native de mise à jour de contact pour un contact spécifique. |
getAccounts |
Récupère tous les comptes disponibles sur l'appareil. |
getContactById |
Récupère un contact spécifique par son ID. |
getContacts |
Récupère tous les contacts de l'appareil. |
getGroupById |
Récupère un groupe spécifique par son ID. |
getGroups |
Récupère tous les groupes de contacts. |
isAvailable |
Vérifie si les contacts sont disponibles sur l'appareil. |
isSupported |
Vérifie si le plugin est pris en charge sur la plateforme actuelle. |
openSettings |
Ouvre les paramètres de contacts de l'appareil. |
pickContact |
Sélectionne un contact via le sélecteur de contacts natif. |
pickContacts |
Sélectionne un ou plusieurs contacts via le sélecteur de contacts natif. |
updateContactById |
Met à jour un contact existant par son ID. |
checkPermissions |
Vérifiez l’état actuel de l’autorisation pour les contacts. |
requestPermissions |
Demandez les autorisations pour accéder aux contacts. |
Exemples
countContacts()
Compter le nombre total de contacts sur l'appareil.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.countContacts();
console.log(result);
createContact()
Créer un nouveau contact par programmation.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.createContact({ contact: {} });
console.log(result);
createGroup()
Créer un nouveau groupe de contacts.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
const result = await CapacitorContacts.createGroup({ group: { name: 'example' } });
console.log(result);
deleteContactById()
Supprimer un contact par son ID.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.deleteContactById({ id: 'id-123' });
deleteGroupById()
Supprimer un groupe par son ID.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.deleteGroupById({ id: 'id-123' });
displayContactById()
Afficher un contact via le visualiseur de contacts natif.
import { CapacitorContacts } from '@capgo/capacitor-contacts';
await CapacitorContacts.displayContactById({ id: 'id-123' });
Le tableau ci-dessus liste les 21 méthodes principales. Les listeners, les helpers de version et le contrat complet de chaque méthode sont documentés dans la dépôt GitHub.
Référence complète
Continuer depuis « Utiliser @capgo/capacitor-contacts »
Si vous utilisez Utiliser @capgo/capacitor-contacts pour planifier les opérations du dashboard et de API, connectez-l’avec @capgo/capacitor-contacts pour les détails d'implémentation dans @capgo/capacitor-contacts, Prise en main pour les détails d'implémentation dans Getting Started Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'Introduction, et Clés API pour les détails d'implémentation dans les clés API.