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

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

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

SDKはエンティティに対してCRUD操作を行うための エンティティクライアント を提供します。

!注以下のコード例の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);

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