Idea Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:27:21 GMT

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

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

Properties
Description
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlDescription
StatusNotes
ThrowErrors

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

Returns

String

HasErrors

Velocity

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

JavaScript

var booleanResponse = idea.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = idea.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = idea.HasWarningsOrErrors();

Returns

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`	Target	Required

Returns

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`	Target	Required

Returns

String

ThrowErrors

Velocity

$idea.ThrowErrors()

JavaScript

idea.ThrowErrors();

Returns

Nothing