Forum Script API Type

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

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

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

Properties

Name	Access	Type	Description
AllowedThreadTypes	Read, Write	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Allowed Thread Types
ApplicationId	Read, Write	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the application.
AutoLockingDefaultInterval	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Auto Locking Default Interval
AutoLockingEnabled	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	Auto Locking Enabled
AvatarUrl	Read	`[[String Script API Type\|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 Script API Type\|Guid]]`	A Guid uniquely identifying the content.
DateCreated	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Date Created
DefaultThreadStatus	Read, Write	`[[String Script API Type\|String]]`	Default Thread Status
DefaultThreadType	Read, Write	`[[String Script API Type\|String]]`	Default Thread Type
Description	Read, Write	`[[String Script API Type\|String]]`	Description
EmailAddress	Read, Write	`[[String Script API Type\|String]]`	Email Address
EmailFooter	Read, Write	`[[String Script API Type\|String]]`	Email Footer
Enabled	Read, Write	`[[Boolean Script API Type\|Boolean]]`	Enabled
EnablePassiveMode	Read, Write	`[[Boolean Script API Type\|Boolean]]`	Enable Passive Mode
EnablePostStatistics	Read, Write	`[[Boolean Script API Type\|Boolean]]`	Enable Post Statistics
EnableQualityVoting	Read, Write	`[[Boolean Script API Type\|Boolean]]`	Enable Quality Voting
Errors	Read	`[[List Script API Type\|List]] 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 Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Id
IndexPosts	Read, Write	`[[Boolean Script API Type\|Boolean]]`	Index Posts
Key	Read	`[[String Script API Type\|String]]`	Key
LatestPostDate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Latest Post Date
MailingListName	Read, Write	`[[String Script API Type\|String]]`	Mailing List Name
ModeratePosts	Read, Write	`[[Boolean Script API Type\|Boolean]]`	Moderate Posts
Name	Read, Write	`[[String Script API Type\|String]]`	Name
PassiveModeAddress	Read, Write	`[[String Script API Type\|String]]`	Passive Mode Address
PostsToModerate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Posts To Moderate
ReplyCount	Read, Write	`[[Number Script API Type\|Number]]`	Reply Count
SuggestedAnswerVoteThreshold	Read, Write	`[[Number Script API Type\|Number]]`	Suggested Answer Vote Threshold
ThreadCount	Read, Write	`[[Number Script API Type\|Number]]`	Thread Count
Url	Read, Write	`[[String Script API Type\|String]]`	A Url to the application on the site.
VerifiedAnswerVoteThreshold	Read, Write	`[[Number Script API Type\|Number]]`	Verified Answer Vote Threshold
Warnings	Read	`[[List Script API Type\|List]] of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = forum.HasErrors();

Returns

[[Boolean Script API Type|Boolean]]

HasWarnings

Velocity

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

JavaScript

var booleanResponse = forum.HasWarnings();

Returns

[[Boolean Script API Type|Boolean]]

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = forum.HasWarningsOrErrors();

Returns

[[Boolean Script API Type|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 Script API Type\|String]]`	Target	Required

Returns

[[String Script API Type|String]]

ThrowErrors

Velocity

$forum.ThrowErrors()

JavaScript

forum.ThrowErrors();

Returns

Nothing

ToString

Velocity

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

JavaScript

var stringResponse = forum.ToString();

Returns

[[String Script API Type|String]]