Aller directement au contenu principal
@capgo/capacitor-contacts APIs de dispositifs Source ouvert

Contacts plugin Capacitor

Gérer et accéder aux contacts de l'appareil avec des capacités de lecture et d'écriture

Installer

bun add @capgo/capacitor-contacts bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-contacts
  • pnpm add @capgo/capacitor-contacts
  • yarn add @capgo/capacitor-contacts

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.

FAQ

FAQ du plugin Contacts

Comment puis-je installer le plugin Contacts dans une application Capacitor ?

Run "bun add @capgo/capacitor-contacts" (or "npm install @capgo/capacitor-contacts"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-contacts" in your app code.

Fonctionne-t-il @capgo/capacitor-contacts avec React, Vue et Angular ?

Yes. Contacts is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Quelle version de Capacitor est prise en charge par @capgo/capacitor-contacts ?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à votre version majeure de Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le README de GitHub liste les versions maintenues.

Est-ce que @capgo/capacitor-contacts est gratuit et open source ?

Oui. Le code source de code est public sur GitHub à https://github.com/Cap-go/capacitor-contacts/ et le package est gratuit pour l'installation depuis npm. Les rapports de bugs et les demandes de mise à jour sont les bienvenus.

Peut-on mettre à jour code qui utilise Contacts sans passer par une revue de l'App Store ?

L'installation ou la mise à jour du plugin modifie le code natif de code, il faut donc une nouvelle build de l'application. Une fois cela fait, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être déployées instantanément avec les mises à jour Capgo.

Envoyer les modifications des contacts sans attendre la revue de l'application

Une fois le plugin est dans votre magasin de build, les mises à jour en direct Capgo poussent vos modifications de JavaScript, HTML et CSS vers les utilisateurs en quelques minutes.

Commencez avec Capgo