`getObjectInfos`

複数のオブジェクトのメタデータを取得するには、このワイヤアダプタを使用します。応答には、各オブジェクトの項目、子リレーション、レコードタイプ、テーマを記述するメタデータが含まれます。

構文

1import { LightningElement, wire } from "lwc";
2import { getObjectInfos } from "lightning/uiObjectInfoApi";
3import ACCOUNT_OBJECT from "@salesforce/schema/Account";
4import OPPORTUNITY_OBJECT from "@salesforce/schema/Opportunity";
5
6export default class GetObjectInfosExample extends LightningElement {
7  @wire(getObjectInfos, { objectApiNames: [ACCOUNT_OBJECT, OPPORTUNITY_OBJECT] })
8  propertyOrFunction;
9}

パラメータ

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

戻り値

data — results オブジェクト、オブジェクト情報メタデータ、状況コードが含まれます。
error — FetchResponse

data.results を使用して、オブジェクトメタデータを取得します。要求された順序でオブジェクトメタデータが返されます。要求されたオブジェクトにエラーが含まれている場合、data.results[].result でエラーコードとメッセージが返されます。サーバコールが失敗した場合にのみ error オブジェクトが返されます。

1{
2  "results": [
3    {
4      "result": ObjectInfo1,
5      "statusCode": 200
6    },
7    {
8      "result": ObjectInfo2,
9      "statusCode": 200
10    },
11    {
12      "result": [
13                {
14                    "errorCode": "FORBIDDEN",
15                    "message": "You don't have access to this record. Ask your administrator for help or to request access."
16                }
17        ],
18        "statusCode": 403
19    }
20  ]
21}

使用方法

複数のオブジェクトのメタデータを取得するには、getObjectInfos を使用します。単一のオブジェクトを操作するには、getObjectInfo を使用します。

次の例では、取引先と商談のオブジェクト情報が返されます。

1import { LightningElement, wire } from "lwc";
2import { getObjectInfos } from "lightning/uiObjectInfoApi";
3import ACCOUNT_OBJECT from "@salesforce/schema/Account";
4import OPPORTUNITY_OBJECT from "@salesforce/schema/Opportunity";
5
6export default class WireGetObjectInfo extends LightningElement {
7  objectApiNames = [ACCOUNT_OBJECT, OPPORTUNITY_OBJECT];
8
9  @wire(getObjectInfos, { objectApiNames: "$objectApiNames" })
10  objectInfos;
11
12  get objectInfosStr() {
13    return this.objectInfos ? JSON.stringify(this.objectInfos.data, null, 2) : "";
14  }
15}

The Japanese Summer '24 guide is now live

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