@capgo/capacitor-contacts

概要

権限ヘルパーと、招待や紹介用のピッカーフローを備えたネイティブのアドレス帳ラッパー。

プラットフォーム対応

プラットフォーム	サポート	備考
iOSと	はい	Contacts フレームワーク
Androidでは	はい	ContactsContract
Web	いいえ	API wrapperは提供されていません。ブラウザの連絡先ピッカーは個別の統合が必要です。

コア機能

• countContacts - デバイス上の連絡先の総数を取得します。
• createContact - プログラムから新しい連絡先を作成します。
• createGroup - 新しい連絡先グループを作成します。
• deleteContactById - IDを指定して連絡先を削除します。

公開 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	連絡先へのアクセス権限をリクエストします。
getPluginVersion	ネイティブの Capacitor プラグインのバージョンを取得します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-contacts.

@capgo/capacitor-contacts から続ける

使用している場合 @capgo/capacitor-contacts ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-contacts の使い方 @capgo/capacitor-contacts を使用してネイティブ機能を利用する場合、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。