Démarrage

Installer

bun add @capgo/capacitor-contacts
bunx cap sync

Importer

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

API Vue d'ensemble

countContacts

Compter le nombre total de contacts sur le dispositif.

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

await CapacitorContacts.countContacts();

createContact

Créer un nouveau contact de manière programmée.

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

await CapacitorContacts.createContact({} as CreateContactOptions);

createGroup

Créer un nouveau groupe de contacts.

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

await CapacitorContacts.createGroup({} as CreateGroupOptions);

deleteContactById

Supprimer un contact par ID.

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

await CapacitorContacts.deleteContactById({} as DeleteContactByIdOptions);

deleteGroupById

Supprimer un groupe par ID.

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

await CapacitorContacts.deleteGroupById({} as DeleteGroupByIdOptions);

displayContactById

Afficher un contact à l'aide du visionneuse de contacts natif.

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

await CapacitorContacts.displayContactById({} as DisplayContactByIdOptions);

displayCreateContact

Afficher l'interface utilisateur de création de contact natif.

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

await CapacitorContacts.displayCreateContact();

displayUpdateContactById

Afficher l'interface utilisateur native de mise à jour de contact pour un contact spécifique.

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

await CapacitorContacts.displayUpdateContactById({} as DisplayUpdateContactByIdOptions);

getAccounts

Récupérer tous les comptes disponibles sur le dispositif.

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

await CapacitorContacts.getAccounts();

getContactById

Récupérer un contact spécifique par ID.

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

await CapacitorContacts.getContactById({} as GetContactByIdOptions);

getContacts

Récupérer tous les contacts du dispositif.

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

await CapacitorContacts.getContacts();

getGroupById

Récupérer un groupe spécifique par son ID.

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

await CapacitorContacts.getGroupById({} as GetGroupByIdOptions);

getGroups

Récupérer tous les groupes de contacts.

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

await CapacitorContacts.getGroups();

isAvailable

Vérifier si les contacts sont disponibles sur le dispositif.

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

await CapacitorContacts.isAvailable();

isSupported

Vérifier si le plugin est pris en charge sur la plateforme actuelle.

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

await CapacitorContacts.isSupported();

openSettings

Ouvrez les paramètres de contacts du dispositif.

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

await CapacitorContacts.openSettings();

pickContact

Sélectionnez un contact unique à l'aide du pickeur de contacts natif.

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

await CapacitorContacts.pickContact();

pickContacts

Sélectionnez un ou plusieurs contacts à l'aide du pickeur de contacts natif.

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

await CapacitorContacts.pickContacts();

updateContactById

Met à jour un contact existant en fonction de son ID.

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

await CapacitorContacts.updateContactById({} as UpdateContactByIdOptions);

checkPermissions

Vérifiez l'état actuel des autorisations pour les contacts.

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

await CapacitorContacts.checkPermissions();

requestPermissions

Demander des autorisations pour accéder aux contacts.

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

await CapacitorContacts.requestPermissions();

Référence de type

CountContactsResult

Résultat du comptage des contacts.

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

CreateContactOptions

Options pour créer un contact.

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

CreateContactResult

Résultat de la création d'un contact.

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

CreateGroupOptions

Options pour créer un groupe.

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

CreateGroupResult

Résultat de la création d'un groupe.

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

DeleteContactByIdOptions

Options pour supprimer un contact par ID.

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

DeleteGroupByIdOptions

Options pour supprimer un groupe par ID.

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

DisplayContactByIdOptions

Options pour afficher un contact par ID.

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

DisplayCreateContactOptions

Options pour afficher l'interface utilisateur native de création de contact.

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

DisplayCreateContactResult

Résultat de l'affichage de l'interface utilisateur native de création de contact.

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

Options pour afficher l'interface utilisateur native de mise à jour de contact.

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

GetAccountsResult

Résultat de la récupération des comptes.

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

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run la synchronisation lorsque le public API change en amont.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le tableau de bord et les opérations de API, connectez-le à Utilisation de @capgo/capacitor-contacts pour la capacité native dans Utilisation de @capgo/capacitor-contacts, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour le détail d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.