Interface ICommentIndexClient

Namespace: Noxum.Nova.Index.Client

Assembly: Noxum.Nova.Index.Client.dll

Syntax

public interface ICommentIndexClient

Methods

CommentCountAsync(int, CommentCountRequest, CancellationToken)

Get the number of comments that match a search filter

Declaration

Task<CommentCountResult> CommentCountAsync(int branch, CommentCountRequest request, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<CommentCountResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.

CommentOccurrencesAsync(int, CommentOccurrencesRequest, CancellationToken)

Get occurrences of fields of comments that match a (possible empty) search filter

Declaration

Task<CommentOccurrencesResult> CommentOccurrencesAsync(int branch, CommentOccurrencesRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	branch	The branch ID
CommentOccurrencesRequest	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<CommentOccurrencesResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.

CommentSearchAsync(int, CommentSearchRequest, CancellationToken)

Search for comments

Declaration

Task<CommentSearchResult> CommentSearchAsync(int branch, CommentSearchRequest request, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	branch	The branch ID
CommentSearchRequest	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<CommentSearchResult>	OK

Exceptions

Type	Condition
IndexApiException	A server side error occurred.