Search Results for

    Show / Hide Table of Contents

    Class TransferSearchRequest

    Request to search for transfers.

    Inheritance
    object
    TransferSearchRequest
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class TransferSearchRequest

    Properties

    DebugMode

    Enable debug mode: additional debug information regarding the query execution and reason of the matched documents are returned in the TransferSearchResult.
    Warning! It severely affects performance.

    Declaration
    [JsonProperty("debugMode", Required = Required.Always)]
    public bool DebugMode { get; set; }
    Property Value
    bool

    Filter

    An optional search filter. Limits the document result set.

    Declaration
    [JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public FilterBase Filter { get; set; }
    Property Value
    FilterBase

    Limit

    Limits the document count of the result set.

    Declaration
    [JsonProperty("limit", Required = Required.Always)]
    public int Limit { get; set; }
    Property Value
    int

    PageToken

    The token used to retrieve the next page of results. It must be null on first request and only filled with the returned pageToken to request next page of results.

    Declaration
    [JsonProperty("pageToken", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string PageToken { get; set; }
    Property Value
    string

    SearchBehaviors

    An optional list of search behaviors. All the passed behaviors will be applied.

    Declaration
    [JsonProperty("searchBehaviors", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
    public ICollection<SearchBehavior> SearchBehaviors { get; set; }
    Property Value
    ICollection<SearchBehavior>

    SearchString

    Limits the search by using a query string filter. The Lucene query string syntax is supported.

    Declaration
    [JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string SearchString { get; set; }
    Property Value
    string

    Methods

    FromJson(string)

    Declaration
    public static TransferSearchRequest FromJson(string data)
    Parameters
    string data

    Returns
    TransferSearchRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX