Container Script API Type

Ben Tiedt — Fri, 15 Jan 2021 19:43:58 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:43:58

Properties
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlName
ThrowErrors

Properties

Name	Access	Type	Description
AvatarUrl	Read	`String`	The Url to the container’s avatar.
ContainerId	Read	`Guid`	A Guid uniquely identifying the container.
ContainerTypeId	Read	`Guid`	A Guid identifying the type of container. All container of the same type (i.e. group) will have the same value here.
Errors	Read	`IList of [[Error Script API Type\|Error]]`	Errors
IsEnabled	Read	`Boolean`	A flag representing whether the container is enabled.
ParentContainer	Read	`[[Container Script API Type\|Container]]`	Parent Container
Url	Read	`String`	A Url to the container on the site.
Warnings	Read	`IList of [[Warning Script API Type\|Warning]]`	Warnings

Methods

HasErrors

Velocity

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

JavaScript

var booleanResponse = container.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = container.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = container.HasWarningsOrErrors();

Returns

Boolean

HtmlName

This method should return the Html encoded name of the container. 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 = $container.HtmlName($target))

JavaScript

var stringResponse = container.HtmlName(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$container.ThrowErrors()

JavaScript

container.ThrowErrors();

Returns

Nothing