ApplyPatchesAsync Method
Overloads
| ApplyPatchesAsync(IEnumerable<NxPatch>, Boolean) |
Applies a patch to the properties of an object. Allows an update to some of the properties. It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch. In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future. |
|
| ApplyPatchesAsync(AsyncHandle, IEnumerable<NxPatch>, Boolean) |
Applies a patch to the properties of an object. Allows an update to some of the properties. It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch. In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future. |
ApplyPatchesAsync(IEnumerable<NxPatch>, Boolean)
Applies a patch to the properties of an object. Allows an update to some of the properties.
It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.
In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation.
Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId",
and it will be forbidden in the near future.
Declaration
public Task ApplyPatchesAsync([QixName("qPatches")] IEnumerable<NxPatch> patches, [QixName("qSoftPatch")] bool softPatch = false)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<NxPatch> | patches |
Array of patches. |
| System.Boolean | softPatch |
If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Implements
Remarks
Soft properties apply only to generic objects.
ApplyPatchesAsync(AsyncHandle, IEnumerable<NxPatch>, Boolean)
Applies a patch to the properties of an object. Allows an update to some of the properties.
It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.
In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation.
Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId",
and it will be forbidden in the near future.
Declaration
public Task ApplyPatchesAsync(AsyncHandle asyncHandle, [QixName("qPatches")] IEnumerable<NxPatch> patches, [QixName("qSoftPatch")] bool softPatch = false)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Collections.Generic.IEnumerable<NxPatch> | patches |
Array of patches. |
| System.Boolean | softPatch |
If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch. The default value is false. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Implements
Remarks
Soft properties apply only to generic objects.
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!