__CAPGO_KEEP_4__
@capgo/capacitor-contacts デバイスAPI オープンソース

連絡先 Capacitor プラグイン

デバイスの連絡先に読み書き可能なアクセスと管理

インストール

bun add @capgo/capacitor-contacts bunx cap sync
npm、pnpm、またはyarn
  • npm install @capgo/capacitor-contacts
  • pnpm add @capgo/capacitor-contacts
  • yarn add @capgo/capacitor-contacts

ガイド

How to use Contacts in Capacitor

capgo を使用して @capgo/capacitor-contacts を使用

Capacitor Contacts プラグインは、デバイスの連絡先を管理するためのインターフェイスです。

インストール

bun add @capgo/capacitor-contacts
bunx cap sync

bunx cap sync code のネイティブ コードをプロジェクトにコピーします。プラグインのアップグレード後、再度実行してください。

インポート

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

API の概要

メソッド 説明
countContacts デバイス上の連絡先の総数をカウントします。
createContact プログラム上で新しい連絡先を作成します。
createGroup 新しい連絡先グループを作成します。
deleteContactById IDで連絡先を削除します。
deleteGroupById IDでグループを削除します。
displayContactById ネイティブの連絡先ビューアを使用して連絡先を表示します。
displayCreateContact ネイティブの連絡先作成UIを表示します。
displayUpdateContactById 特定の連絡先のためにネイティブの連絡先更新UIを表示します。
getAccounts デバイス上で利用可能なすべてのアカウントを取得します。
getContactById IDで特定の連絡先を取得します。
getContacts デバイス上のすべての連絡先を取得します。
getGroupById IDで特定のグループを取得します。
getGroups デバイス上のすべての連絡先グループを取得します。
isAvailable デバイス上で連絡先が利用可能かどうかを確認します。
isSupported 現在のプラットフォームでプラグインがサポートされているかどうかを確認します。
openSettings デバイスの連絡先設定を開きます。
pickContact 単一の連絡先を選択します。
pickContacts 1 つ以上の連絡先を選択します。
updateContactById ID で指定された既存の連絡先を更新します。
checkPermissions 連絡先の現在の許可状態を確認します。
requestPermissions 連絡先へのアクセスを許可するように求めます。

例

countContacts()

デバイス上の連絡先の総数を数えます。

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

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

createContact()

プログラム的に新しい連絡先を作成します。

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

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

createGroup()

新しい連絡先グループを作成します。

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

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

deleteContactById()

ID で指定された連絡先を削除します。

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

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

deleteGroupById()

ID で指定されたグループを削除します。

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

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

displayContactById()

nativeコントラクトビューアを使用してコントラクトを表示します。

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

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

上の表には21の基本メソッドがリストされています。リスナーとバージョンヘルパー、各メソッドのフルコントラクトは、__CAPGO_KEEP_0__リポジトリにドキュメントされています。 GitHubリファレンス.

ドキュメント

@capgo/capacitorコンタクトから続ける

Capacitor-Contactsを使用している場合、ダッシュボードと__CAPGO_KEEP_0__のオペレーションを計画するには、__CAPGO_KEEP_0__に接続してください。 Using @capgo/capacitor-contacts Capacitor-Contactsを使用している場合、ダッシュボードとAPIのオペレーションを計画するには、APIに接続してください。 @capgo/capacitor-contacts @capgo/capacitor連絡先の実装詳細 はじめに Capacitor-contactsの実装詳細については APIの概要 Capacitor-contactsの実装詳細についてはAPIの概要です。 Introduction Capacitor-contactsの実装詳細については API キー API キーの実装詳細について

FAQ

FAQ

Capacitor コンタクト プラグインを 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.

@capgo/capacitor-contactsは、React、Vue、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.

Which Capacitor version does @capgo/capacitor-contacts support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Capgo の @capgo/capacitor-contacts は無料でオープンソースですか?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-contacts/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Capgo の @code/__CAPGO_KEEP_1__-contacts をアップデートすることは App Store のレビューなしでできますか?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

アプリのレビューを待たずにコンタクトの変更を配信する

プラグインがストアのビルドに含まれると、Capgoライブアップデートは、ユーザーにJavaScript、HTML、CSSの変更を数分でプッシュします。

Capgoで始めます