Aller au contenu

@capgo/capacitor-contacts

Lister, rechercher, créer et mettre à jour les contacts de l'appareil.

Enveloppez l'annuaire natif avec des helpers de permission et des flux de sélection pour les invitations et le parrainage.

PlateformeSupportNotes
iOSOuiFramework Contacts
AndroidOuiContactsContract
WebNonNo Contacts API wrapper; browser contact pickers are separate integrations
  • 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.
MéthodeDescription
countContactsCompter le nombre total de contacts sur l'appareil.
createContactCréer un nouveau contact par programmation.
createGroupCréer un nouveau groupe de contacts.
deleteContactByIdSupprimer un contact par son ID.
deleteGroupByIdSupprimer un groupe par son ID.
displayContactByIdAfficher un contact via le lecteur de contacts natif.
displayCreateContactAfficher l'interface native de création de contact.
displayUpdateContactByIdAfficher l'interface native de modification pour un contact spécifique.
getAccountsRécupérer tous les comptes disponibles sur l'appareil.
getContactByIdRécupérer un contact spécifique par son ID.
getContactsRécupérer tous les contacts de l'appareil.
getGroupByIdRécupérer un groupe spécifique par son ID.
getGroupsRécupérer tous les groupes de contacts.
isAvailableVérifier si les contacts sont disponibles sur l'appareil.
isSupportedVérifier si le plugin est supporté sur la plateforme actuelle.
openSettingsOuvrir les paramètres des contacts de l'appareil.
pickContactSélectionner un contact via le sélecteur natif.
pickContactsSélectionner un ou plusieurs contacts via le sélecteur natif.
updateContactByIdMettre à jour un contact existant par son ID.
checkPermissionsVérifier l'état actuel des permissions pour les contacts.
requestPermissionsDemander les permissions pour accéder aux contacts.
getPluginVersionRécupérer la version du plugin natif Capacitor.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-contacts.

Si vous utilisez @capgo/capacitor-contacts pour planifier les opérations du dashboard et de API, connectez-l’à Utiliser @capgo/capacitor-contacts pour la capacité native dans Utiliser @capgo/capacitor-contacts, Aperçu de API pour les détails d'implémentation dans l'aperçu de API, Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans les clés API, et Appareils pour les détails d'implémentation dans les appareils.