HelpfulnessListOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Articles.dll
Definition
class HelpfulnessListOptions
{
bool AnonymousAuthorOnly { get; set; }
Guid? ArticleId { get; set; }
Guid? ArticleVersionId { get; set; }
int? AuthorId { get; set; }
Guid? CollectionId { get; set; }
int? HelpfulnessResponseTypeId { get; set; }
bool IncludeIgnored { get; set; }
bool? IsHelpful { get; set; }
int? PageIndex { get; set; }
int? PageSize { get; set; }
Guid? ResolvedArticleVersionId { get; set; }
string SortBy { get; set; }
string SortOrder { get; set; }
string State { get; set; }
}
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| AnonymousAuthorOnly | bool | If true, only anonymous helpfulness items are returned. | False | |
| ArticleId | Guid? | Filters the items submitted for a specific article regardless of version. A CollectionId or ArticleId is required. | ||
| ArticleVersionId | Guid? | Filters the items submitted for a specific version of an article. A CollectionId or ArticleId is required. | ||
| AuthorId | int? | The user who submitted the helpfulness feedback. | ||
| CollectionId | Guid? | Show helpfulness items across an article collection. An ArticleId is required. | ||
| HelpfulnessResponseTypeId | int? | The id of a valid helpfulness response type to filter by. | ||
| IncludeIgnored | bool | If true, responses flagged to be ignored will be returned. | False | |
| IsHelpful | bool? | Filters the list to items that are considered helpful only if true, not helpful if false. By default both types will be returned. | ||
| PageIndex | int? | The specific page of the results to return, zero based. | 0 | |
| PageSize | int? | The total amount of items to be returned per page of the results. | 20 | |
| ResolvedArticleVersionId | Guid? | Filters the items resolved by a specific published article version. An ArticleId is required. | ||
| SortBy | string | The property to sort the list by. | CreateDate | |
| SortOrder | string | The order by which to filter. | Ascending, Descending | |
| State | string | Filters the items by a specific resolution state. | All, Resolved, Unresolved |