Enables scripted content fragments to use Ideations
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ContentTypeId | Guid | Ideations content type identifier | ||
Current | Challenge | Current contextual Ideation | ||
TotalLicensedRemaining | int | Total number licensed ideations |
Methods
Create
Creates a Challenge
Usage
#set($challengeResponse = $telligentIdeas_v1_challenges.Create($groupId, $name, "%{AllowMultipleVotes = $allowMultipleVotesArg, ApplicationKey = $applicationKeyArg, Description = $descriptionArg, IsEnabled = $isEnabledArg, IsModerated = $isModeratedArg, MaximumVotesPerIdea = $maximumVotesPerIdeaArg, MaximumVotesPerUser = $maximumVotesPerUserArg, RequiresCategory = $requiresCategoryArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
name | string | Name | Required | ||
AllowMultipleVotes | bool | Allow Multiple Votes | Optional | ||
ApplicationKey | string | Application Key | Optional | ||
Description | string | Description | Optional | ||
IsEnabled | bool | Is Enabled | Optional | ||
IsModerated | bool | Is Moderated | Optional | ||
MaximumVotesPerIdea | int | The maximum number of votes a user can cast for a given idea. Not setting this value or setting it to 0 will allow users to use as many votes as they have available on any given idea. This setting is only valid when multiple votes are permitted. | Optional | ||
MaximumVotesPerUser | int | The maximum number of votes a user can cast within this ideation. Not setting this value or setting it to 0 will result in vote per user per idea. | Optional | ||
RequiresCategory | bool | Requires Category | Optional |
Return Type
Delete
Deletes a Challenge
Usage
#set($additionalInfoResponse = $telligentIdeas_v1_challenges.Delete($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Content Id | Required |
Return Type
Get
Gets a Challenge
Usage
#set($challengeResponse = $telligentIdeas_v1_challenges.Get($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Idea Id | Required |
Return Type
List
Lists Ideations
Usage
#set($pagedListResponse = $telligentIdeas_v1_challenges.List($groupId, "%{ContentIds = $contentIdsArg, IncludeSubGroups = $includeSubGroupsArg, NameQuery = $nameQueryArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
ContentIds | string | Comma separated list of ApplicationIds. Used to limit to a specific set of ideas as well as sort order if SoryBy is set to ApplicationIdsOrder. | Optional | ||
IncludeSubGroups | bool | Include Sub Groups | Optional | False | |
NameQuery | string | Name Query | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
SortBy | string | Sort By | Optional | date | applicationidsorder, date, lastpost, name, totalposts |
SortOrder | string | Sort Order | Optional | descending | ascending, descending |
Return Type
Update
Updates a Challenge
Usage
#set($challengeResponse = $telligentIdeas_v1_challenges.Update($id, "%{AllowMultipleVotes = $allowMultipleVotesArg, ApplicationKey = $applicationKeyArg, Description = $descriptionArg, GroupId = $groupIdArg, IsEnabled = $isEnabledArg, IsModerated = $isModeratedArg, MaximumVotesPerIdea = $maximumVotesPerIdeaArg, MaximumVotesPerUser = $maximumVotesPerUserArg, Name = $nameArg, RequiresCategory = $requiresCategoryArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id | Required | ||
AllowMultipleVotes | bool | Allow Multiple Votes | Optional | ||
ApplicationKey | string | Application Key | Optional | ||
Description | string | Description | Optional | ||
GroupId | int | group id | Optional | ||
IsEnabled | bool | Is Enabled | Optional | ||
IsModerated | bool | Is Moderated | Optional | ||
MaximumVotesPerIdea | int | The maximum number of votes a user can cast for a given idea. Setting to zero(0) will allow a user to use as many votes as they have available on any idea. This setting is only valid when multiple votes are permitted. | Optional | ||
MaximumVotesPerUser | int | The maximum number of votes a user can cast within this ideation. To reset this back to 1 vote per user per idea, set it to 0. | Optional | ||
Name | string | Name | Optional | ||
RequiresCategory | bool | Requires Category | Optional |