Search list options
SearchResultsListOptions
is defined in the Telligent.Evolution.Extensibility.Api.Version1
namespace of Telligent.Evolution.Platform.dll
Definition
class SearchResultsListOptions { Guid? ApplicationId { get; set; } string Category { get; set; } bool? Collapse { get; set; } Guid? ContainerId { get; set; } ICollection<DateRangeFacet> DateRangeFacets { get; set; } ICollection<DateRangeFilter> DateRangeFilters { get; set; } DateTime? EndDate { get; set; } ICollection<FieldFacet> FieldFacets { get; set; } ICollection<FieldFilter> FieldFilters { get; set; } string Filters { get; set; } Guid? Id { get; set; } bool? IsApplication { get; set; } bool? IsContainer { get; set; } bool? IsContent { get; set; } bool? IsLoggable { get; set; } bool? LogicallyOrTags { get; set; } bool? OnlyFriendContent { get; set; } int? PageIndex { get; set; } int? PageSize { get; set; } string Query { get; set; } string SearchFlags { get; set; } string Sort { get; set; } DateTime? StartDate { get; set; } List<string> Tags { get; set; } }
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ApplicationId | Guid? | Application Id | ||
Category | string | Category | ||
Collapse | bool? | Collapse | False | |
ContainerId | Guid? | Container Id | ||
DateRangeFacets | ICollection<DateRangeFacet> | Date range facets | ||
DateRangeFilters | ICollection<DateRangeFilter> | Date range filters | ||
EndDate | DateTime? | End date | ||
FieldFacets | ICollection<FieldFacet> | Field facets | ||
FieldFilters | ICollection<FieldFilter> | Field filters | ||
Filters | string | Filters is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | ||
Id | Guid? | Id | ||
IsApplication | bool? | Is Application | ||
IsContainer | bool? | Is Container | ||
IsContent | bool? | Is Content | ||
IsLoggable | bool? | Whether the search should be logged for reporting. | ||
LogicallyOrTags | bool? | Whether to AND or OR tags specified in the Tags parameter. Default is False, logically AND tags. | ||
OnlyFriendContent | bool? | Is Only Friend Content | ||
PageIndex | int? | Specify the page number of paged results to return. Zero-based index. | 0 | |
PageSize | int? | Specify the number of results to return per page. | 20 | |
Query | string | Query is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. | ||
SearchFlags | string | Comma delimited list of search flags, used for flagging the search as well as for reporting. | ||
Sort | string | Sort | date, date asc, date desc, titlesort, titlesort asc, titlesort desc | |
StartDate | DateTime? | Start date | ||
Tags | List<string> | Comma delimited list of tags. |