getListUi (廃止)

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

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

Note

API 名によるリストビューのリストビューレコードとメタデータの取得 

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

Note

構文 

 
1import { LightningElement, wire } from "lwc";
2import { getListUi } from "lightning/uiListApi";
3import ACCOUNT_OBJECT from "@salesforce/schema/Account";
4
5export default class Example extends LightningElement {
6  @wire(getListUi, { objectApiName: ACCOUNT_OBJECT, listViewApiName: "AllAccounts" })
7  propertyOrFunction;
8}

ユーザインターフェース API リソース 

 
1GET /ui-api/list-ui/${objectApiName}/${listViewApiName}

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

パラメータ 
  • 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 個の取引先責任者名が表示されるため、ユーザは前および次のデータセットを順にクリックできます。

1<!-- wireListViewToken.html -->
2<template>
3  <lightning-card title="WireListViewToken">
4    <template lwc:if={records}>
5      <div class="slds-m-around_medium">
6        <template for:each={records} for:item="record">
7          <p key={record.fields.Id.value}>{record.fields.Name.value}</p>
8        </template>
9      </div>
10    </template>
11    <div class="slds-grid">
12      <div class="slds-m-around_medium">
13        <lightning-button label="Previous" onclick={handlePreviousPage}></lightning-button>
14      </div>
15      <div class="slds-m-around_medium slds-col_bump-left">
16        <lightning-button label="Next" onclick={handleNextPage}></lightning-button>
17      </div>
18    </div>
19  </lightning-card>
20</template>

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

1// wireListViewToken.js
2import { LightningElement, wire } from "lwc";
3import { getListUi } from "lightning/uiListApi";
4
5import CONTACT_OBJECT from "@salesforce/schema/Contact";
6import NAME_FIELD from "@salesforce/schema/Contact.Name";
7
8export default class WireListViewToken extends LightningElement {
9  pageToken = null;
10  nextPageToken = null;
11  previousPageToken = null;
12  records;
13  error;
14
15  @wire(getListUi, {
16    objectApiName: CONTACT_OBJECT,
17    listViewApiName: "All_Recipes_Contacts",
18    sortBy: NAME_FIELD,
19    pageSize: 10,
20    pageToken: "$pageToken",
21  })
22  listView({ error, data }) {
23    if (data) {
24      this.records = data.records.records;
25      this.error = undefined;
26      this.nextPageToken = data.records.nextPageToken;
27      this.previousPageToken = data.records.previousPageToken;
28    } else if (error) {
29      this.error = error;
30      this.records = undefined;
31    }
32  }
33
34  handleNextPage(e) {
35    this.pageToken = this.nextPageToken;
36  }
37
38  handlePreviousPage(e) {
39    this.pageToken = this.previousPageToken;
40  }
41}

例 

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

ID によるリストビューのリストビューレコードとメタデータの取得 

構文 

 
1import { LightningElement, wire } from "lwc";
2import { getListUi } from "lightning/uiListApi";
3export default class Example extends LightningElement {
4  @wire(getListUi, { listViewId: "00BT0000001TONQMA4" })
5  propertyOrFunction;
6}

ユーザインターフェース API リソース 

 
1GET /ui-api/list-ui/${listViewId}

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

パラメータ 

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

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

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

戻り値 

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

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

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

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

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

オブジェクトによる MRU リストビューのリストビューレコードとメタデータの取得 

構文 

 
1import { LightningElement, wire } from "lwc";
2import { getListUi, MRU } from "lightning/uiListApi";
3import ACCOUNT_OBJECT from "@salesforce/schema/Account";
4
5export default class Example extends LightningElement {
6  @wire(getListUi, { objectApiName: ACCOUNT_OBJECT, listViewApiName: MRU })
7  propertyOrFunction;
8}

ユーザインターフェース API リソース 

 
1GET /ui-api/mru-list-records/${objectApiName}

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

パラメータ 

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

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

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

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

戻り値 

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

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

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

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

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

オブジェクトのリストビューの取得 

構文 

 
1import { LightningElement, wire } from "lwc";
2import { getListUi } from "lightning/uiListApi";
3import ACCOUNT_OBJECT from "@salesforce/schema/Account";
4
5export default class Example extends LightningElement {
6  @wire(getListUi, { objectApiName: ACCOUNT_OBJECT })
7  propertyOrFunction;
8}

ユーザインターフェース API リソース 

 
1GET /ui-api/list-ui/${objectApiName}

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

パラメータ 

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

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

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

戻り値 

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

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

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

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

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

関連トピック

The Japanese Summer '24 guide is now live

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

使用開始
Lightning Web コンポーネントの作成
イベントを使用した通信
Salesforce データの操作
セキュアなコードの開発
Salesforce 対象でのコンポーネントの使用
Salesforce 外でのコンポーネントの使用
Aura との共存
Aura コンポーネントの移行
Lightning Web コンポーネントのデバッグ
Lightning Web コンポーネントのテスト
パフォーマンスの向上
リファレンス
XML 設定ファイルの要素
HTML テンプレートディレクティブ
HTML テンプレートエラー
デコレータ
@salesforce モジュール
experience/cms*Api ワイヤアダプタと関数
lightning/ui*Api ワイヤアダプタと関数
サポートされるオブジェクト
lightning/uiAppsApi (ベータ)
lightning/uiListsApi
lightning/uiListApi (廃止)
getListUi (廃止)
lightning/uiObjectInfoApi
lightning/uiRecordApi
lightning/uiRelatedListApi
lightning/analyticsSmartDataDiscoveryApi ワイヤアダプタと関数
lightning/analyticsWaveApi ワイヤアダプタと関数
lightning/cmsDeliveryApi ワイヤアダプタと関数 (ベータ)
lightning/fileDownload モジュール
lightning/mobileCapabilities モジュール
lightning/refresh モジュール
lightning/uiGraphQLApi ワイヤアダプタと関数
PageReference の型