@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 プラグインのバージョンを取得します。

信頼できる情報源

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

@capgo/capacitor-contactsの続き

以下を使用している場合： @capgo/capacitor-contacts ダッシュボードと API の操作を計画するには、以下と連携してください @capgo/capacitor-contactsの使用方法 @capgo/capacitor-contactsを使用する場合の、ネイティブ機能について API の概要 API Overview の実装の詳細については、 はじめに Introduction の実装の詳細については、 API キー API Keys の実装の詳細については、 デバイス Devices の実装の詳細については。