PropertyOperation Property

This property shows the operation to perform on a property when calling PatchProperties .

Syntax

 webdav.getPropertyOperation(index, [callback])
 webdav.setPropertyOperation(index,  propertyOperation, [callback])

Possible Values

  0 (opNone), 
  1 (opSet), 
  2 (opDelete)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPropertyOperation([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPropertyOperation([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property shows the operation to perform on a property when calling PatchProperties.

This is used when the class sends a property patch request to the server. When a call is made to PatchProperties, the class will use the PropertyOperation to tell the server what to do under the following scheme:

opNone (0)No operation will be performed on the property.
opSet (1)The value of PropertyName will be set to PropertyValue.
opDelete (2)The property defined by PropertyName will be removed from its resource.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the PropertyCount property.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8161]