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
Le WebNonPas de wrapper Contacts API ; les sélecteurs de contacts du navigateur sont des intégrations distinctes
  • 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 visualiseur de contacts natif.
displayCreateContactAfficher l'interface native de création de contact.
displayUpdateContactByIdAffiche l'interface native de mise à jour de contact pour un contact spécifique.
getAccountsRécupère tous les comptes disponibles sur l'appareil.
getContactByIdRécupère un contact spécifique par son ID.
getContactsRécupère tous les contacts de l'appareil.
getGroupByIdRécupère un groupe spécifique par son ID.
getGroupsRécupère tous les groupes de contacts.
isAvailableVérifie si les contacts sont disponibles sur l'appareil.
isSupportedVérifie si le plugin est pris en charge sur la plateforme actuelle.
openSettingsOuvrez les paramètres de contacts de l’appareil.
pickContactSélectionne un contact via le sélecteur de contacts natif.
pickContactsSélectionne un ou plusieurs contacts via le sélecteur de contacts natif.
updateContactByIdMet à jour un contact existant par son ID.
checkPermissionsVérifiez l’état actuel de l’autorisation pour les contacts.
requestPermissionsDemandez les autorisations pour accéder aux contacts.
getPluginVersionRécupère 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’avec Utiliser @capgo/capacitor-contacts pour la fonctionnalité native dans « Utiliser @capgo/capacitor-contacts », 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, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.