ArticleCollection Script API Type

Verint | Telligent Community — Wed, 14 May 2025 17:02:49 GMT

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

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

Properties

Name	Access	Type	Description
ApplicationId	Read	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the application.
ApplicationTypeId	Read	`[[Guid Script API Type\|Guid]]`	A Guid identifying the type of application. All applications of the same type (i.e. wiki) will have the same value here.
ContentId	Read	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the content.
ContentTypeId	Read	`[[Guid Script API Type\|Guid]]`	A Guid identifying the type of content. All content of the same type (i.e. wiki page) will have the same value here.
CreateDate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Create Date
CreatedBy	Read, Write	`[[User Script API Type\|User]]`	Created By
DefaultArticle	Read, Write	`[[Article Script API Type\|Article]]`	Default Article
DefaultType	Read, Write	`[[ArticleType Script API Type\|ArticleType]]`	Default Type
DeleteDate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Delete Date
Description	Read, Write	`[[String Script API Type\|String]]`	Description
EnableHelpfulness	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	Enable Helpfulness
Errors	Read	`[[List Script API Type\|List]] of [[Error Script API Type\|Error]]`	Errors
Group	Read, Write	`[[Group Script API Type\|Group]]`	Group
Id	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Guid Script API Type\|Guid]]`	Id
IsDeleted	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	Is Deleted
IsEnabled	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	A flag representing whether the application is enabled.
Name	Read, Write	`[[String Script API Type\|String]]`	Name
Prefix	Read, Write	`[[String Script API Type\|String]]`	Prefix
ThemeId	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Guid Script API Type\|Guid]]`	Theme Id
Url	Read, Write	`[[String Script API Type\|String]]`	A Url to the application on the site.
UrlKey	Read, Write	`[[String Script API Type\|String]]`	Url Key
Warnings	Read	`[[List Script API Type\|List]] of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = articleCollection.HasErrors();

Returns

[[Boolean Script API Type|Boolean]]

HasWarnings

Velocity

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

JavaScript

var booleanResponse = articleCollection.HasWarnings();

Returns

[[Boolean Script API Type|Boolean]]

HasWarningsOrErrors

Velocity

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

JavaScript

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

JavaScript

var stringResponse = articleCollection.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

$articleCollection.ThrowErrors()

JavaScript

articleCollection.ThrowErrors();

Returns

Nothing

ToString

Velocity

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

JavaScript

var stringResponse = articleCollection.ToString();

Returns

[[String Script API Type|String]]