GenericRepositoryTQuerySubset Method

Relativity Services API

Fetches additional search results after a call to Query.

Namespace: kCura.Relativity.Client.Repositories
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5

Syntax

Copy

public QueryResultSet<T> QuerySubset(
	string queryToken,
	int start,
	int length
)

Public Function QuerySubset ( 
	queryToken As String,
	start As Integer,
	length As Integer
) As QueryResultSet(Of T)

Parameters

queryToken: Type: SystemString
The query token value provided in the QueryResult.
start: Type: SystemInt32
The starting index used to select a subset of Artifacts from the List of all Artifacts that satisfy the initial Query() call. The List index starts with 1.
length: Type: SystemInt32
The maximum number of results to return.

Return Value

Type: QueryResultSetT
A QueryResultSet containing up to length search results.

Implements

IGenericRepositoryTQuerySubset(String, Int32, Int32)

Remarks

When a Query returns a large amount of data of a type that supports paging, this method returns the first page of data and provides a QueryToken. The only way to retrieve subsequent pages of data is by passing a QueryToken to a QuerySubset call.

Reference

GenericRepositoryT Class

kCura.Relativity.Client.Repositories Namespace