メインコンテンツへスキップ
@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

ガイド

Capacitor で Contacts を使用する方法

@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()

ネイティブの連絡先ビューアで連絡先を表示します。

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

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

上記の表には21個のコアメソッドが記載されています。リスナーやバージョンのヘルパー、各メソッドの詳細な仕様については、 GitHub リポジトリ.

完全なリファレンス

@capgo/capacitor-contacts の使用方法から続ける

使用している場合 @capgo/capacitor-contacts の使用方法 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-contacts @capgo/capacitor-contacts の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 API の概要 「API の概要」の実装の詳細については、 はじめに Introduction の実装詳細、および API キー API Keys の実装詳細についてはこちら。

よくある質問

Contacts プラグイン FAQ

Capacitor アプリに Contacts プラグインをインストールするには?

"bun add @capgo/capacitor-contacts"(または "npm install @capgo/capacitor-contacts")を実行し、続けて "bunx cap sync" を実行すると、iOS と Android のプロジェクトにネイティブの code が反映されます。アプリの code で "@capgo/capacitor-contacts" からインポートしてください。

@capgo/capacitor-contacts は React、Vue、Angular で動作しますか?

はい。Contacts は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、素の JavaScript など、Capacitor 上で動くあらゆる Web フレームワークで動作します。

@capgo/capacitor-contacts はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

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

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-contacts/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストは歓迎します。

App Storeの審査なしで、Contactsを使用しているcodeをアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに、Contactsの変更をリリースしましょう

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める