Erste Schritte

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge deinem KI-Tool die Capgo Skills mit folgendem Befehl hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze anschließend diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-contacts` plugin in my project.

Wenn du ein manuelles Setup bevorziehst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

npm install @capgo/capacitor-contacts
npx cap sync

Importieren

import { CapacitorContacts } from '@capgo/capacitor-contacts';

Quickstart

Zugriff anfordern und Kontakte dann mit einer sinnvollen Seitengröße laden, statt das gesamte Adressbuch auf einmal.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.requestPermissions();
const { contacts } = await CapacitorContacts.getContacts({ limit: 50, offset: 0 });
// Increase offset by limit for the next page instead of loading the full address book.

Häufige Fehlerquellen

• Begründung: Erkläre, warum Kontaktzugriff nötig ist, bevor der Dialog erscheint.
• Pagination: Vermeide es, alle Adressbücher auf einmal zu laden.
• Writes: Das Anlegen von Kontakten erfordert Schreibberechtigung.

API Übersicht

countContacts

Zählt die Gesamtzahl der Kontakte auf dem Gerät.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.countContacts();
console.log(result);

createContact

Erstellt programmatisch einen neuen Kontakt.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.createContact({ contact: {} });
console.log(result);

createGroup

Erstelle eine neue Kontaktgruppe.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.createGroup({ group: { name: 'example' } });
console.log(result);

deleteContactById

Lösche einen Kontakt anhand der ID.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.deleteContactById({ id: 'id-123' });

deleteGroupById

Lösche eine Gruppe anhand der ID.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.deleteGroupById({ id: 'id-123' });

displayContactById

Zeigt einen Kontakt über den nativen Kontakt-Viewer an.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.displayContactById({ id: 'id-123' });

displayCreateContact

Öffnet das native UI zum Erstellen eines Kontakts.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.displayCreateContact();
console.log(result);

displayUpdateContactById

Öffnet das native UI zum Bearbeiten eines spezifischen Kontakts.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.displayUpdateContactById({ id: 'id-123' });

getAccounts

Ruft alle auf dem Gerät verfügbaren Accounts ab.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.getAccounts();
console.log(result);

getContactById

Einen bestimmten Kontakt per ID abrufen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.getContactById({ id: 'id-123' });
// The result holds sensitive values: use it without logging it.

getContacts

Alle Kontakte vom Gerät abrufen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.getContacts();
// The result holds sensitive values: use it without logging it.

getGroupById

Eine bestimmte Gruppe per ID abrufen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.getGroupById({ id: 'id-123' });
console.log(result);

getGroups

Alle Kontaktgruppen abrufen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.getGroups();
console.log(result);

isAvailable

Prüfen, ob Kontakte auf dem Gerät verfügbar sind.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.isAvailable();
console.log(result);

isSupported

Prüfen, ob das Plugin auf der aktuellen Plattform unterstützt wird.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.isSupported();
console.log(result);

openSettings

Die Kontakt-Einstellungen des Geräts öffnen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.openSettings();

pickContact

Einen einzelnen Kontakt über den nativen Contact Picker auswählen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.pickContact();
// The result holds sensitive values: use it without logging it.

pickContacts

Einen oder mehrere Kontakte über den nativen Contact Picker auswählen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.pickContacts();
// The result holds sensitive values: use it without logging it.

updateContactById

Einen bestehenden Kontakt per ID aktualisieren.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

await CapacitorContacts.updateContactById({
  id: 'id-123',
  contact: {},
});

checkPermissions

Den aktuellen Berechtigungsstatus für Kontakte prüfen.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.checkPermissions();
console.log(result);

requestPermissions

Zugriffsberechtigungen für Kontakte anfordern.

import { CapacitorContacts } from '@capgo/capacitor-contacts';

const result = await CapacitorContacts.requestPermissions();
console.log(result);

Typ-Referenz

CountContactsResult

Ergebnis der Kontaktzählung.

export interface CountContactsResult {
  /**
   * Total number of contacts.
   *
   * @since 1.0.0
   */
  count: number;
}

CreateContactOptions

Optionen zum Erstellen eines Kontakts.

export interface CreateContactOptions {
  /**
   * Contact information to create. The 'id' field will be generated automatically.
   *
   * @since 1.0.0
   */
  contact: Omit<Contact, 'id'>;
}

CreateContactResult

Ergebnis der Kontakterstellung.

export interface CreateContactResult {
  /**
   * The ID of the newly created contact.
   *
   * @since 1.0.0
   */
  id: string;
}

CreateGroupOptions

Optionen zum Erstellen einer Gruppe.

export interface CreateGroupOptions {
  /**
   * Group information to create. The 'id' field will be generated automatically.
   *
   * @since 1.0.0
   */
  group: Omit<Group, 'id'>;
}

CreateGroupResult

Ergebnis der Gruppenerstellung.

export interface CreateGroupResult {
  /**
   * The ID of the newly created group.
   *
   * @since 1.0.0
   */
  id: string;
}

DeleteContactByIdOptions

Optionen zum Löschen eines Kontakts per ID.

export interface DeleteContactByIdOptions {
  /**
   * The ID of the contact to delete.
   *
   * @since 1.0.0
   */
  id: string;
}

DeleteGroupByIdOptions

Optionen zum Löschen einer Gruppe per ID.

export interface DeleteGroupByIdOptions {
  /**
   * The ID of the group to delete.
   *
   * @since 1.0.0
   */
  id: string;
}

DisplayContactByIdOptions

Optionen zum Anzeigen eines Kontakts per ID.

export interface DisplayContactByIdOptions {
  /**
   * The ID of the contact to display.
   *
   * @since 1.0.0
   */
  id: string;
}

DisplayCreateContactOptions

Optionen zum Anzeigen der nativen UI zum Erstellen eines Kontakts.

export interface DisplayCreateContactOptions {
  /**
   * Optional pre-filled contact information for the create UI.
   *
   * @since 1.0.0
   */
  contact?: Omit<Contact, 'id'>;
}

DisplayCreateContactResult

Ergebnis der Anzeige des nativen UI zum Erstellen von Kontakten.

export interface DisplayCreateContactResult {
  /**
   * The ID of the created contact, if one was created. Undefined if the user cancelled.
   *
   * @since 1.0.0
   */
  id?: string;
}

DisplayUpdateContactByIdOptions

Optionen für die Anzeige des nativen UI zum Aktualisieren von Kontakten.

export interface DisplayUpdateContactByIdOptions {
  /**
   * The ID of the contact to update.
   *
   * @since 1.0.0
   */
  id: string;
}

GetAccountsResult

Ergebnis des Abrufens der Konten.

export interface GetAccountsResult {
  /**
   * List of accounts available on the device.
   *
   * @since 1.0.0
   */
  accounts: Account[];
}

Source of Truth

Diese Seite wird aus dem Plugin- src/definitions.ts. Führe den Sync erneut aus, wenn sich der öffentliche API upstream ändert.

Weiter mit Getting Started

Wenn Sie ... verwenden Erste Schritte Um Dashboard- und API-Operationen zu planen, verbinde es mit @capgo/capacitor-contacts verwenden für die native Funktionalität 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 Keys für die Implementierungsdetails in den API Keys und Geräte für die Implementierungsdetails bei Devices.