Class ContentSearchRequest
Request to search contents
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class ContentSearchRequest : ContentAggregationOnChannelRequest
Properties
Aggregators
List of aggregators that defines how the items should be aggregated.
Declaration
public ICollection<AggregatorBase> Aggregators { get; set; }
Property Value
System.Collections.Generic.ICollection<AggregatorBase>
|
DebugMode
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
public bool DebugMode { get; set; }
Property Value
System.Boolean
|
DisplayPatternIds
Limits the display values included in the search response. Defaults to all display values.
Declaration
public ICollection<string> DisplayPatternIds { get; set; }
Property Value
System.Collections.Generic.ICollection<System.String>
|
Limit
Limits the document count of the result set.
Declaration
public int Limit { get; set; }
Property Value
System.Int32
|
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
public string PageToken { get; set; }
Property Value
System.String
|
ResolveBehaviors
List of enums that allow additional resolutions on top of the standard Content result
Declaration
public ICollection<ContentSearchResolveBehavior> ResolveBehaviors { get; set; }
Property Value
System.Collections.Generic.ICollection<ContentSearchResolveBehavior>
|
RightsAggregations
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
public ICollection<ContentRight> RightsAggregations { get; set; }
Property Value
System.Collections.Generic.ICollection<ContentRight>
|
RightsFilter
Limits the contents to the ones the user has the specified ContentRights.
Declaration
public ICollection<ContentRight> RightsFilter { get; set; }
Property Value
System.Collections.Generic.ICollection<ContentRight>
|
Sort
Sorts the search results. Sorting on a field not marked as Sortable in the Content schema will throw an exception.
Declaration
public ICollection<SortInfo> Sort { get; set; }
Property Value
System.Collections.Generic.ICollection<SortInfo>
|
Methods
FromJson(String)
Declaration
public static ContentSearchRequest FromJson(string data)
Parameters
System.String
data
|
Returns
ContentSearchRequest
|
ToJson()
Declaration
public string ToJson()
Returns
System.String
|