Zum Inhalt springen

@capgo/capacitor-contacts

Kontakte auf dem Gerät auflisten, suchen, erstellen und aktualisieren.

Umschließt das native Adressbuch mit Permission-Helpern und Picker-Flows für Einladungen und Empfehlungen.

PlattformSupportHinweise
iOSJaContacts Framework
AndroidJaContactsContract
WebNeinKein API Wrapper für Kontakte; Browser-Contact-Picker 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ählt die Gesamtzahl der Kontakte auf dem Gerät.
createContactErstellt programmatisch einen neuen Kontakt.
createGroupErstelle eine neue Kontaktgruppe.
deleteContactByIdLösche einen Kontakt anhand der ID.
deleteGroupByIdLösche eine Gruppe anhand der ID.
displayContactByIdEinen Kontakt mit dem nativen Kontakt-Viewer anzeigen.
displayCreateContactDie native UI zum Erstellen eines Kontakts öffnen.
displayUpdateContactByIdDie native UI zum Bearbeiten eines bestimmten Kontakts öffnen.
getAccountsAlle auf dem Gerät verfügbaren Konten abrufen.
getContactByIdEinen bestimmten Kontakt per ID abrufen.
getContactsAlle Kontakte vom Gerät abrufen.
getGroupByIdEine bestimmte Gruppe per ID abrufen.
getGroupsAlle Kontaktgruppen abrufen.
isAvailablePrüfen, ob Kontakte auf dem Gerät verfügbar sind.
isSupportedPrüfen, ob das Plugin auf der aktuellen Plattform unterstützt wird.
openSettingsDie Kontakt-Einstellungen des Geräts öffnen.
pickContactEinen einzelnen Kontakt über den nativen Contact Picker auswählen.
pickContactsEinen oder mehrere Kontakte über den nativen Contact Picker auswählen.
updateContactByIdEinen bestehenden Kontakt per ID aktualisieren.
checkPermissionsDen aktuellen Berechtigungsstatus für Kontakte prüfen.
requestPermissionsZugriffsberechtigungen für Kontakte anfordern.
getPluginVersionGibt die native Capacitor Plugin-Version zurück.

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

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