Search Results for

    Show / Hide Table of Contents

    Class FileTransferSearchRequest

    Request to search for file transfers.

    Inheritance
    object
    FileTransferSearchRequest
    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 FileTransferSearchRequest

    Properties

    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 FileTransferSearchRequest FromJson(string data)
    Parameters
    string data

    Returns
    FileTransferSearchRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX