Class WordSearchResult

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Define a a set of words and locations where they are found in a section

public class WordSearchResult : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

WordSearchResult

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NextRelationLink

Gets the Uri of the link for the relation “next”.

public string NextRelationLink { get; }

Property Value

Type	Description
string

Remarks

Returns the uri of the link for the relation “next” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

PageHits

Contains a set pages where of words are found

public List<WordSearchResultPageHit> PageHits { get; set; }

Property Value

Type	Description
List<WordSearchResultPageHit>

Search

Contains the search query leading to this result.

public string Search { get; set; }

Property Value

Type	Description
string

Methods

GetWordSearchResultFromNextRelation()

Calls the HTTP Get method on the link for the relation “next”.

public WordSearchResult GetWordSearchResultFromNextRelation()

Returns

Type	Description
WordSearchResult	The content of the response.

GetWordSearchResultFromNextRelationAsync()

Calls the HTTP Get method on the link for the relation “next” asynchronously.

public Task<DeserializedHttpResponse<WordSearchResult>> GetWordSearchResultFromNextRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<WordSearchResult>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

GetWordSearchResultFromNextRelationAsync(CancellationToken)

Calls the HTTP Get method on the link for the relation “next” asynchronously.

public Task<DeserializedHttpResponse<WordSearchResult>> GetWordSearchResultFromNextRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<WordSearchResult>>	A task which runs the request.

Remarks

This method follows the link for the relation “next”.

SetProxy(HttpClientProxy)

Sets the HTTP communication proxy which is used in further HTTP communication.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The HttpClient instance which is used in further HTTP communication.

Remarks

The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.