ガイド
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 |
ネイティブの連絡先ピッカーで連絡先を1件選択します。 |
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 の概要」の実装の詳細については、 はじめに はじめにの実装詳細、および API キー API Keys の実装詳細については、