Class ContentSearchRequest
Request to search contents
Inheritance
ContentSearchRequest
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ContentSearchRequest : ContentAggregationOnChannelRequest
Properties
List of aggregators that defines how the items should be aggregated.
Declaration
[JsonProperty("aggregators", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AggregatorBase> Aggregators { get; set; }
Property Value
Enable debug mode: additional debug information regarding the query execution and reason of the matched documents are returned in the ContentSearchResult.
Warning! It severely affects performance.
Declaration
[JsonProperty("debugMode", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public bool DebugMode { get; set; }
Property Value
Limits the display values included in the search response. Defaults to all display values.
Declaration
[JsonProperty("displayPatternIds", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> DisplayPatternIds { get; set; }
Property Value
Limits the document count of the result set.
Declaration
[JsonProperty("limit", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
public int Limit { get; set; }
Property Value
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
List of enums that allow additional resolutions on top of the standard Content result
Declaration
[JsonProperty("resolveBehaviors", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<ContentSearchResolveBehavior> ResolveBehaviors { get; set; }
Property Value
Returns the aggregated document counts to the ones the user has the specified ContentRights.
Produces the rightsAggregationCounts on the ContentSearchResult. View will be ignored as the totalResults already gives this information.
Declaration
[JsonProperty("rightsAggregations", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<ContentRight> RightsAggregations { get; set; }
Property Value
Limits the contents to the ones the user has the specified ContentRights.
Declaration
[JsonProperty("rightsFilter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore, ItemConverterType = typeof(StringEnumConverter))]
public ICollection<ContentRight> RightsFilter { get; set; }
Property Value
Sorts the search results. Sorting on a field not marked as Sortable in the Content schema will throw an exception.
Declaration
[JsonProperty("sort", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<SortInfo> Sort { get; set; }
Property Value
Methods
Declaration
public static ContentSearchRequest FromJson(string data)
Parameters
Returns