IObjectAdapterWithTest インターフェイス

定義

JSON パッチ ドキュメントで実行できる操作 ("test" など) を定義します。

public interface class IObjectAdapterWithTest : Microsoft::AspNetCore::JsonPatch::Adapters::IObjectAdapter
public interface IObjectAdapterWithTest : Microsoft.AspNetCore.JsonPatch.Adapters.IObjectAdapter
type IObjectAdapterWithTest = interface
    interface IObjectAdapter
Public Interface IObjectAdapterWithTest
Implements IObjectAdapter
派生
実装

メソッド

Add(Operation, Object)

"追加" 操作を使用すると、新しい値がターゲット ドキュメントのルート、指定した有効なインデックスのターゲット配列、または指定した場所にあるターゲット オブジェクトに挿入されます。

配列にを追加する場合、指定したインデックスは配列内の要素の数を超えてはなりません。 配列に値を追加するには、"-" 文字のインデックスが使用されます (「[RFC6901]」を参照)。

オブジェクトに追加するときに、オブジェクト メンバーがまだ存在しない場合は、指定した場所にあるオブジェクトに新しいメンバーが追加されるか、オブジェクト メンバーが存在する場合は、そのメンバーの値が置き換えられます。

操作オブジェクトには、追加する値を指定するコンテンツを持つ "value" メンバーが含まれている必要があります。

例:

{ "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] }

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-4

(継承元 IObjectAdapter)
Copy(Operation, Object)

"コピー" 操作を使用すると、指定した場所からターゲットの場所に値がコピーされます。

操作オブジェクトには、値のコピー元となるターゲット ドキュメント内の場所を参照する "from" メンバーが含まれている必要があります。

操作を成功させるには、"from" の場所が存在する必要があります。

例:

{ "op": "copy", "from": "/a/b/c", "path": "/a/b/e" }

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-7

(継承元 IObjectAdapter)
Move(Operation, Object)

"移動" 操作を使用すると、指定した場所の値が削除され、ターゲットの場所に追加されます。

操作オブジェクトには、値の移動元となるターゲット ドキュメント内の場所を参照する "from" メンバーが含まれている必要があります。

操作を成功させるには、"from" の場所が存在する必要があります。

例:

{ "op": "move", "from": "/a/b/c", "path": "/a/b/d" }

場所を子の 1 つに移動することはできません。

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-6

(継承元 IObjectAdapter)
Remove(Operation, Object)

"削除" 操作を使用すると、ターゲットの場所の値が削除されます。

操作を成功させるには、ターゲットの場所が存在する必要があります。

例:

{ "op": "remove", "path": "/a/b/c" }

配列から要素を削除すると、指定したインデックスの上にある要素が 1 つ左にシフトされます。

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-6

(継承元 IObjectAdapter)
Replace(Operation, Object)

"置換" 操作を使用すると、ターゲットの場所の値が新しい値に置き換えられます。 操作オブジェクトには、置換値を指定する "value" メンバーが含まれている必要があります。

操作を成功させるには、ターゲットの場所が存在する必要があります。

例:

{ "op": "replace", "path": "/a/b/c", "value": 42 }

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-6

(継承元 IObjectAdapter)
Test(Operation, Object)

"テスト" 操作を使用すると、ターゲットの場所にある値が、指定した値と等しいかどうかが比較されます。

操作オブジェクトには、ターゲットの場所の値と比較する値を指定する "value" メンバーが含まれている必要があります。

操作を成功と見なすには、ターゲットの場所が "value" 値と等しい必要があります。

例: { "op": "test", "path": "/a/b/c", "value": "foo" }

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-7

適用対象