Class SearchArg

The search arg object

Inheritance

System.Object

SearchArg

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dropbox.Api.Files

Assembly: Dropbox.Api.dll

Syntax

public class SearchArg

Constructors

SearchArg(String, String, UInt64, UInt64, SearchMode)

Initializes a new instance of the SearchArg class.

Declaration

public SearchArg(string path, string query, ulong start = 0UL, ulong maxResults = 100UL, SearchMode mode = null)

Parameters

Type	Name	Description
System.String	path	The path in the user's Dropbox to search. Should probably be a folder.
System.String	query	The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car").
System.UInt64	start	The starting index within the search results (used for paging).
System.UInt64	maxResults	The maximum number of search results to return.
SearchMode	mode	The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.

Properties

MaxResults

The maximum number of search results to return.

Declaration

public ulong MaxResults { get; protected set; }

Property Value

Type	Description
System.UInt64

Mode

The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.

Declaration

public SearchMode Mode { get; protected set; }

Property Value

Type	Description
SearchMode

Path

The path in the user's Dropbox to search. Should probably be a folder.

Declaration

public string Path { get; protected set; }

Property Value

Type	Description
System.String

Query

The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car").

Declaration

public string Query { get; protected set; }

Property Value

Type	Description
System.String

Start

The starting index within the search results (used for paging).

Declaration

public ulong Start { get; protected set; }

Property Value

Type	Description
System.UInt64