ArticleListOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Articles.dll
Definition
class ArticleListOptions
{
Guid? ArticleCollectionId { get; set; }
string ArticleCollectionIds { get; set; }
string ArticleIds { get; set; }
int? AuthorId { get; set; }
string CategoryIds { get; set; }
bool? HasScheduledUpdate { get; set; }
bool? InCategory { get; set; }
string IncludeArticleTypeIds { get; set; }
bool? IsDefault { get; set; }
bool? IsDeleted { get; set; }
bool? IsPublished { get; set; }
int? PageIndex { get; set; }
int? PageSize { get; set; }
DateTime? PublishAfterDate { get; set; }
DateTime? PublishBeforeDate { get; set; }
int? PublishGroupId { get; set; }
string SortBy { get; set; }
string SortOrder { get; set; }
string Tags { get; set; }
bool? WasPublished { get; set; }
}
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ArticleCollectionId | Guid? | The single article collection to filter articles by. | ||
| ArticleCollectionIds | string | A comma-separated list of article collection ids to filter the articles by. | ||
| ArticleIds | string | A comma-separated list of article ids to return. To maintain the order specified in your list, set 'SortBy' to 'ArticleIds'. | ||
| AuthorId | int? | |||
| CategoryIds | string | A comma-separated list of category ids to filter the articles by. | ||
| HasScheduledUpdate | bool? | Returns articles that have an active unpublished version that is ready to publish. | ||
| InCategory | bool? | Allows filtering only articles within or not within a category. Ignored if CategoryIds is passed in. | True | |
| IncludeArticleTypeIds | string | A comma-separated list of article type ids to filter the articles by. | ||
| IsDefault | bool? | Allows filtering articles that are the default of a category or a collection. | ||
| IsDeleted | bool? | Filter. | False | |
| IsPublished | bool? | Whether to return publish or unpublished articles. | True | |
| 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 articles to return per paged request. The default is 20, the maximum is 100. | ||
| PublishAfterDate | DateTime? | Include only articles with a publish date after the provided date. | ||
| PublishBeforeDate | DateTime? | Include only articles with a publish date before the provided date. | ||
| PublishGroupId | int? | The publish group to filter articles by. Returns articles with an active version in the publish group. | ||
| SortBy | string | The sort option for the articles. SortOrder is only valid when filtering by one categoryId and sorts by the SortOrder then Title. | PublishDate | ArticleIds, DeleteDate, LastUpdateDate, PublishDate, SortOrder, Title, TotalHelpfulRatings, TotalNotHelpfulRatings |
| SortOrder | string | The direction to sort the articles by based on the current SortBy options. The options are 'Ascending' or 'Descending'. 'Ascending' is the default. | ||
| Tags | string | Comma separated list of tags to filter articles by. | ||
| WasPublished | bool? | Articles that have been published but are no longer published and do not have a draft. |