com.box.sdkgen.managers.search

Class SearchManager

Object

SearchManager

public class SearchManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	SearchManager()
protected	SearchManager(SearchManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Authentication	getAuth()
NetworkSession	getNetworkSession()
MetadataQueryResults	searchByMetadataQuery(MetadataQuery requestBody) Create a search using SQL-like syntax to return items that match specific metadata.
MetadataQueryResults	searchByMetadataQuery(MetadataQuery requestBody, SearchByMetadataQueryHeaders headers) Create a search using SQL-like syntax to return items that match specific metadata.
SearchResultsResponse	searchForContent() Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
SearchResultsResponse	searchForContent(SearchForContentHeaders headers) Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
SearchResultsResponse	searchForContent(SearchForContentQueryParams queryParams) Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.
SearchResultsResponse	searchForContent(SearchForContentQueryParams queryParams, SearchForContentHeaders headers) Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

SearchManager

public SearchManager()

SearchManager

protected SearchManager(SearchManager.Builder builder)

Method Detail

searchByMetadataQuery

public MetadataQueryResults searchByMetadataQuery(MetadataQuery requestBody)

Create a search using SQL-like syntax to return items that match specific metadata.

By default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the `fields` attribute in the query.

Parameters:

requestBody - Request body of searchByMetadataQuery method

searchByMetadataQuery

public MetadataQueryResults searchByMetadataQuery(MetadataQuery requestBody,
                                                  SearchByMetadataQueryHeaders headers)

Create a search using SQL-like syntax to return items that match specific metadata.

By default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the `fields` attribute in the query.

Parameters:

requestBody - Request body of searchByMetadataQuery method

headers - Headers of searchByMetadataQuery method

searchForContent

public SearchResultsResponse searchForContent()

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

searchForContent

public SearchResultsResponse searchForContent(SearchForContentQueryParams queryParams)

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Parameters:

queryParams - Query parameters of searchForContent method

searchForContent

public SearchResultsResponse searchForContent(SearchForContentHeaders headers)

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Parameters:

headers - Headers of searchForContent method

searchForContent

public SearchResultsResponse searchForContent(SearchForContentQueryParams queryParams,
                                              SearchForContentHeaders headers)

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Parameters:

queryParams - Query parameters of searchForContent method

headers - Headers of searchForContent method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()