Class CommentIndexClient

Implementation of ICommentIndexClient

Inheritance

object

CommentIndexClient

Implements

ICommentIndexClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Noxum.Nova.Index.Client

Assembly: Noxum.Nova.Index.Client.dll

Syntax

public class CommentIndexClient : ICommentIndexClient

Constructors

CommentIndexClient(string, HttpClient)

Declaration

public CommentIndexClient(string baseUrl, HttpClient httpClient)

Parameters

Type	Name	Description
string	baseUrl
HttpClient	httpClient

Properties

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
string

JsonSerializerSettings

Declaration

protected JsonSerializerOptions JsonSerializerSettings { get; }

Property Value

Type	Description
JsonSerializerOptions

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
bool

Methods

CommentCountAsync(int, CommentCountRequest, CancellationToken)

Get the number of comments that match a search filter

Declaration

public virtual 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

public virtual 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

public virtual 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.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

Declaration

protected virtual Task<CommentIndexClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
HttpResponseMessage	response
IReadOnlyDictionary<string, IEnumerable<string>>	headers
CancellationToken	cancellationToken

Returns

Type	Description
Task<CommentIndexClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

Implements

ICommentIndexClient