Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

Search Method

This method searches resources for the specified query.

Syntax

box.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 searches for files and folders matching the specified query. The server will match the specified Query parameter against item names, descriptions, and file contents.

If the results are paged, the SearchMarker property will be populated. Call this method again to retrieve the next page of results. When the last page of results is returned SearchMarker will be empty.

Advanced searching can be performed by adding additional query parameters using the AddQueryParam method. Some common parameters and possible values are:

typeThe type of match to return, such as "file" or "folder".
file_extensionsA comma separated list of extensions to search, for instance "txt,doc,pdf".
content_typesA comma separated list of the content types to search. Possible values are "name","description","file_content","comments", and "tags".

For a full list of additional parameters consult the Box.com documentation.

After calling this method set ResourceIndex to a value from 0 to ResourceCount - 1. Setting ResourceIndex populates other Resource properties to provide information about the resource.

After calling this method the following resource properties are populated:

Search Example:

box.AddQueryParam("type", "file"); //Only return files
box.Search("test");
for (int i = 0; i < box.ResourceCount; i++)
{
  box.ResourceIndex = i;
  Console.WriteLine(box.ResourceName);
}

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0