Ideas In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:32:19 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:32:19

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Ideation.Api.IIdeas>() and is defined in Telligent.Evolution.Ideation.dll

Events

Events.AfterCreate

Handler

void IdeaAfterCreateEventHandler([[IdeaAfterCreateEventArgs In-Process API Event Argument|IdeaAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void IdeaAfterDeleteEventHandler([[IdeaAfterDeleteEventArgs In-Process API Event Argument|IdeaAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void IdeaAfterUpdateEventHandler([[IdeaAfterUpdateEventArgs In-Process API Event Argument|IdeaAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void IdeaBeforeCreateEventHandler([[IdeaBeforeCreateEventArgs In-Process API Event Argument|IdeaBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void IdeaBeforeDeleteEventHandler([[IdeaBeforeDeleteEventArgs In-Process API Event Argument|IdeaBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void IdeaBeforeUpdateEventHandler([[IdeaBeforeUpdateEventArgs In-Process API Event Argument|IdeaBeforeUpdateEventArgs]] e);

Events.Render

Handler

void IdeaRenderEventHandler([[IdeaRenderEventArgs In-Process API Event Argument|IdeaRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`	Ideas Content Type Identifier

Methods

Idea Create(Guid challengeId, string name, string body, IdeaCreateOptions options);

Creates an Idea

Parameters

Name	Type	Description	Required
challengeId	`Guid`	Id of the Ideation in which the idea will be created.	Required
name	`string`	The name of the new Idea.	Required
body	`string`	The body content of the new idea.	Required
options	`[[IdeaCreateOptions In-Process API Supplementary Type\|IdeaCreateOptions]]`	Additional options for creation.	Required

Return Type

[[Idea In-Process API Supplementary Type|Idea]]

Idea Current(HttpContext context);

Obsolete. Use Current(Telligent.Evolution.Extensibility.Urls.Version1.PageContext) instead.

Parameters

Name	Type	Description	Required	Default	Options
context	`HttpContext`	Context	Required

Return Type

[[Idea In-Process API Supplementary Type|Idea]]

Idea Current(PageContext pageContext);

Gets the current Idea being viewed, if Page Context includes one

Parameters

Name	Type	Description	Required	Default	Options
pageContext	`[[PageContext In-Process API Supplementary Type\|PageContext]]`	Page Context	Required

Return Type

[[Idea In-Process API Supplementary Type|Idea]]

AdditionalInfo Delete(Guid contentId);

Deletes an Idea

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content id of the idea	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

Idea Get(Guid contentId);

Gets an Idea

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content id of the idea	Required

Return Type

[[Idea In-Process API Supplementary Type|Idea]]

PagedList<Idea> List(IdeasListOptions options);

Lists Ideas

Parameters

Name	Type	Description	Required	Default	Options
options	`[[IdeasListOptions In-Process API Supplementary Type\|IdeasListOptions]]`	Filtering and other categorization options.	Required

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[Idea In-Process API Supplementary Type|Idea]]>

Idea Update(Guid ideaId, IdeaUpdateOptions options);

Updates an Idea

Parameters

Name	Type	Description	Required	Default	Options
ideaId	`Guid`	Id of the Idea to update.	Required
options	`[[IdeaUpdateOptions In-Process API Supplementary Type\|IdeaUpdateOptions]]`	Options for data to update.	Required

Return Type

[[Idea In-Process API Supplementary Type|Idea]]

string UpDownVoteUI(Guid id, UIVoteOptions options);

Renders UI element for voting on an Idea.

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Id of the Idea to render for.	Required
options	`[[UIVoteOptions In-Process API Supplementary Type\|UIVoteOptions]]`	Additional options for rendering.	Required

Return Type

string