Search Results for

    Show / Hide Table of Contents

    Class ContentFilterRequest

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

    Properties

    BrokenDependenciesFilter

    Filter the content document result set to those that have or not have broken references

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

    ChannelId

    Limits the simple search fields to the fields available in the specified channel.

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

    CollectionId

    The collection id.

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

    Filter

    An optional search filter. Limits the content document result set.

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

    LifeCycleFilter

    Limits the content document result set to that life cycle state. Defaults to ActiveOnly.

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

    RightsFilter

    Limits the content document result set to specific ContentRights the user has

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

    SearchLanguages

    Only searches the specified language values. Defaults to all metadata languages of the language configuration.

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

    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

    SearchType

    Type of search to be performed: against metadata, extracted fulltext from documents or both. Default to Metadata.

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

    Methods

    FromJson(string)

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

    Returns
    ContentFilterRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX