1. JavaScript SDK

エンティティ クライアント

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

このSDKは、エンティティに対してCRUD操作を実行するためのEntities clientを提供します。

メモ

次のコード例のclient変数は、ContentHubClientインスタンスを参照します。JavaScript SDKを使用する場合、変数名は自由に選択できますが、ドキュメントではインスタンス化時にclientとも呼ばれます。 entityId引数は、入力として64ビットの数値を使用します。

エンティティを取得する

次のメソッドは、エンティティをそのIDで取得します。

var entity: IEntity = await client.entities.getAsync(entityId);

エンティティが存在しないか、ユーザーがエンティティを読み取る権限を持っていない場合、メソッドはnullを返します。

手記

エンティティをID、識別子、または定義で読み込むための多くのオプションがあります。さまざまなオプションの詳細については、APIリファレンス ドキュメントのIEntitiesClientを参照してください。

手記

エンティティをロードするときに ロード設定 を渡すことができます。

エンティティの作成

エンティティは、EntityFactoryを使用してのみインスタンス化できます。

次のスニペットでは、Assetエンティティがローカルに作成されます。

import { CultureLoadOption } from "@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/culture-load-option";

var entity: IEntity = await client.entityFactory.createAsync("M.Asset", new CultureLoadOption(["en-US"]));

次のスニペットでは、ローカルに作成されたAssetエンティティがContent Hubに送信され、検証および永続化されます。

var id: number = await client.entities.saveAsync(entity);

返されるidは、新しく作成されたエンティティのIDです。このエンティティの最新バージョンを取得するには、IDを使用してContent Hubから再度取得します。

エンティティの更新

エンティティの作成と同様に、変更を実行した後、エンティティクライアントでsaveAsyncメソッドを使用します。

var id: number = await client.entities.saveAsync(entity);

返されるidは、エンティティの同じIDです。このエンティティの最新バージョンを取得するには、IDを使用してサーバーから再度取得します。

エンティティの削除

エンティティの削除は、エンティティ クライアントのdeleteAsyncメソッドを使用して実現できます。エンティティのIDは、削除のために指定する必要があります。

await client.entities.deleteAsync(entityId);
この記事を改善するための提案がある場合は、 お知らせください!