Search Results for

    Show / Hide Table of Contents

    Class ListItemFilterRequest

    Request to filter list items

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

    Properties

    BrokenDependenciesFilter

    Limits the search to the list items that have or not have broken references. By default it includes both.

    Declaration
    [JsonProperty("brokenDependenciesFilter", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    [JsonConverter(typeof(StringEnumConverter))]
    public BrokenDependenciesFilter BrokenDependenciesFilter { get; set; }
    Property Value
    BrokenDependenciesFilter

    Filter

    An optional filter to limit the list items.

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

    IncludeAllSchemaChildren

    Broadens the search to include all schema descendant list items.

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

    SchemaIds

    Limits the search among the list items of the provided schemas.

    Declaration
    [JsonProperty("schemaIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<string> SchemaIds { get; set; }
    Property Value
    ICollection<string>

    SearchLanguages

    When searching in multi language fields, limit the searchable fields to the ones corresponding to the specified languages.
    If not specified, all metadata languages defined in the system are used.

    Declaration
    [JsonProperty("searchLanguages", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<string> SearchLanguages { get; set; }
    Property Value
    ICollection<string>

    SearchString

    The string used to query the data. 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 ListItemFilterRequest FromJson(string data)
    Parameters
    string data

    Returns
    ListItemFilterRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX