ContactsService API の使用
連絡先ベースの機能を持つ Lightning Web コンポーネントを開発するには、デバイスのアドレス帳から取引先責任者を選択する方法として ContactsService API を使用します。
- ContactsService をコンポーネント定義にインポートして、ContactsService API 関数をコードで使用できるようにします。
- 連絡先関連の関数をコールする前に ContactsService が使用できることをテストして確認します。
- 取引先責任者を選択してアクセスするには、
getContacts()関数を使用します。
コンポーネントの JavaScript ファイルで、標準 JavaScript import ステートメントを使用して ContactsService をインポートします。具体的には、次のように lightning/mobileCapabilities モジュールから getContactsService() ファクトリ関数をインポートします。
コンポーネントにインポートされたら、ファクトリ関数を使用して ContactsService のインスタンスを取得します。ContactsService インスタンスでは、ユーティリティ関数と定数を使用して、可用性を確認します。次に、連絡先関連の関数を使用して、デバイスから連絡先を選択します。
ContactsService は、物理デバイスのハードウェアおよびプラットフォーム機能に連動します。ContactsService を使用するコンポーネントは、デスクトップコンピュータやモバイルブラウザでエラーなく表示されますが、連絡先関連の関数は動作しません。このようなエラーを回避するには、使用する前に ContactsService 機能を使用できるかどうかを確認します。
ContactsService を使用して、簡単にカスタム連絡先処理機能を作成できます。
getContacts()を使用して、連絡先選択リストビューを開きます。- ユーザはリストから連絡先を選択します。
- 結果 (選択した連絡先の連絡先データ) を処理します。
次に例を示します。
取引先責任者データの処理方法やエラーの処理方法などについての詳細は、getContacts(options) を参照してください。
関連トピック