Zum Inhalt springen

@capgo/capacitor-contacts

Gerätekontakte auflisten, durchsuchen, erstellen und aktualisieren.

Bietet einen Wrapper um das native Adressbuch mit Permission-Helfern und Picker-Flows für Einladungen und Empfehlungen.

PlattformSupportNotizen
iOSJaContacts Framework
AndroidJaContactsContract
WebNeinKein Contacts-API-Wrapper; Kontakt-Picker im Browser sind separate Integrationen
  • countContacts - Die Gesamtzahl der Kontakte auf dem Gerät zählen.
  • createContact - Einen neuen Kontakt programmatisch erstellen.
  • createGroup - Eine neue Kontaktgruppe erstellen.
  • deleteContactById - Einen Kontakt anhand der ID löschen.
MethodeBeschreibung
countContactsZähle die Gesamtzahl der Kontakte auf dem Gerät.
createContactErstelle einen neuen Kontakt programmatisch.
createGroupErstelle eine neue Kontaktgruppe.
deleteContactByIdLösche einen Kontakt per ID.
deleteGroupByIdLösche eine Gruppe per ID.
displayContactByIdZeige einen Kontakt im nativen Kontakt-Viewer an.
displayCreateContactZeigt die native UI zum Erstellen von Kontakten an.
displayUpdateContactByIdZeigt die native UI zum Aktualisieren eines bestimmten Kontakts an.
getAccountsRuft alle auf dem Gerät verfügbaren Accounts ab.
getContactByIdRuft einen bestimmten Kontakt anhand der ID ab.
getContactsRuft alle Kontakte vom Gerät ab.
getGroupByIdRuft eine bestimmte Gruppe anhand der ID ab.
getGroupsRuft alle Kontaktgruppen ab.
isAvailablePrüft, ob Kontakte auf dem Gerät verfügbar sind.
isSupportedPrüft, ob das Plugin auf der aktuellen Plattform unterstützt wird.
openSettingsÖffnet die Kontakteinstellungen des Geräts.
pickContactWählt einen einzelnen Kontakt über den nativen Kontakt-Auswahl-Assistenten aus.
pickContactsWählt einen oder mehrere Kontakte über den nativen Kontakt-Auswahl-Assistenten aus.
updateContactByIdBestehenden Kontakt per ID aktualisieren.
checkPermissionsPrüfe den aktuellen Berechtigungsstatus für Kontakte.
requestPermissionsBerechtigungen für den Zugriff auf Kontakte anfordern.
getPluginVersionDie native Capacitor Plugin-Version abrufen.

Diese Referenz wird synchronisiert von src/definitions.ts in einem capacitor-contacts.

Wenn du es nutzt @capgo/capacitor-contacts um Dashboard- und API-Operationen zu planen, verbinde es mit Nutzung von @capgo/capacitor-contacts für die native Funktion bei der Nutzung von @capgo/capacitor-contacts, API Übersicht für Details zur Implementierung im API Overview, Einführung für die Implementierungsdetails in der Einleitung, API Schlüssel für das Implementierungsdetail in API Keys und Geräte für das Implementierungsdetail in Devices.