1. EntitiesClientBase

クラス EntitiesClientBase

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

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

エンティティを取得および操作する機能が含まれています。

継承
System.Object
EntitiesClientBase
名前空間: Stylelabs.M.Sdk.Models.Clients
アセンブリ: Stylelabs.M.Sdk.dll
構文
public abstract class EntitiesClientBase : object, IEntitiesClient
備考

可能であれば、エンティティをフェッチするときに必要な特定のプロパティとリレーションを必ず含めてください。 IEntityLoadConfiguration

コンストラクター

EntitiesClientBase(IMClient)

宣言
protected EntitiesClientBase(IMClient client)
パラメーター
型名前説明
IMClientclient

メソッド

DeleteAsync(Int64)

M で指定された ID を持つ IEntity を削除します。 そのエンティティが存在しない場合は何の処理も実行されません。

宣言
public abstract Task DeleteAsync(long entityId)
パラメーター
型名前説明
System.Int64entityId

削除するエンティティの ID。

戻り値
型説明
Task

A 表すタスク。

例外
型条件
ForbiddenException

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

GetAsync(Int64, IEntityLoadConfiguration)

指定された id を持つ IEntity インスタンスを取得します。

宣言
public abstract Task<IEntity> GetAsync(long id, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
System.Int64id

取得するエンティティの ID。

IEntityLoadConfigurationloadConfiguration

エンティティの読み込み設定。

戻り値
型説明
Task<IEntity>

エンティティ、またはエンティティが見つからなかった場合は null。

GetAsync(String, IEntityLoadConfiguration)

指定された identifier を持つ IEntity インスタンスを取得します。

宣言
public abstract Task<IEntity> GetAsync(string identifier, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
System.Stringidentifier

取得するエンティティの識別子。

IEntityLoadConfigurationloadConfiguration

エンティティの読み込み設定。

戻り値
型説明
Task<IEntity>

エンティティ、またはエンティティが見つからなかった場合は null。

GetByDefinitionAsync(String, IEntityLoadConfiguration, Int32, Int32)

指定された定義のエンティティのクエリ。

宣言
public Task<IEntityQueryResult> GetByDefinitionAsync(string definition, IEntityLoadConfiguration loadConfiguration = null, int skip = null, int take = null)
パラメーター
型名前説明
System.Stringdefinition

エンティティを取得するための定義の名前 (大文字と小文字は区別されません)。

IEntityLoadConfigurationloadConfiguration

エンティティの読み込み設定。

System.Int32skip

指定された数のエンティティをスキップします。 値が指定されていない場合、スキップされるアイテムはありません。

System.Int32take

指定された数のエンティティのみを取り込みます。 値が指定されていない場合、既定の Take が使用されます。

戻り値
型説明
Task<IEntityQueryResult>

イテレーター。

GetEntityIdIterator(String)

エンティティ ID を返す、指定された definition の IIdIterator を作成します。 結果は作成日の昇順に並べ替えられます。

宣言
public IIdIterator GetEntityIdIterator(string definition)
パラメーター
型名前説明
System.Stringdefinition

エンティティを取得するための定義の名前 (大文字と小文字は区別されません)。

戻り値
型説明
IIdIterator

イテレーター。

GetEntityIterator(String, IEntityLoadConfiguration)

IEntity インスタンスを返す、指定された definition の IEntityIterator を作成します。結果は作成日の昇順に並べ替えられます。

宣言
public IEntityIterator GetEntityIterator(string definition, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
System.Stringdefinition

エンティティを取得するための定義の名前 (大文字と小文字は区別されません)。

IEntityLoadConfigurationloadConfiguration

エンティティの読み込み設定。

戻り値
型説明
IEntityIterator

イテレーター。

GetIdsByDefinitionAsync(String, Int32, Int32)

指定された定義のエンティティ ID のクエリ。

宣言
public Task<IIdQueryResult> GetIdsByDefinitionAsync(string definition, int skip = null, int take = null)
パラメーター
型名前説明
System.Stringdefinition

エンティティを取得するための定義の名前 (大文字と小文字は区別されません)。

System.Int32skip

指定された数のエンティティをスキップします。 値が指定されていない場合、スキップされるアイテムはありません。

System.Int32take

指定された数のエンティティのみを取り込みます。 値が指定されていない場合、既定の Take が使用されます。

戻り値
型説明
Task<IIdQueryResult>

イテレーター。

GetManyAsync(IEnumerable<Int64>, IEntityLoadConfiguration)

指定された ids を持つ複数の IEntity インスタンスを取得します。 結果の順序とサイズが入力と異なる場合があります (エンティティが存在しない場合)。

宣言
public abstract Task<IList<IEntity>> GetManyAsync(IEnumerable<long> ids, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
IEnumerable<System.Int64>ids

取得するエンティティの ID (複数)。

IEntityLoadConfigurationloadConfiguration

エンティティの読み込み設定。

戻り値
型説明
Task<IList<IEntity>>

エンティティの (null 以外の) リスト。

GetManyAsync(IEnumerable<String>, IEntityLoadConfiguration)

指定された複数の identifier を持つ複数の IEntity インスタンスを取得します。 結果の順序とサイズが入力と異なる場合があります (エンティティが存在しない場合)。

宣言
public Task<IList<IEntity>> GetManyAsync(IEnumerable<string> identifiers, IEntityLoadConfiguration loadConfiguration = null)
パラメーター
型名前説明
IEnumerable<System.String>identifiers

取得するエンティティの識別子 (複数)。

IEntityLoadConfigurationloadConfiguration

エンティティの読み込み設定。

戻り値
型説明
Task<IList<IEntity>>

エンティティの (null 以外の) リスト。

SaveAsync(IEntity)

M のエンティティを保存します。

宣言
public abstract Task<long> SaveAsync(IEntity entity)
パラメーター
型名前説明
IEntityentity

保存するエンティティ。

戻り値
型説明
Task<System.Int64>

M のエンティティの ID。

備考

既存の entity はいかなる方法でも更新されません。 永続化後にサーバー上で生成された情報が必要な場合は、 それらのエンティティは再度フェッチする必要があります。

例外
型条件
ValidationException

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

実装

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