Interface IObjectIndexClient

Namespace: Noxum.Nova.Index.Client

Assembly: Noxum.Nova.Index.Client.dll

Syntax

public interface IObjectIndexClient

Methods

ObjectCountAsync(int, ObjectCountRequest, CancellationToken)

Get the number of objects that match a search filter

Declaration

Task<ObjectCountResult> ObjectCountAsync(int branch, ObjectCountRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	branch	The branch ID
ObjectCountRequest	request	The count request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectCountResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.

ObjectOccurrencesAsync(int, ObjectOccurrencesRequest, CancellationToken)

Get occurrences of fields of objects that match a search filter

Declaration

Task<ObjectOccurrencesResult> ObjectOccurrencesAsync(int branch, ObjectOccurrencesRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	branch	The branch ID
ObjectOccurrencesRequest	request	The occurrence request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectOccurrencesResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.

ObjectSearchAsync(int, ObjectSearchRequest, CancellationToken)

Search for objects

Declaration

Task<ObjectSearchResult> ObjectSearchAsync(int branch, ObjectSearchRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	branch	The branch ID
ObjectSearchRequest	request	The search request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectSearchResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.

ObjectXmlLinkCountAsync(int, ObjectXmlLinkCountRequest, CancellationToken)

Get the number of objects with XML values that contain links to one
of the objects requested.

Declaration

Task<ObjectCountResult> ObjectXmlLinkCountAsync(int branch, ObjectXmlLinkCountRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	branch	The branch ID
ObjectXmlLinkCountRequest	request	The link count request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<ObjectCountResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.

SuggestionsAsync(int, SuggestionsRequest, CancellationToken)

Get a list of suggestions for a search pattern that may be used for type-ahead

Declaration

Task<SuggestionsResult> SuggestionsAsync(int branch, SuggestionsRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	branch	The branch ID or ApiIdentifier
SuggestionsRequest	request	The Suggestions request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<SuggestionsResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.

WorkItemOccurrencesAsync(WorkItemOccurrencesRequest, CancellationToken)

Get work item occurrences per branch

Declaration

Task<WorkItemOccurrencesResult> WorkItemOccurrencesAsync(WorkItemOccurrencesRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
WorkItemOccurrencesRequest	request	The occurrences request
CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
Task<WorkItemOccurrencesResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.