IdeasListOptions
is defined in the Telligent.Evolution.Extensibility.Ideation.Api
namespace of Telligent.Evolution.Ideation.dll
Definition
class IdeasListOptions { int? AccessingUserId { get; set; } int? CategoryId { get; set; } Guid? ChallengeId { get; set; } List<Guid> ContentIds { get; set; } int? GroupId { get; set; } bool IgnorePermissions { get; set; } bool IncludeSubGroups { get; set; } bool? IsClosed { get; set; } bool? IsEnabled { get; set; } bool? IsSuspectedAbusive { get; set; } int? MaximumVoteCount { get; set; } int? MinimumVoteCount { get; set; } string NameQuery { get; set; } int PageIndex { get; set; } int PageSize { get; set; } Guid Permission { get; set; } string QueryType { get; set; } bool? ReleasesVotes { get; set; } string SortBy { get; set; } string SortOrder { get; set; } string Status { get; set; } int? UserId { get; set; } }
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
AccessingUserId | int? | The current user. | ||
CategoryId | int? | Filter Ideas by Category. | ||
ChallengeId | Guid? | Only include Ideas from the specified Ideation. | ||
ContentIds | List<Guid> | Directly specify a list of ideas by Content Id. Used to limit to a specific set of ideas as well as sort order if SortBy is set to ContentIdsOrder | ||
GroupId | int? | Only include Ideas from the specified Group. | ||
IgnorePermissions | bool | Setting IgnorePermissions=true will not filter results by the Permission. | False | |
IncludeSubGroups | bool | Specify whether to include results from subgroups of the specified groups. | False | |
IsClosed | bool? | Filter Ideas by whether they are in a Closed status. | ||
IsEnabled | bool? | Filter Ideas by whether they are enabled. | True | |
IsSuspectedAbusive | bool? | Filter Ideas by whether they are suspected as abusive. | False | |
MaximumVoteCount | int? | Only include Ideas with at most this many votes. | ||
MinimumVoteCount | int? | Only include Ideas with at least this many votes. | ||
NameQuery | string | Filter Ideas by name. | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | 0 | |
PageSize | int | Specify the number of results to return per page. | 20 | |
Permission | Guid | Filter Ideas to only those the current user has a certain permission for. Default: Read Ideas permission. | ||
QueryType | string | Specify restrictions on the query. 'active' will exclude ideas in a Closed status. 'myideas' will only return ideas where the current user (or query.UserId) is the author. 'myvotes' will only return ideas the current user (or query.UserId) has voted on. 'topquality' ignores other query options and sorts by idea quality score descending | active | active, all, myideas, myvotes, topquality |
ReleasesVotes | bool? | Filter Ideas by whether they are in a status that releases votes in a vote-limited Ideation. | ||
SortBy | string | Specify a value to use to sort the list of Ideas. Default: 'score'. When specifying 'contentidsorder', ContentIds must be included. | score | contentidsorder, date, lastupdateddate, novotes, score, statuslastupdateddate, topic (sorts by Name), totalvotes, yesvotes |
SortOrder | string | Specify which direction to order the ideas sorted by SortBy. | descending | Ascending, Descending |
Status | string | Filter Ideas by status. | ||
UserId | int? | Filter Ideas to those created by this user. When specified, also used for 'my'- QueryTypes. |