`getContacts(options)`

ユーザはデバイスの連絡先アプリケーションから 1 件以上の取引先責任者を選択できます。必要に応じて権限のポップアップをユーザに表示して最初に取引先責任者へのアクセス権を要求し、次に取引先責任者セレクタをユーザに表示します。

構文

1import { getContactsService } from 'lightning/mobileCapabilities';
2getContacts(OPTIONS: ContactsServiceOptions): Promise<Object>

パラメータ

options — (必須) ContactsService の要求を設定するための ContactsServiceOptions オブジェクト。

戻り値

Contact オブジェクトの配列として解決される Promise オブジェクト。エラーが発生すると、配列は空になります。
却下された Promise では、エラーに関する詳細が含まれる ContactsServiceFailure オブジェクトが返されます。

使用方法

この関数によって取引先責任者選択リストが提供され、選択された取引先責任者のリストが返されます。

1myContactsService
2  .getContacts(options)
3  .then((results) => {
4    this.contacts = results;
5  })
6  .catch((error) => {
7    this.contacts = [];
8    console.error("Error code: " + error.code);
9    +console.error("Error message: " + error.message);
10  });

この関数がコールされると、デバイスの取引先責任者を表示するリストビューがモバイルデバイスに表示されます。ユーザは任意の数の取引先責任者を選択でき、チェックマークアイコンをタップして続行します。

getContacts() は非同期関数です。つまり、選択リストが画面上に表示されている間、JavaScript 実行が一時停止します。Promise で解決するために、ユーザは取引先責任者の選択を完了して続行ボタンをタップするか、操作をキャンセルする必要があります。Promise で解決されると、コンポーネントの実行が再開されます。
取引先責任者を選択すると、達成された Promise を介して結果が返されます。then 句で正常な結果を処理します。
エラーが発生すると、却下された Promise を介してエラーが返されます。catch 句でエラーを処理します。
ユーザが取引先責任者の選択をキャンセルすると、Promise は USER_DISMISSED の ContactsServiceFailure.code 値で拒否されます。
取引先責任者の選択リストはデバイス固有のウィンドウであり、カスタマイズはできません。
取引先責任者の選択ウィンドウ自体はカスタマイズできませんが、取引先責任者の選択前にカスタムインターフェースを表示することはできます。取引先責任者の選択後に、別のカスタムインターフェースを表示し、選択された取引先責任者を処理するための追加のオプションまたは機能を提供できます。

関連トピック

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。