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

Version:

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

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

この SDK は、エンティティに対して CRUD 操作を実行するエンティティクライアントを提供しています。

注意

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

エンティティの取得

次のメソッドは、ID によってエンティティを取得します。

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

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

注意

ID、識別子、または定義によってエンティティを読み込むために複数のオプションが用意されています。各オプションの詳細については、API リファレンスドキュメントの IEntitiesClient を参照してください。

注意

エンティティを読み込むときに、読み込み設定を渡すことができます。読み込み設定の詳細については、読み込み設定セクションを参照してください。

エンティティの作成

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

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

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"]));

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

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

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

エンティティの更新

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

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

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

エンティティの削除

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

await client.entities.deleteAsync(entityId);

この記事を改善するための提案がある場合は、お知らせください!