Forum Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:26:10 GMT

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

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

Properties
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlDescription
ThrowErrors

Properties

Name	Access	Type	Description
AllowedThreadTypes	Read, Write	`IList of String`	Allowed Thread Types
ApplicationId	Read, Write	`Guid`	A Guid uniquely identifying the application.
AutoLockingDefaultInterval	Read, Write	`Nullable of Int32`	Auto Locking Default Interval
AutoLockingEnabled	Read, Write	`Nullable of Boolean`	Auto Locking Enabled
AvatarUrl	Read	`String`	This can represent a Url to an image particular to the application or application type.
Container	Read	`[[Container Script API Type\|Container]]`	The container in which the application is located.
ContentId	Read	`Guid`	A Guid uniquely identifying the content.
DateCreated	Read, Write	`Nullable of DateTime`	Date Created
DefaultThreadStatus	Read, Write	`String`	Default Thread Status
DefaultThreadType	Read, Write	`String`	Default Thread Type
Description	Read, Write	`String`	Description
EmailAddress	Read, Write	`String`	Email Address
EmailFooter	Read, Write	`String`	Email Footer
EnableAnonymousPosting	Read, Write	`Boolean`	This has been obsoleted and will always return true. Check permissions on the forum instead.
Enabled	Read, Write	`Boolean`	Enabled
EnablePassiveMode	Read, Write	`Boolean`	Enable Passive Mode
EnablePostPoints	Read, Write	`Boolean`	Obsolete. Obsolete in 10.0. This option is no longer used. Enable Post Points
EnablePostStatistics	Read, Write	`Boolean`	Enable Post Statistics
EnableQualityVoting	Read, Write	`Boolean`	Enable Quality Voting
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
ExtendedAttributes	Read, Write	`[[ApiList Script API Type\|ApiList]] of [[ExtendedAttribute Script API Type\|ExtendedAttribute]]`	Extended Attributes
Group	Read, Write	`[[Group Script API Type\|Group]]`	Group
Id	Read, Write	`Nullable of Int32`	Id
IndexPosts	Read, Write	`Boolean`	Index Posts
Key	Read	`String`	Key
LatestPostDate	Read, Write	`Nullable of DateTime`	Latest Post Date
MailingListName	Read, Write	`String`	Mailing List Name
ModeratePosts	Read, Write	`Boolean`	Moderate Posts
Name	Read, Write	`String`	Name
PassiveModeAddress	Read, Write	`String`	Passive Mode Address
PostsToModerate	Read, Write	`Nullable of Int32`	Posts To Moderate
ReplyCount	Read, Write	`Int32`	Reply Count
SuggestedAnswerVoteThreshold	Read, Write	`Int32`	Suggested Answer Vote Threshold
ThreadCount	Read, Write	`Int32`	Thread Count
Url	Read, Write	`String`	A Url to the application on the site.
VerifiedAnswerVoteThreshold	Read, Write	`Int32`	Verified Answer Vote Threshold
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = forum.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = forum.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = forum.HasWarningsOrErrors();

Returns

Boolean

HtmlDescription

This method should return the Html encoded description of the application. 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. If there is no description, an empty string should be returned.

Velocity

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

JavaScript

var stringResponse = forum.HtmlDescription(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$forum.ThrowErrors()

JavaScript

forum.ThrowErrors();

Returns

Nothing