1. WebクライアントSDK

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

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

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

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

警告

エンティティ定義の追加、削除、削除は、非常に大きな結果を招く可能性があるため、細心の注意を払って行う必要があります。大きな力には大きな責任が伴います。疑わしい場合は、何かをする前に尋ねてください。

メモ

次のコード例のclient変数は、IMClientインスタンスを参照します。Web SDKを使用する場合、変数名は自由に選択できますが、ドキュメントではインスタンス化時にclientとも呼ばれます。

エンティティ定義を取得する

エンティティ定義は、名前またはIDで取得できます。

IEntityDefinition assetDefinition = await MClient.EntityDefinitions.GetAsync("M.Asset");
IEntityDefinition assetDefinition = await MClient.EntityDefinitions.GetAsync(assetDefId);

エンティティ定義が存在しない場合、メソッドはnullを返します。

手記

1つ以上のエンティティ定義を取得するためのオーバーロードは他にも多数あります。名前をIDに解決したり、その逆に解決したりすることもできます。完全な概要については、APIリファレンス を参照してください。

エンティティ定義の作成

エンティティ定義オブジェクトは直接インスタンス化でき、ファクトリは必要ありません。非常に単純なエンティティ定義は、次のように作成できます。

IEntityDefinition definition = new EntityDefinition
{
  Name = "M.Demo.Definition",
  DisplayTemplate = "{M.Demo.Definition.Name}"
};

var defaultGroup = new MemberGroup { Name = "Default" };
defaultGroup.MemberDefinitions.Add(new StringPropertyDefinition
{
  Name = "M.Demo.Definition.Name",
  IsUnique = true
});

definition.MemberGroups.Add(defaultGroup);

long id = await MClient.EntityDefinitions.SaveAsync(definition);

返されるidは、新しく作成されたエンティティ定義のIDです。

手記

EntityDefinitionStylelabs.M.Sdk.Models.Baseからインポートでき、プロパティ メンバー定義はStylelabs.M.Sdk.Models.Base.PropertyDefinitionsからインポートできます。

エンティティ定義の更新

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

long id = await MClient.EntityDefinitions.SaveAsync(definition);

返されるidは、エンティティ定義のIDと同じです。

エンティティ定義の削除

エンティティ定義は、名前またはIDで削除できます。

await MClient.EntityDefinitions.DeleteAsync(definitionId);
await MClient.EntityDefinitions.DeleteAsync("M.Demo.Definition");
この記事を改善するための提案がある場合は、 お知らせください!