Document Script API Type

Ben Tiedt — Wed, 20 Nov 2019 15:06:29 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 15:06:29

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

Properties
Body
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlDescription
ThrowErrors

Properties

Name	Access	Type	Description
Attachments	Read, Write	`IList of [[DocumentAttachment Script API Type\|DocumentAttachment]]`	Attachments
Author	Read, Write	`[[User Script API Type\|User]]`	Author
Category	Read, Write	`[[Category Script API Type\|Category]]`	Category
ContentId	Read, Write	`Guid`	A Guid uniquely identifying the content.
CreatedDate	Read, Write	`Nullable of DateTime`	The date the content was created.
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
Id	Read, Write	`String`	Id
KnowledgeCollectionId	Read, Write	`Nullable of Guid`	Knowledge Collection Id
LastUpdatedDate	Read, Write	`Nullable of DateTime`	Last Updated Date
Tags	Read, Write	`IList of [[tag]]`	Tags
Title	Read, Write	`String`	Title
Url	Read	`String`	A Url to the content on the site.
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

Body

Body Overload 1

Velocity

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

JavaScript

var stringResponse = document.Body();

Body Overload 2

Velocity

#set($stringResponse = $document.Body($target))

JavaScript

var stringResponse = document.Body(target);

Parameters

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

Returns

String

HasErrors

Velocity

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

JavaScript

var booleanResponse = document.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = document.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = document.HasWarningsOrErrors();

Returns

Boolean

HtmlDescription

Return the Html encoded description of the content (the body, for example). 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.

Velocity

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

JavaScript

var stringResponse = document.HtmlDescription(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$document.ThrowErrors()

JavaScript

document.ThrowErrors();

Returns

Nothing