EntityDefinitionsClientBase

EntityDefinitionsClientBase

クラス EntityDefinitionsClientBase

Version:

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

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

エンティティ定義とそのエンティティを取得する機能が含まれています。

継承

System.Object

EntityDefinitionsClientBase

実装

IEntityDefinitionsClient

名前空間: Stylelabs.M.Sdk.Models.Clients

アセンブリ: Stylelabs.M.Sdk.dll

構文

public abstract class EntityDefinitionsClientBase : object, IEntityDefinitionsClient

備考

このクライアントは、バージョンもキャッシュしている多くのメソッドを公開します。通常、キャッシュされたバリアントを使用することをお勧めします。

コンストラクター

EntityDefinitionsClientBase(IMClient)

宣言

protected EntityDefinitionsClientBase(IMClient client)

パラメーター

型	名前	説明
IMClient	client

メソッド

CreateEntityDefinitionIdIterator(Int64)

システム内で使用可能なすべてのエンティティ定義 ID を反復処理するイテレーターを作成します。結果は ID の昇順で並べられます。

宣言

public IIdIterator CreateEntityDefinitionIdIterator(long pageSize = null)

パラメーター

型	名前	説明
System.Int64	pageSize

戻り値

型	説明
IIdIterator	エンティティ定義 ID イテレーター

CreateEntityDefinitionIterator(Int64)

システム内で使用可能なすべての IEntityDefinition インスタンスを反復処理するイテレーターを作成します。結果は ID の昇順で並べられます。

宣言

public IEntityDefinitionIterator CreateEntityDefinitionIterator(long pageSize = null)

パラメーター

型	名前	説明
System.Int64	pageSize

戻り値

型	説明
IEntityDefinitionIterator	エンティティ定義イテレーター

DeleteAsync(Int64)

Content Hub のエンティティ定義を削除します。そのエンティティ定義が存在しない場合は何の処理も実行されません。

宣言

public abstract Task DeleteAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	削除するエンティティ定義 ID。

戻り値

型	説明
Task	A 表すタスク。

例外

型	条件
ForbiddenException	エンティティ定義は存在するが削除できなかった場合にスローされます。

DeleteAsync(String)

Content Hub のエンティティ定義を削除します。そのエンティティ定義が存在しない場合は何の処理も実行されません。

宣言

public abstract Task DeleteAsync(string name)

パラメーター

型	名前	説明
System.String	name	削除するエンティティ定義の名前。

戻り値

型	説明
Task	A 表すタスク。

例外

型	条件
ForbiddenException	エンティティ定義は存在するが削除できなかった場合にスローされます。

GetAsync(Int64)

指定された id で IEntityDefinition インスタンスを取得します。

宣言

public abstract Task<IEntityDefinition> GetAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	エンティティ定義 ID。

戻り値

型	説明
Task<IEntityDefinition>	IEntityDefinition。エンティティ定義が存在しない場合は null 。

GetAsync(String)

指定された name で IEntityDefinition インスタンスを取得します。

宣言

public abstract Task<IEntityDefinition> GetAsync(string name)

パラメーター

型	名前	説明
System.String	name	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<IEntityDefinition>	IEntityDefinition。エンティティ定義が存在しない場合は null 。

GetCachedAsync(Int64)

指定された id で、キャッシュされた IEntityDefinition インスタンスを取得します。

宣言

public abstract Task<IEntityDefinition> GetCachedAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	エンティティ定義 ID。

戻り値

型	説明
Task<IEntityDefinition>	IEntityDefinition。エンティティ定義が存在しない場合は null 。

GetCachedAsync(String)

指定された name で、キャッシュされた IEntityDefinition インスタンスを取得します。

宣言

public abstract Task<IEntityDefinition> GetCachedAsync(string name)

パラメーター

型	名前	説明
System.String	name	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<IEntityDefinition>	IEntityDefinition。エンティティ定義が存在しない場合は null 。

GetIdAsync(String)

指定されたエンティティ定義の ID を取得します。

宣言

public abstract Task<long?> GetIdAsync(string name)

パラメーター

型	名前	説明
System.String	name	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<System.Nullable<System.Int64>>	エンティティ定義 ID。エンティティ定義が存在しない場合は null 。

GetIdCachedAsync(String)

指定されたキャッシュ済みエンティティ定義の ID を取得します。

宣言

public abstract Task<long?> GetIdCachedAsync(string name)

パラメーター

型	名前	説明
System.String	name	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<System.Nullable<System.Int64>>	エンティティ定義 ID。エンティティ定義が存在しない場合は null 。

GetIdsAsync(IEnumerable<String>)

定義の名前でエンティティ定義 ID を取得します。

宣言

public abstract Task<IDictionary<string, long>> GetIdsAsync(IEnumerable<string> names)

パラメーター

型	名前	説明
IEnumerable<System.String>	names	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<IDictionary<System.String, System.Int64>>	定義名を ID にマップする、null 以外の大文字と小文字を区別しないディクショナリ。

GetIdsCachedAsync(IEnumerable<String>)

定義の名前でキャッシュされたエンティティ定義 ID を取得します。

宣言

public abstract Task<IDictionary<string, long>> GetIdsCachedAsync(IEnumerable<string> names)

パラメーター

型	名前	説明
IEnumerable<System.String>	names	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<IDictionary<System.String, System.Int64>>	定義名を ID にマップする、null 以外の大文字と小文字を区別しないディクショナリ。

GetManyAsync(IEnumerable<Int64>)

定義の ID で IEntityDefinition インスタンスを取得します。結果の順序とサイズが入力と異なる場合があります (定義が存在しない場合)。

宣言

public abstract Task<IList<IEntityDefinition>> GetManyAsync(IEnumerable<long> ids)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids

戻り値

型	説明
Task<IList<IEntityDefinition>>	IEntityDefinition インスタンスの null 以外のコレクション。

GetManyAsync(IEnumerable<String>)

定義の ID で IEntityDefinition インスタンスをを取得します。結果の順序とサイズが入力と異なる場合があります (定義が存在しない場合)。

宣言

public abstract Task<IList<IEntityDefinition>> GetManyAsync(IEnumerable<string> names)

パラメーター

型	名前	説明
IEnumerable<System.String>	names	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<IList<IEntityDefinition>>	IEntityDefinition インスタンスの null 以外のコレクション。

GetManyCachedAsync(IEnumerable<Int64>)

定義の ID でキャッシュされた IEntityDefinition インスタンスを取得します。結果の順序とサイズが入力と異なる場合があります (定義が存在しない場合)。

宣言

public abstract Task<IList<IEntityDefinition>> GetManyCachedAsync(IEnumerable<long> ids)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids

戻り値

型	説明
Task<IList<IEntityDefinition>>	IEntityDefinition インスタンスの null 以外のコレクション。

GetManyCachedAsync(IEnumerable<String>)

定義の ID でキャッシュされた IEntityDefinition インスタンスをを取得します。結果の順序とサイズが入力と異なる場合があります (定義が存在しない場合)。

宣言

public abstract Task<IList<IEntityDefinition>> GetManyCachedAsync(IEnumerable<string> names)

パラメーター

型	名前	説明
IEnumerable<System.String>	names	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<IList<IEntityDefinition>>	IEntityDefinition インスタンスの null 以外のコレクション。

GetManyIdsAsync(IEnumerable<String>)

定義の名前でエンティティ定義 ID を取得します。見つからなかった定義を除いて、ID の順序は names と同じです。

宣言

public abstract Task<IList<long>> GetManyIdsAsync(IEnumerable<string> names)

パラメーター

型	名前	説明
IEnumerable<System.String>	names	エンティティ定義名 (大文字と小文字は区別されません)。

戻り値

型	説明
Task<IList<System.Int64>>	エンティティ定義 ID の null 以外のコレクション。

備考

マッピングがはるかに明確であるため、代わりに GetIdsAsync(IEnumerable<文字列>) の使用をお勧めします。

GetNameAsync(Int64)

指定されたid を持つ IEntityDefinition の名前を取得します。

宣言

public abstract Task<string> GetNameAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	名前を取得する定義の ID。

戻り値

型	説明
Task<System.String>	指定された定義の名前。存在しない場合は null。

GetNameCachedAsync(Int64)

指定されたid を持つキャッシュされた IEntityDefinition の名前を取得します。

宣言

public abstract Task<string> GetNameCachedAsync(long id)

パラメーター

型	名前	説明
System.Int64	id	名前を取得する定義の ID。

戻り値

型	説明
Task<System.String>	指定された定義の名前。存在しない場合は null。

GetNamesAsync(IEnumerable<Int64>)

定義の ID の名前でエンティティ定義名を取得します。

宣言

public abstract Task<IDictionary<long, string>> GetNamesAsync(IEnumerable<long> ids)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids	エンティティ定義 ID。

戻り値

型	説明
Task<IDictionary<System.Int64, System.String>>	定義 ID を名前にマップする、null 以外のディクショナリ。

GetNamesCachedAsync(IEnumerable<Int64>)

定義の ID でキャッシュされたエンティティ定義名を取得します。

宣言

public abstract Task<IDictionary<long, string>> GetNamesCachedAsync(IEnumerable<long> ids)

パラメーター

型	名前	説明
IEnumerable<System.Int64>	ids	エンティティ定義 ID。

戻り値

型	説明
Task<IDictionary<System.Int64, System.String>>	定義 ID を名前にマップする、null 以外のディクショナリ。

GetRangeAsync(Int64, Int64)

指定された範囲でシステム内にある IEntityDefinition インスタンスのセットを取得します。結果は ID の昇順で並べられます。

宣言

public abstract Task<IEntityDefinitionQueryResult> GetRangeAsync(long skip = null, long take = null)

パラメーター

型	名前	説明
System.Int64	skip	指定された数のエンティティ定義をスキップします。値が指定されていない場合、スキップされるアイテムはありません。
System.Int64	take	指定された数のエンティティ定義のみを取り込みます。

戻り値

型	説明
Task<IEntityDefinitionQueryResult>	エンティティ定義のクエリ結果。

GetRangeIdsAsync(Int64, Int64)

指定された範囲でシステム内にあるエンティティ定義 ID のセットを取得します。結果は ID の昇順で並べられます。

宣言

public abstract Task<IIdQueryResult> GetRangeIdsAsync(long skip = null, long take = null)

パラメーター

型	名前	説明
System.Int64	skip	指定された数のエンティティ定義をスキップします。値が指定されていない場合、スキップされるアイテムはありません。
System.Int64	take	指定された数のエンティティ定義のみを取り込みます。

戻り値

型	説明
Task<IIdQueryResult>	エンティティ定義 ID のクエリ結果。

SaveAsync(IEntityDefinition)

Content Hub のエンティティ定義を保存します。

宣言

public abstract Task<long> SaveAsync(IEntityDefinition entityDefinition)

パラメーター

型	名前	説明
IEntityDefinition	entityDefinition	保存するエンティティ定義。

戻り値

型	説明
Task<System.Int64>	Content Hub のエンティティ定義の ID。

例外

型	条件
ValidationException	検証エラーが発生したためにエンティティ定義を保存できなかった場合にスローされます。

実装

IEntityDefinitionsClient

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