ArticleCollection Script API Type

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

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

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
ApplicationId	Read	`Guid`	A Guid uniquely identifying the application.
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.
ContentId	Read	`Guid`	A Guid uniquely identifying the content.
ContentTypeId	Read	`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 of 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 of DateTime`	Delete Date
Description	Read, Write	`String`	Description
EnableHelpfulness	Read, Write	`Nullable of Boolean`	Enable Helpfulness
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
Group	Read, Write	`[[Group Script API Type\|Group]]`	Group
Id	Read, Write	`Nullable of Guid`	Id
IsDeleted	Read, Write	`Nullable of Boolean`	Is Deleted
IsEnabled	Read, Write	`Nullable of Boolean`	A flag representing whether the application is enabled.
Name	Read, Write	`String`	Name
Prefix	Read, Write	`String`	Prefix
ThemeId	Read, Write	`Nullable of Guid`	Theme Id
Url	Read, Write	`String`	A Url to the application on the site.
UrlKey	Read, Write	`String`	Url Key
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = articleCollection.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = articleCollection.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

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

JavaScript

var stringResponse = articleCollection.HtmlDescription(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$articleCollection.ThrowErrors()

JavaScript

articleCollection.ThrowErrors();

Returns

Nothing