Search Method

Searches the specified SharePoint site.

Syntax

spsearch.search(query, [callback])

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 this 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 method will search the SharePoint site using the string specified as the Query parameter.

Set the SearchType property to the type of query string specified for the search. By default, the Query string will be a String type format, but can be changed to be an MSSQLFT format as well.

When a successful search returns, the results can be iterated through using the ResultCount and ResultIndex properties. Each result will then populate the ResultProperties with a collection of properties to describe that result.