Show / Hide Table of Contents

Class SearchResponse

The result from a search.

Inheritance
System.Object
SearchResponse
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Redis.OM.Searching
Assembly: Redis.OM.dll
Syntax
public class SearchResponse

Constructors

| Improve this Doc View Source

SearchResponse(RedisReply)

Initializes a new instance of the SearchResponse class.

Declaration
public SearchResponse(RedisReply val)
Parameters
Type Name Description
RedisReply val

The redis response.

Properties

| Improve this Doc View Source

DocumentCount

Gets the number of documents found by the search.

Declaration
public long DocumentCount { get; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

Documents

Gets the documents from the search.

Declaration
public IDictionary<string, IDictionary<string, string>> Documents { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IDictionary<System.String, System.String>>

Methods

| Improve this Doc View Source

DocumentsAs<T>()

gets document as a collection of the provided type.

Declaration
public IDictionary<string, T> DocumentsAs<T>()
Returns
Type Description
System.Collections.Generic.IDictionary<System.String, T>

A dictionary of the response type with their keys.

Type Parameters
Name Description
T

The type.

  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX