ArticleVersionListOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Articles.dll
Definition
class ArticleVersionListOptions
{
bool? InCategory { get; set; }
string IncludeArticleTypeIds { get; set; }
bool? InPublishGroup { get; set; }
bool? IsDefault { get; set; }
bool? IsDeleted { get; set; }
bool? IsPublished { get; set; }
int? PageIndex { get; set; }
int? PageSize { get; set; }
int? PublishGroupId { get; set; }
bool? ReadyToPublish { get; set; }
string SortBy { get; set; }
string SortOrder { get; set; }
}
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| InCategory | bool? | Allows filtering only article versions within or not within a category. | True | |
| IncludeArticleTypeIds | string | A comma-separated list of article type ids to filter the article versions by. | ||
| InPublishGroup | bool? | Allows filtering only article versions within or not within a publish group, ignored if PublishGroupId is passed in. | ||
| IsDefault | bool? | Allows filtering articles that are the default of a category or a collection. | ||
| IsDeleted | bool? | Filters artilces that have been deleted. | False | |
| IsPublished | bool? | Filters versions that have been publised or are still unpublished. | ||
| PageIndex | int? | The page index to return based on page size. This value is 'zero' based and defaults to zero. | ||
| PageSize | int? | The total amount of versions to return per paged request. The default is 20, the maximum is 100. | ||
| PublishGroupId | int? | Specifies the publish group to filter on. | ||
| ReadyToPublish | bool? | Whether the article version is ready to publish or not. | ||
| SortBy | string | The sort option for the article version. SortOrder is only valid when filtering by one categoryId and sorts by the SortOrder then Title. | LastUpdateDate | DeleteDate, IsPublished, LastUpdateDate, PublishDate, ReadyToPublish, Title |
| SortOrder | string | The direction to sort the versions by based on the current SortBy options. The options are 'Ascending' or 'Descending'. 'Ascending' is the default. |