getListUi (廃止)

リストビューのレコードデータとメタデータを取得するには、このワイヤアダプタを使用します。

getListUi は廃止される機能であり、今後は更新されず、Salesforce とのメインサービス契約における「サービス」には含まれません。この機能はお客様各自の裁量で使用し、購入するときは、現在正式にリリースされている製品および機能に基づいて判断してください。Salesforce はこの機能の特定期間内の正式リリースまたはリリースの有無を保証しません。また、いかなる時点でもこの機能を終了できるものとします。getListUi は評価のみを目的とし、本番環境での使用はできません。この機能は、そのままの状態で提供され、サポートされておらず、ここから生じる、またはこれに関連する被害または損害に対して、Salesforce はいかなる責任も負いません。すべての制約、Salesforce の権利の保留、本サービスに関する義務、および関連する Salesforce 以外のアプリケーションならびにコンテンツの条件は、この機能の使用に等しく適用されます。

getListInfoByName ワイヤアダプタを使用します。

「リストビューレコードとメタデータの取得」を参照してください。

  • objectApiName — (必須) サポートされているオブジェクトの API 名。
  • listViewApiName — (必須) AllAccounts などのリストビューの API 名。
  • propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

この要求パラメータの表に記載されているパラメータを渡すこともできます。**「使用方法」**セクションの例を参照してください。

返されるレコードには、次で指定される項目が含まれます。

  • data.info.displayColumns によって指定されるリストビューメタデータ。
  • fields および optionalFields パラメータ。

基盤となるリストビューは、システム管理者が制御するため、変更される場合があります。コンポーネントで項目が必要な場合は、fields パラメータで要求します。特定の項目を明示的に要求しない場合は、その項目が返されることを想定しないでください。コンテキストユーザに項目へのアクセス権があるかどうかがわからず、ない場合に要求を失敗させないようにする場合は、optionalFields パラメータを使用します。

  • CreatedDate、Id、LastModifiedById、LastModifiedDate、SystemModstamp など、オブジェクトのシステム項目 (オブジェクトにこれらがある場合)。

前または次のデータセットを反復処理する場合、次のガイドラインを考慮してください。

  • nextPageToken および previousPageToken の値を使用します。
  • pageToken の値は、セッションまたはページ更新をまたがって使用することはできません。ページ更新をまたがったページトークンの保持および再利用は機能しない可能性があります。

この例では、リストビューの 10 個の取引先責任者名が表示されるため、ユーザは前および次のデータセットを順にクリックできます。

ユーザが [前へ] および [次へ] ボタンをクリックすると、pageToken パラメータが、ワイヤサービスでプロビジョニングされたデータの previousPageToken および nextPageToken の値に更新されます。pageToken には $ が追加されるため、その値が変更されたときにワイヤサービスによって新しいデータがプロビジョニングされます。

wireListViewToken の例は、lwc-recipes リポジトリの wireListView コンポーネントに基づいています。

「リストビューレコードとメタデータの取得」を参照してください。

  • listViewId — (必須) リストビューの ID。

  • propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

この要求パラメータの表に記載されているパラメータを渡すこともできます。

返されるレコードには、次で指定される項目が含まれます。

  • data.info.displayColumns によって指定されるリストビューメタデータ。

  • fields および optionalFields パラメータ。

    基盤となるリストビューは、システム管理者が制御するため、変更される場合があります。コンポーネントで項目が必要な場合は、fields パラメータで要求します。特定の項目を明示的に要求しない場合は、その項目が返されることを想定しないでください。コンテキストユーザに項目へのアクセス権があるかどうかがわからず、ない場合に要求を失敗させないようにする場合は、optionalFields パラメータを使用します。

  • CreatedDate、Id、LastModifiedById、LastModifiedDate、SystemModstamp など、オブジェクトのシステム項目 (オブジェクトにこれらがある場合)。

「最後に使用されたリストビューレコードの取得」を参照してください。

  • objectApiName — (必須) サポートされているオブジェクトの API 名。

  • listViewApiName — (必須) MRU リストビューの API 名。

  • propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

この要求パラメータの表に記載されているパラメータを渡すこともできます。

返されるレコードには、次で指定される項目が含まれます。

  • data.info.displayColumns によって指定されるリストビューメタデータ。

  • fields および optionalFields パラメータ。

    基盤となるリストビューは、システム管理者が制御するため、変更される場合があります。コンポーネントで項目が必要な場合は、fields パラメータで要求します。特定の項目を明示的に要求しない場合は、その項目が返されることを想定しないでください。コンテキストユーザに項目へのアクセス権があるかどうかがわからず、ない場合に要求を失敗させないようにする場合は、optionalFields パラメータを使用します。

  • CreatedDate、Id、LastModifiedById、LastModifiedDate、SystemModstamp など、オブジェクトのシステム項目 (オブジェクトにこれらがある場合)。

「オブジェクトのリストビューの取得」を参照してください。

  • objectApiName — (必須) サポートされているオブジェクトの API 名。

  • propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

この要求パラメータの表に記載されているパラメータを渡すこともできます。

返されるレコードには、次で指定される項目が含まれます。

  • data.info.displayColumns によって指定されるリストビューメタデータ。

  • fields および optionalFields パラメータ。

    基盤となるリストビューは、システム管理者が制御するため、変更される場合があります。コンポーネントで項目が必要な場合は、fields パラメータで要求します。特定の項目を明示的に要求しない場合は、その項目が返されることを想定しないでください。コンテキストユーザに項目へのアクセス権があるかどうかがわからず、ない場合に要求を失敗させないようにする場合は、optionalFields パラメータを使用します。

  • CreatedDate、Id、LastModifiedById、LastModifiedDate、SystemModstamp など、オブジェクトのシステム項目 (オブジェクトにこれらがある場合)。

関連トピック