Search Method

This method searches resources for the specified query.

Syntax

[VB.NET]
Public Sub Search(ByVal Query As String)

[C#]
public void Search(string query);

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:


type	The type of match to return, such as "file" or "folder".
file_extensions	A comma separated list of extensions to search, for instance "txt,doc,pdf".
content_types	A 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:

ResourceDeleted
ResourceETag
ResourceHash (not applicable to folders)
ResourceId
ResourceMarker
ResourceName
ResourceRevision
ResourceType

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);
}

NOTE: This method has a corresponding asynchronous version (SearchAsync) for use in the WinRT environment.