ArticleCollectionsListOptions In-Process API Supplementary Type

ArticleCollectionsListOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Articles.dll

Definition

class ArticleCollectionsListOptions
{
	string ArticleCollectionIds { get; set;  }
	string ContainerIds { get; set;  }
	int? GroupId { get; set;  }
	bool? IncludeSubGroups { get; set;  }
	bool? IsDeleted { get; set;  }
	int? PageIndex { get; set;  }
	int? PageSize { get; set;  }
	Guid? PermissionId { get; set;  }
	string SortBy { get; set;  }
	string SortOrder { get; set;  }
}

Properties

Name	Type	Description	Default
ArticleCollectionIds	`string`	A comma-separated list of article collection ids to return. To maintain the order specified in your list, set 'SortBy' to 'ArticleCollectionIds'.
ContainerIds	`string`	A comma-separated list of group container ids to filter the collection set by.
GroupId	`int?`	The group to list the collections by.
IncludeSubGroups	`bool?`	Only used when GroupId is specified.
IsDeleted	`bool?`	Filters collections that have been deleted.	False
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 article collections to return per paged request. The default is 20, the maximum is 100.
PermissionId	`Guid?`	Only include collections in which the accessing user is granted this permission.
SortBy	`string`	The sort option for the collections. Valid options are Name, CreateDate, ArticleCollectionIds (Only valid when ArticleCollectionIds are specified). Name is the default.
SortOrder	`string`	The direction to sort the collections by based on the current SortBy options. The options are 'Ascending' or 'Descending'. 'Ascending' is the default.

Recommended