Idea Script API Type

Verint | Telligent Community — Wed, 14 May 2025 17:04:55 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:04:55

Content created on the site must implement this interface for the social services to support it.

Properties

Name	Access	Type	Description
Author	Read	`[[User Script API Type\|User]]`	Author
Category	Read	`[[IdeaCategory Script API Type\|IdeaCategory]]`	Category
Challenge	Read	`[[Challenge Script API Type\|Challenge]]`	Challenge
ContentId	Read	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the content.
CreatedDate	Read	`[[DateTime Script API Type\|DateTime]]`	The date the content was created.
CurrentStatus	Read	`[[IdeaStatus Script API Type\|IdeaStatus]]`	Current Status
Errors	Read	`[[List Script API Type\|List]] of [[Error Script API Type\|Error]]`	Errors
Id	Read	`[[Guid Script API Type\|Guid]]`	Id
IsEnabled	Read	`[[Boolean Script API Type\|Boolean]]`	A flag representing whether the content is enabled. This can be a wrapper for approval states, etc.
IsSuspectedAbusive	Read	`[[Boolean Script API Type\|Boolean]]`	Is Suspected Abusive
LastUpdatedDate	Read	`[[DateTime Script API Type\|DateTime]]`	Last Updated Date
Name	Read	`[[String Script API Type\|String]]`	Name
NoVotes	Read	`[[Number Script API Type\|Number]]`	No Votes
Score	Read	`[[Number Script API Type\|Number]]`	Score
SearchUniqueId	Read	`[[String Script API Type\|String]]`	Search Unique Id
Status	Read	`[[Status Script API Type\|Status]]`	Status
StatusAuthor	Read	`[[User Script API Type\|User]]`	Status Author
StatusDate	Read	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Status Date
TotalVotes	Read	`[[Number Script API Type\|Number]]`	Total Votes
Url	Read	`[[String Script API Type\|String]]`	A Url to the content on the site.
UrlKey	Read	`[[String Script API Type\|String]]`	Url Key
Warnings	Read	`[[List Script API Type\|List]] of [[Warning Script API Type\|Warning]]`	Warnings
YesVotes	Read	`[[Number Script API Type\|Number]]`	Yes Votes

Methods

Description

Description Overload 1

Velocity

#set($stringResponse = $idea.Description())

JavaScript

var stringResponse = idea.Description();

Description Overload 2

Velocity

#set($stringResponse = $idea.Description($target))

JavaScript

var stringResponse = idea.Description(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[String Script API Type\|String]]`	Target	Required

Returns

[[String Script API Type|String]]

HasErrors

Velocity

#set($booleanResponse = $idea.HasErrors())

JavaScript

var booleanResponse = idea.HasErrors();

Returns

[[Boolean Script API Type|Boolean]]

HasWarnings

Velocity

#set($booleanResponse = $idea.HasWarnings())

JavaScript

var booleanResponse = idea.HasWarnings();

Returns

[[Boolean Script API Type|Boolean]]

HasWarningsOrErrors

Velocity

#set($booleanResponse = $idea.HasWarningsOrErrors())

JavaScript

var booleanResponse = idea.HasWarningsOrErrors();

Returns

[[Boolean Script API Type|Boolean]]

HtmlDescription

Return the Html encoded description of the content (the body, for example). Possible values for “target” are “Web”, “Email”, “WebServices”, or “raw”. When “raw” is specified as the target, the description should not be encoded or have any special rendering done to it.

Velocity

#set($stringResponse = $idea.HtmlDescription($target))

JavaScript

var stringResponse = idea.HtmlDescription(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[String Script API Type\|String]]`	Target	Required

Returns

[[String Script API Type|String]]

StatusNotes

StatusNotes Overload 1

Velocity

#set($stringResponse = $idea.StatusNotes())

JavaScript

var stringResponse = idea.StatusNotes();

StatusNotes Overload 2

Velocity

#set($stringResponse = $idea.StatusNotes($target))

JavaScript

var stringResponse = idea.StatusNotes(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[String Script API Type\|String]]`	Target	Required

Returns

[[String Script API Type|String]]

ThrowErrors

Velocity

$idea.ThrowErrors()

JavaScript

idea.ThrowErrors();

Returns

Nothing

ToString

Velocity

#set($stringResponse = $idea.ToString())

JavaScript

var stringResponse = idea.ToString();

Returns

[[String Script API Type|String]]