ISearchesClient Interface Reference

The Laserfiche Repository Searches API client. More...

Inheritance diagram for ISearchesClient:

Public Member Functions
Task< SearchContextHitCollectionResponse >	ListSearchContextHitsAsync (ListSearchContextHitsParameters parameters, CancellationToken cancellationToken=default(CancellationToken))
	Returns the context hits associated with a search result entry. More...
Task	ListSearchContextHitsForEachAsync (Func< SearchContextHitCollectionResponse, Task< bool >> callback, ListSearchContextHitsParameters parameters, int? maxPageSize=null, CancellationToken cancellationToken=default)
	Returns the context hits associated with a search result entry using paging. Page results are returned to the callback . More...
Task< SearchContextHitCollectionResponse >	ListSearchContextHitsNextLinkAsync (string nextLink, int? maxPageSize=null, CancellationToken cancellationToken=default)
	Returns the context hits associated with a search result entry using a nextlink. More...
Task< EntryCollectionResponse >	ListSearchResultsAsync (ListSearchResultsParameters parameters, CancellationToken cancellationToken=default(CancellationToken))
	Returns the results listing associated with a search task. More...
Task	ListSearchResultsForEachAsync (Func< EntryCollectionResponse, Task< bool >> callback, ListSearchResultsParameters parameters, int? maxPageSize=null, CancellationToken cancellationToken=default)
	Returns a collection of search results using paging. Page results are returned to the callback . More...
Task< EntryCollectionResponse >	ListSearchResultsNextLinkAsync (string nextLink, int? maxPageSize=null, CancellationToken cancellationToken=default)
	Returns a collection of search results using a nextlink. More...
Task< StartTaskResponse >	StartSearchEntryAsync (StartSearchEntryParameters parameters, CancellationToken cancellationToken=default(CancellationToken))
	Starts an asynchronous search task. More...

Detailed Description

The Laserfiche Repository Searches API client.

Member Function Documentation

ListSearchContextHitsAsync()

Task<SearchContextHitCollectionResponse> ListSearchContextHitsAsync	(	ListSearchContextHitsParameters	parameters,
		CancellationToken	cancellationToken = default(CancellationToken)
	)

Returns the context hits associated with a search result entry.

• Returns the context hits associated with a search result entry.
  
• Given a taskId, and rowNumber associated with a search entry in the listing, return the context hits for that entry.
  
• Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.
  
• Required OAuth scope: repository.Read

Parameters

parameters	Parameters for the request.
cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

A collection of context hits for a search result.

Exceptions

ApiException

A server side error occurred.

Implemented in SearchesClient.

ListSearchContextHitsForEachAsync()

Task ListSearchContextHitsForEachAsync	(	Func< SearchContextHitCollectionResponse, Task< bool >>	callback,
		ListSearchContextHitsParameters	parameters,
		int?	maxPageSize = null,
		CancellationToken	cancellationToken = default
	)

Returns the context hits associated with a search result entry using paging. Page results are returned to the callback .

• Related: ListSearchContextHitsAsync

Parameters

callback	A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.
parameters	Parameters for the request.
maxPageSize	Optionally specify the maximum number of items to retrieve.
cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

ApiException

A server side error occurred.

Implemented in SearchesClient.

ListSearchContextHitsNextLinkAsync()

Task<SearchContextHitCollectionResponse> ListSearchContextHitsNextLinkAsync	(	string	nextLink,
		int?	maxPageSize = null,
		CancellationToken	cancellationToken = default
	)

Returns the context hits associated with a search result entry using a nextlink.

• Related: ListSearchContextHitsAsync

Parameters

nextLink	A url that allows retrieving the next subset of the requested collection.
maxPageSize	Optionally specify the maximum number of items to retrieve.
cancellationToken	Optional cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

A collection of context hits for a search result.

Exceptions

ApiException

A server side error occurred.

Implemented in SearchesClient.

ListSearchResultsAsync()

Task<EntryCollectionResponse> ListSearchResultsAsync	(	ListSearchResultsParameters	parameters,
		CancellationToken	cancellationToken = default(CancellationToken)
	)

Returns the results listing associated with a search task.

• Returns a search result listing if the search is completed.
  
• Search results expire after 5 minutes, but can be refreshed by retrieving the results again.
  
• Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type.
  
• Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.
  
• Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
  
• Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc".
  
• Required OAuth scope: repository.Read

Parameters

parameters	Parameters for the request.
cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

A collection of entry search results.

Exceptions

ApiException

A server side error occurred.

Implemented in SearchesClient.

ListSearchResultsForEachAsync()

Task ListSearchResultsForEachAsync	(	Func< EntryCollectionResponse, Task< bool >>	callback,
		ListSearchResultsParameters	parameters,
		int?	maxPageSize = null,
		CancellationToken	cancellationToken = default
	)

Returns a collection of search results using paging. Page results are returned to the callback .

• Related: ListSearchResultsAsync

Parameters

callback	A delegate that will be called each time new data is retrieved. Returns false to stop receiving more data; returns true to be called again if there's more data.
parameters	Parameters for the request.
maxPageSize	Optionally specify the maximum number of items to retrieve.
cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

ApiException

A server side error occurred.

Implemented in SearchesClient.

ListSearchResultsNextLinkAsync()

Task<EntryCollectionResponse> ListSearchResultsNextLinkAsync	(	string	nextLink,
		int?	maxPageSize = null,
		CancellationToken	cancellationToken = default
	)

Returns a collection of search results using a nextlink.

• Related: ListSearchResultsAsync

Parameters

nextLink	A url that allows retrieving the next subset of the requested collection.
maxPageSize	Optionally specify the maximum number of items to retrieve.
cancellationToken	Optional cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

A collection of entry search results.

Exceptions

ApiException

A server side error occurred.

Implemented in SearchesClient.

StartSearchEntryAsync()

Task<StartTaskResponse> StartSearchEntryAsync	(	StartSearchEntryParameters	parameters,
		CancellationToken	cancellationToken = default(CancellationToken)
	)

Starts an asynchronous search task.

• Runs a search operation on the repository.
  
• The status for search operations must be checked via the Tasks route.
  
• Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage).
  
• Required OAuth scope: repository.Read

Parameters

parameters	Parameters for the request.
cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

A long operation task id.

Exceptions

ApiException

A server side error occurred.

Implemented in SearchesClient.

---

The documentation for this interface was generated from the following files:

• src/Clients/RepositoryClients.cs
• src/Clients/SearchesClient.cs