Article Script API Type

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

Properties
Body
HasErrors
HasWarnings
HasWarningsOrErrors
ThrowErrors

Properties

Name	Access	Type	Description
ActiveVersionCount	Read, Write	`Nullable of Int32`	Active Version Count
ArticleCollection	Read, Write	`ArticleCollection`	Article Collection
Author	Read, Write	`User`	Author
Categories	Read, Write	`ApiList of ArticleCategory`	Categories
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
DeleteDate	Read, Write	`Nullable of DateTime`	Delete Date
Errors	Read	`IList of Error`	Errors
Id	Read, Write	`Nullable of Guid`	Id
Identifier	Read, Write	`String`	Identifier
IsDeleted	Read, Write	`Nullable of Boolean`	Is Deleted
IsPublished	Read, Write	`Nullable of Boolean`	Is Published
LastUpdateDate	Read, Write	`Nullable of DateTime`	Last Update Date
MetaDescription	Read, Write	`String`	Meta Description
MetaKeywords	Read, Write	`String`	Meta Keywords
MetaTitle	Read, Write	`String`	Meta Title
PublishDate	Read, Write	`Nullable of DateTime`	Publish Date
PublishEndDate	Read, Write	`Nullable of DateTime`	Publish End Date
PublishGroup	Read, Write	`PublishGroup`	Publish Group
SuppressNotifications	Read, Write	`Nullable of Boolean`	Suppress Notifications
Tags	Read, Write	`ApiList of String`	Tags
Title	Read, Write	`String`	Title
TotalHelpful	Read, Write	`Nullable of Int32`	Total Helpful
TotalNotHelpful	Read, Write	`Nullable of Int32`	Total Not Helpful
Type	Read, Write	`ArticleType`	Type
Url	Read, Write	`String`	A Url to the content on the site.
UrlKey	Read, Write	`String`	Url Key
Version	Read, Write	`Nullable of Guid`	Version
Warnings	Read	`IList of Warning`	Warnings

Methods

Body

Body Overload 1

Velocity

#set($stringResponse = $article.Body())

JavaScript

var stringResponse = article.Body();

Body Overload 2

Velocity

#set($stringResponse = $article.Body($postTarget))

JavaScript

var stringResponse = article.Body(postTarget);

Parameters

Name	Type	Description	Required	Default	Options
postTarget	`String`	Post Target	Required

Returns

String

HasErrors

Velocity

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

JavaScript

var booleanResponse = article.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = article.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = article.HasWarningsOrErrors();

Returns

Boolean

ThrowErrors

Velocity

$article.ThrowErrors()

JavaScript

article.ThrowErrors();

Returns

Nothing

Recommended