CategoryListOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Articles.dll
Definition
class CategoryListOptions
{
Guid? ArticleId { get; set; }
int? ArticleVersion { get; set; }
bool? CategoryOrChildrenHaveArticles { get; set; }
Guid? DefaultArticleId { get; set; }
bool? IsDeleted { get; set; }
int? ParentId { get; set; }
bool? RootLevelOnly { get; set; }
string SortBy { get; set; }
string SortOrder { get; set; }
}
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ArticleId | Guid? | Id of the article. Filter categores to a specific article. | ||
| ArticleVersion | int? | Only used when ArticleId is specified. Filters categories that are assigned to specific article version. | ||
| CategoryOrChildrenHaveArticles | bool? | Only returns categories that have published articles, or direct children have published articles. Cannot be used if filtering by ArticleId. | ||
| DefaultArticleId | Guid? | Return categories that use the provided article as their default. | ||
| IsDeleted | bool? | Filters categories that have been deleted. | False | |
| ParentId | int? | Id of the parent. | ||
| RootLevelOnly | bool? | Only returns the root level categories. When true, parent id is ignored. | ||
| SortBy | string | The sort option for the categories. | SortOrder | CreateDate, DeleteDate, Name, SortOrder |
| SortOrder | string | The direction to sort the categories by based on the current SortBy options. The options are 'Ascending' or 'Descending'. 'Ascending' is the default. |