Application Script API Type

Ben Tiedt — Fri, 08 Mar 2024 17:23:51 GMT

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

Properties
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlDescription
HtmlName
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.
AvatarUrl	Read	`String`	This can represent a Url to an image particular to the application or application type.
Container	Read	`[[Container Script API Type\|Container]]`	The container in which the application is located.
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
IsEnabled	Read	`Boolean`	A flag representing whether the application is enabled.
Url	Read	`String`	A Url to the application on the site.
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = application.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = application.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

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

JavaScript

var stringResponse = application.HtmlDescription(target);

Parameters

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

Returns

String

HtmlName

This method should return the Html encoded name of the application. Possible values for “target” are “Web”, “Email”, or “raw”. When “raw” is specified as the target, the name should not be encoded.

Velocity

#set($stringResponse = $application.HtmlName($target))

JavaScript

var stringResponse = application.HtmlName(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$application.ThrowErrors()

JavaScript

application.ThrowErrors();

Returns

Nothing