Wiki Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:30:04 GMT

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

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, Write	`Guid`	A Guid uniquely identifying the application.
CommentCount	Read, Write	`Int32`	Comment Count
ContentId	Read	`Guid`	A Guid uniquely identifying the content.
Description	Read, Write	`String`	Description
Enabled	Read, Write	`Boolean`	Enabled
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
Group	Read, Write	`[[Group Script API Type\|Group]]`	Group
Id	Read, Write	`Nullable of Int32`	Id
Key	Read, Write	`String`	Key
LastModifiedDate	Read, Write	`Nullable of DateTime`	Last Modified Date
LastModifiedUtcDate	Read, Write	`Nullable of DateTime`	Last Modified Utc Date
Name	Read, Write	`String`	Name
PageCount	Read, Write	`Int32`	Page Count
Url	Read, Write	`String`	A Url to the application on the site.
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = wiki.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = wiki.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

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

JavaScript

var stringResponse = wiki.HtmlDescription(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$wiki.ThrowErrors()

JavaScript

wiki.ThrowErrors();

Returns

Nothing