Challenge Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:24:58 GMT

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

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

Properties
Description
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlDescription
HtmlName
ThrowErrors

Properties

Name	Access	Type	Description
AllowMultipleVotes	Read	`Boolean`	Allow Multiple Votes
ApplicationId	Read	`Guid`	A Guid uniquely identifying the application.
ApplicationKey	Read	`String`	Application Key
ApplicationTypeId	Read	`Guid`	A Guid identifying the type of application. All applications of the same type (i.e. wiki) will have the same value here.
AvatarUrl	Read	`String`	Url to an image particular to the content or content type. If none, return null.
ContentId	Read	`Guid`	A Guid uniquely identifying the content.
CreatedDate	Read	`DateTime`	The date the content was created.
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
Group	Read	`[[Group Script API Type\|Group]]`	Group
Id	Read	`Guid`	Id
IsEnabled	Read	`Boolean`	A flag representing whether the content is enabled. This can be a wrapper for approval states, etc.
IsModerated	Read	`Boolean`	Is Moderated
LastPostDate	Read	`Nullable of DateTime`	Last Post Date
MaximumVotesPerIdea	Read	`Nullable of Int32`	Maximum Votes Per Idea
MaximumVotesPerUser	Read	`Nullable of Int32`	Maximum Votes Per User
Name	Read	`String`	Name
RequiresCategory	Read	`Boolean`	Requires Category
SearchUniqueId	Read	`String`	Search Unique Id
TotalPosts	Read	`Int32`	Total Posts
Url	Read	`String`	A Url to the content on the site.
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

Description

Description Overload 1

Velocity

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

JavaScript

var stringResponse = challenge.Description();

Description Overload 2

Velocity

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

JavaScript

var stringResponse = challenge.Description(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`String`	Target	Required

Returns

String

HasErrors

Velocity

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

JavaScript

var booleanResponse = challenge.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = challenge.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = challenge.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 = $challenge.HtmlDescription($target))

JavaScript

var stringResponse = challenge.HtmlDescription(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`String`	Target	Required

Returns

String

HtmlName

Return the Html encoded name of the content (the subject for example). Possible values for “target” are “Web”, “Email”, or “raw”. When “raw” is specified as the target, the name should not be encoded.

Velocity

#set($stringResponse = $challenge.HtmlName($target))

JavaScript

var stringResponse = challenge.HtmlName(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`String`	Target	Required

Returns

String

ThrowErrors

Velocity

$challenge.ThrowErrors()

JavaScript

challenge.ThrowErrors();

Returns

Nothing