IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

SearchKind Property

The kind of resources to search for.

Syntax

 dropbox.getSearchKind([callback])
 dropbox.setSearchKind( searchKind, [callback])

Possible Values

  0 (dskActive), 
  1 (dskDeleted)

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 getSearchKind([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 setSearchKind([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 specifies what kind of resources to search for when Search is called. Possible values are:

dskActive (0) (default) Search for active resources.
dskDeleted (1) Search for deleted resources.

This property is not available at design time.

Data Type

Integer

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