Page Script API Type

Ben Tiedt — Wed, 20 Nov 2019 15:08:46 GMT

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

Properties
AddToFeaturedContent
Clone
ContentHtml
GetCurrentRelated
RemoveFromFeaturedContent
RenderedBody
SetTitleRaw
TitleHtml

Properties

Name	Access	Type	Description
ApplicationId	Read	`Guid`	Application Id
ApplicationType	Read	`[[ApplicationType Script API Type\|ApplicationType]]`	Application Type
ApplicationTypeId	Read	`Guid`	Application Type Id
Body	Read, Write	`String`	Body
ChildPageCount	Read	`Int32`	Child Page Count
Container	Read	`[[IContentContainer Script API Type\|IContentContainer]]`	Container
ContentID	Read, Write	`Guid`	Content I D
CreatedUtcDate	Read, Write	`DateTime`	Created Utc Date
Date	Read	`DateTime`	Date
FeaturedImage	Read	`String`	Featured Image
FormattedBody	Read, Write	`String`	Formatted Body
ID	Read	`Int32`	I D
IsDefaultPage	Read	`Boolean`	Is Default Page
IsFeatured	Read	`Boolean`	Is Featured
IsHidden	Read, Write	`Boolean`	Is Hidden
IsHiddenInTOC	Read, Write	`Boolean`	Is Hidden In T O C
IsIndexed	Read, Write	`Boolean`	Is Indexed
IsLocked	Read, Write	`Boolean`	Is Locked
IsPublished	Read, Write	`Boolean`	Is Published
IsReadOnly	Read	`Boolean`	Is Read Only
LastModifiedDate	Read, Write	`DateTime`	Last Modified Date
MetaDescription	Read, Write	`String`	Meta Description
MetaKeywords	Read, Write	`String`	Meta Keywords
MetaTitle	Read, Write	`String`	Meta Title
NodeId	Read	`Guid`	Node Id
PageKey	Read, Write	`String`	Page Key
ParentPage	Read, Write	`[[Page Script API Type\|Page]]`	Parent Page
ParentPageID	Read	`Int32`	Parent Page I D
Position	Read, Write	`Nullable of Int32`	Position
RatingCount	Read, Write	`Int32`	Rating Count
RatingSum	Read, Write	`Int32`	Rating Sum
RevisionCount	Read, Write	`Int32`	Revision Count
RevisionNumber	Read, Write	`Int32`	Revision Number
Tags	Read, Write	`Array of String`	Tags
Title	Read, Write	`String`	Title
Uri	Read	`Uri`	Uri
User	Read, Write	`[[User Script API Type\|User]]`	User
UserID	Read	`Int32`	User I D
ViewCount	Read, Write	`Int32`	View Count
Wiki	Read, Write	`[[Wiki Script API Type\|Wiki]]`	Wiki
WikiID	Read	`Int32`	Wiki I D

Methods

AddToFeaturedContent

Velocity

$page.AddToFeaturedContent($featuredImage)

JavaScript

page.AddToFeaturedContent(featuredImage);

Parameters

Name	Type	Description	Required	Default	Options
featuredImage	`String`	Featured Image	Required

Returns

Nothing

Clone

Velocity

#set($objectResponse = $page.Clone())

JavaScript

var objectResponse = page.Clone();

Returns

Object

ContentHtml

Velocity

#set($stringResponse = $page.ContentHtml($target))

JavaScript

var stringResponse = page.ContentHtml(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[PostTarget Script API Type\|PostTarget]]`	Target	Required

Returns

String

GetCurrentRelated

Velocity

#set($booleanResponse = $page.GetCurrentRelated($relatedObject))

JavaScript

var booleanResponse = page.GetCurrentRelated(relatedObject);

Parameters

Name	Type	Description	Required	Default	Options
relatedObject	`[[T& Script API Type\|T&]]`	Related Object	Required

Returns

Boolean

RemoveFromFeaturedContent

Velocity

$page.RemoveFromFeaturedContent()

JavaScript

page.RemoveFromFeaturedContent();

Returns

Nothing

RenderedBody

Velocity

#set($stringResponse = $page.RenderedBody($target))

JavaScript

var stringResponse = page.RenderedBody(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[PostTarget Script API Type\|PostTarget]]`	Target	Required

Returns

String

SetTitleRaw

Velocity

$page.SetTitleRaw($newTitle)

JavaScript

page.SetTitleRaw(newTitle);

Parameters

Name	Type	Description	Required	Default	Options
newTitle	`String`	New Title	Required

Returns

Nothing

TitleHtml

Velocity

#set($stringResponse = $page.TitleHtml($target))

JavaScript

var stringResponse = page.TitleHtml(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[PostTarget Script API Type\|PostTarget]]`	Target	Required

Returns

String